samplify_api_client 1.0.0

data/docs/QuotaCell.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::QuotaCell
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | number of the total completes for this cell | [optional] 
+**perc** | **Float** | percentage of the total completes for this cell | [optional] 
+**quota_nodes** | [**Array<TargetingAttribute>**](TargetingAttribute.md) | nodes in the cell. | [optional] 
+
+

data/docs/QuotaCellFeasibility.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::QuotaCellFeasibility
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feasibility_count** | **Integer** |  | 
+**quota_nodes** | [**Array<TargetingAttribute>**](TargetingAttribute.md) |  | 
+
+

data/docs/QuotaGroupData.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::QuotaGroupData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | name or desciption of the quota group. | [optional] 
+**quota_cells** | [**Array<QuotaCell>**](QuotaCell.md) | List of quotas | 
+
+

data/docs/QuotaGroupFeasibility.md

@@ -0,0 +1,8 @@
+# SamplifyAPIClient::QuotaGroupFeasibility
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quota_cells** | [**Array<QuotaCellFeasibility>**](QuotaCellFeasibility.md) |  | [optional] 
+
+

data/docs/QuotaPlanData.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::QuotaPlanData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filters** | [**Array<TargetingAttribute>**](TargetingAttribute.md) | Filters are attributes which all panelists should have before qualifying for a survey | [optional] 
+**quota_groups** | [**Array<QuotaGroupData>**](QuotaGroupData.md) | Quota groups define the allocated targeting attributes for panelists within this line item | [optional] 
+
+

data/docs/Reconcile.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::Reconcile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ReconcileData**](ReconcileData.md) |  | 
+**meta** | [**Meta**](Meta.md) |  | 
+**status** | [**Status**](Status.md) |  | 
+
+

data/docs/ReconcileData.md

@@ -0,0 +1,7 @@
+# SamplifyAPIClient::ReconcileData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RefreshTokenPayload.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::RefreshTokenPayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | Client ID | 
+**client_secret** | **String** | Client Secret | [optional] 
+**refresh_token** | **String** | Refresh token | 
+
+

data/docs/Reprice.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::Reprice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**RepriceData**](RepriceData.md) |  | 
+**meta** | [**Meta**](Meta.md) |  | 
+**status** | [**Status**](Status.md) |  | 
+
+

data/docs/RepriceData.md

@@ -0,0 +1,22 @@
+# SamplifyAPIClient::RepriceData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ir** | **Float** | Incident Rate | 
+**loi** | **Float** | Length of Interview | 
+**approval_id** | **String** | Approval ID | 
+**calculated_max_price** | **Float** | Calculated Maximum Price | 
+**completes** | **Integer** | Completes | 
+**event_id** | **Integer** | Event ID | 
+**id** | **Integer** | ID | 
+**new_estimated_cost** | **Float** | New Estimated Cost | 
+**original_cpi** | **Float** | Original Cost Per Incident | 
+**original_estimated_cost** | **Float** | Original Estimated Cost | 
+**project_id** | **Integer** | Project ID | 
+**quota_group_id** | **Integer** | Quota Group ID | 
+**reason** | **String** | Reason for event: UNKNOWN, LOI_CHANGE, IR_CHANGE | 
+**request_new_price** | **Float** | Request New Price | 
+**required_completes** | **Integer** | Required Completes | 
+
+

data/docs/RepricePayload.md

@@ -0,0 +1,20 @@
+# SamplifyAPIClient::RepricePayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ir** | **Float** | Incident Rate | 
+**loi** | **Integer** | Length of Interview | 
+**approval_id** | **String** | Approval ID | 
+**calculated_max_price** | **Float** | Calculated Maximum Price | 
+**completes** | **Integer** | Completes | 
+**new_estimated_cost** | **Float** | New Estimated Cost | 
+**original_cpi** | **Float** | Original Cost Per Incident | 
+**original_estimated_cost** | **Float** | Original Estimated Cost | 
+**project_id** | **Integer** | Project ID | 
+**quota_group_id** | **Integer** | Quota Group ID | 
+**reason** | **String** | Reason for event: UNKNOWN, LOI_CHANGE, IR_CHANGE | 
+**request_new_price** | **Float** | Request New Price | 
+**required_completes** | **Integer** | Required Completes | 
+
+

data/docs/RespondentApi.md

@@ -0,0 +1,86 @@
+# SamplifyAPIClient::RespondentApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**respondent_entry**](RespondentApi.md#respondent_entry) | **GET** /respondent/entry | entry respondent
+[**respondent_exit**](RespondentApi.md#respondent_exit) | **GET** /respondent/exit | exit respondent
+
+
+# **respondent_entry**
+> respondent_entry
+
+entry respondent
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::RespondentApi.new
+
+begin
+  #entry respondent
+  api_instance.respondent_entry
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling RespondentApi->respondent_entry: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: text/html, text/plain
+
+
+
+# **respondent_exit**
+> respondent_exit
+
+exit respondent
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::RespondentApi.new
+
+begin
+  #exit respondent
+  api_instance.respondent_exit
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling RespondentApi->respondent_exit: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: text/html, text/plain
+
+
+

data/docs/Status.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::Status
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorType>**](ErrorType.md) | Populated if there are multiple errors | 
+**message** | **String** | Human readable explanation specific to this problem | 
+
+

data/docs/SupportedLanguage.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::SupportedLanguage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique language ID | 
+**iso_code** | **String** | ISO language code | 
+**language_name** | **String** | Language name | 
+
+

data/docs/SurveyEndLinks.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::SurveyEndLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**complete** | [**SurveyTestLink**](SurveyTestLink.md) |  | 
+**overquota** | [**SurveyTestLink**](SurveyTestLink.md) |  | 
+**screenout** | [**SurveyTestLink**](SurveyTestLink.md) |  | 
+
+

data/docs/SurveyTestId.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::SurveyTestId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pid** | **Integer** | pid value | 
+**test_successful** | **BOOLEAN** | Test successful indicator | 
+**tested_at** | **String** | Timestamp of test | 
+
+

data/docs/SurveyTestLink.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::SurveyTestLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link** | **String** | URL | 
+**tested_ids** | [**Array<SurveyTestId>**](SurveyTestId.md) | List of tested Ids | 
+
+

data/docs/Target.md

@@ -0,0 +1,11 @@
+# SamplifyAPIClient::Target
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | requiredCompletes for COMPLETE target type. | 
+**daily_limit** | **Integer** | target value for dailyLimit | [optional] 
+**soft_launch** | **Integer** | target value for softLaunch | [optional] 
+**type** | **String** | target type can be starts/completes. | 
+
+

data/docs/TargetingAttribute.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::TargetingAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_id** | **String** | Id of the attribute | 
+**operator** | **String** | option to exclude or include the options for the particular feature id | [optional] 
+**options** | **Array<String>** | Options for the attribute | 
+
+

data/docs/TokenMedia.md

@@ -0,0 +1,11 @@
+# SamplifyAPIClient::TokenMedia
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** | Access token | 
+**expires_in** | **Integer** | Access token expires in seconds | 
+**refresh_expires_in** | **Integer** | Refresh token expires in seconds | 
+**refresh_token** | **String** | Refresh token | 
+
+

data/docs/TokenPayload.md

@@ -0,0 +1,11 @@
+# SamplifyAPIClient::TokenPayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | Client ID | 
+**client_secret** | **String** | Client Secret | [optional] 
+**password** | **String** | User password | 
+**username** | **String** | User username | 
+
+

data/docs/URLParam.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::URLParam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | key of the URL | 
+**value** | **String** | value for the URL key | 
+
+

data/docs/UpdateLineItem.md

@@ -0,0 +1,21 @@
+# SamplifyAPIClient::UpdateLineItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_iso_code** | **String** | ISO country code | [optional] 
+**days_in_field** | **Integer** | Duration of the project in days. | [optional] 
+**delivery_type** | **String** | Delivery type: SLOW, BALANCED, FAST, or BURST. | [optional] 
+**indicative_incidence** | **Float** | Expected incidence of the survey | [optional] 
+**language_iso_code** | **String** | ISO language code | [optional] 
+**length_of_interview** | **Integer** | expected duration of the survey in minutes | [optional] 
+**quota_plan** | [**QuotaPlanData**](QuotaPlanData.md) |  | [optional] 
+**required_completes** | **Integer** | Number of complete required for the line item | [optional] 
+**survey_test_url** | **String** | Entry link for the user. | [optional] 
+**survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional] 
+**survey_url** | **String** | Entry link for the user. | [optional] 
+**survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional] 
+**targets** | [**Array<Target>**](Target.md) | Data of completes/starts required for the line item | [optional] 
+**title** | **String** | A title for the line item | [optional] 
+
+

data/docs/UpdateProjectData.md

@@ -0,0 +1,13 @@
+# SamplifyAPIClient::UpdateProjectData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**ProjectCategoryData**](ProjectCategoryData.md) |  | [optional] 
+**devices** | **Array<String>** | List of emails to subscribe to notifications | [optional] 
+**exclusions** | [**ExclusionData**](ExclusionData.md) |  | [optional] 
+**line_items** | [**Array<UpdateProjectLineItem>**](UpdateProjectLineItem.md) | List of line items for the project. | [optional] 
+**notification_emails** | **Array<String>** | List of emails to subscribe to notifications | [optional] 
+**title** | **String** | Project title | [optional] 
+
+

data/docs/UpdateProjectLineItem.md

@@ -0,0 +1,22 @@
+# SamplifyAPIClient::UpdateProjectLineItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_iso_code** | **String** | ISO country code | [optional] 
+**days_in_field** | **Integer** | Duration of the project in days. | [optional] 
+**delivery_type** | **String** | Delivery type: SLOW, BALANCED, FAST or BURST. | [optional] 
+**ext_line_item_id** | **String** | Unique line item Id | 
+**indicative_incidence** | **Float** | Expected incidence of the survey | [optional] 
+**language_iso_code** | **String** | ISO language code | [optional] 
+**length_of_interview** | **Integer** | expected duration of the survey in minutes | [optional] 
+**quota_plan** | [**QuotaPlanData**](QuotaPlanData.md) |  | [optional] 
+**required_completes** | **Integer** | Number of complete required for the line item | [optional] 
+**survey_test_url** | **String** | Entry link for the user. | [optional] 
+**survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional] 
+**survey_url** | **String** | Entry link for the user. | [optional] 
+**survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional] 
+**targets** | [**Array<Target>**](Target.md) | Data of completes/starts required for the line item | [optional] 
+**title** | **String** | A title for the line item | [optional] 
+
+

data/docs/UserInfo.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::UserInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**UserInfoResponseData**](UserInfoResponseData.md) |  | 
+**meta** | [**Meta**](Meta.md) |  | 
+**status** | [**Status**](Status.md) |  | 
+
+

data/docs/UserInfoResponseData.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::UserInfoResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applications** | [**Array<ApplicationItemData>**](ApplicationItemData.md) | List of applications for the user. | 
+**company_id** | **Integer** | Unique company ID | 
+**company_name** | **String** | Comopany name | 
+
+

data/docs/UsersApi.md

@@ -0,0 +1,68 @@
+# SamplifyAPIClient::UsersApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**users_get_user_info**](UsersApi.md#users_get_user_info) | **GET** /sample/v1/users/info | getUserInfo users
+
+
+# **users_get_user_info**
+> UserInfo users_get_user_info(opts)
+
+getUserInfo users
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+# setup authorization
+SamplifyAPIClient.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SamplifyAPIClient::UsersApi.new
+
+opts = { 
+  app_id: 56, # Integer | Only return apps with the given id
+  current: true, # BOOLEAN | Only return current app for the user id
+  default: true, # BOOLEAN | Only return default app for the user id
+  name: 'name_example' # String | Only return apps with the given name
+}
+
+begin
+  #getUserInfo users
+  result = api_instance.users_get_user_info(opts)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling UsersApi->users_get_user_info: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| Only return apps with the given id | [optional] 
+ **current** | **BOOLEAN**| Only return current app for the user id | [optional] 
+ **default** | **BOOLEAN**| Only return default app for the user id | [optional] 
+ **name** | **String**| Only return apps with the given name | [optional] 
+
+### Return type
+
+[**UserInfo**](UserInfo.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.userinfo+json
+
+
+