samplify_api_client 1.0.0

data/docs/ExclusionData.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::ExclusionData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | **Array<String>** | List of all the type values | 
+**type** | **String** | Type of exclusion inclusion | 
+
+

data/docs/Feasibility.md

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

data/docs/FeasibilityApi.md

@@ -0,0 +1,61 @@
+# SamplifyAPIClient::FeasibilityApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**feasibility_show**](FeasibilityApi.md#feasibility_show) | **GET** /sample/v1/projects/{extProjectId}/feasibility | show feasibility
+
+
+# **feasibility_show**
+> Feasibility feasibility_show(ext_project_id)
+
+show feasibility
+
+### 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::FeasibilityApi.new
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+
+begin
+  #show feasibility
+  result = api_instance.feasibility_show(ext_project_id)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling FeasibilityApi->feasibility_show: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_project_id** | **String**|  | 
+
+### Return type
+
+[**Feasibility**](Feasibility.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.feasibility+json
+
+
+

data/docs/FeasibilityData.md

@@ -0,0 +1,14 @@
+# SamplifyAPIClient::FeasibilityData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cost_per_interview** | **Float** | Amount Research Now SSI will be paid for each delivered complete | [optional] 
+**currency** | **String** | Currency associated with the costPerInterview | [optional] 
+**expiry** | **String** | Time stamp of the expiry of the feasibility of the lineitem. | [optional] 
+**feasible** | **BOOLEAN** | Can the system deliver the requiredCompletes | [optional] 
+**status** | **String** | Current state of feasibility for line item | [optional] 
+**total_count** | **Integer** |  | 
+**value_counts** | [**Array<QuotaGroupFeasibility>**](QuotaGroupFeasibility.md) | Number of possible completes for each panelist attribute broken down for male and female | 
+
+

data/docs/FeasibilityResponseData.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::FeasibilityResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ext_line_item_id** | **String** | A unique identifier for your Line Item | [optional] 
+**feasibility** | [**FeasibilityData**](FeasibilityData.md) |  | [optional] 
+
+

data/docs/LineItemActionResponse.md

@@ -0,0 +1,14 @@
+# SamplifyAPIClient::LineItemActionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **String** | Timestamp of when the line item was created | [optional] 
+**ext_line_item_id** | **String** | Unique line item Id | [optional] 
+**launched_at** | **String** | Timestamp of when the line item launched on RN SSI panelists | [optional] 
+**state** | **String** | Unique line item Id | [optional] 
+**state_last_updated_at** | **String** | Timestamp of when the line item last changed its state | [optional] 
+**state_reason** | **String** | Reason for the current state of the line item | [optional] 
+**updated_at** | **String** | Timestamp of when the line item was updated | [optional] 
+
+

data/docs/LineItemData.md

@@ -0,0 +1,22 @@
+# SamplifyAPIClient::LineItemData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_iso_code** | **String** | ISO country code | 
+**days_in_field** | **Integer** | Duration of the project in days. | 
+**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 | 
+**language_iso_code** | **String** | ISO language code | 
+**length_of_interview** | **Integer** | expected duration of the survey in minutes | 
+**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 | 
+
+

data/docs/LineItemItemData.md

@@ -0,0 +1,17 @@
+# SamplifyAPIClient::LineItemItemData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_iso_code** | **String** | 2 letter ISO Country Code | 
+**created_at** | **String** | Timestamp of when the line item was created | 
+**ext_line_item_id** | **String** | A unique identifier for your Line Item | 
+**language_iso_code** | **String** | 2 letter ISO Language Code | 
+**launched_at** | [****](.md) | Timestamp of when the line item launched on RN SSI panelists | 
+**state** | **String** | The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED | 
+**state_last_updated_at** | **String** | Timestamp of when the line item last changed its state | 
+**state_reason** | **String** | Reason for the current state of the line item | 
+**title** | **String** | A Line Item title | 
+**updated_at** | **String** | Timestamp of when the line item was updated | 
+
+

data/docs/LineItemReportData.md

@@ -0,0 +1,25 @@
+# SamplifyAPIClient::LineItemReportData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actual_median_loi** | **Integer** | Calculated median length of interview from actual panelists | 
+**attempts** | **Integer** | Total number of panelists that entered the project | 
+**completes** | **Integer** | Total number of panelists that completed the project | 
+**conversion** | **Float** | Ratio of completes over attempts. (ranges from 0-1) | 
+**country_iso_code** | **String** | ISO country code | 
+**currency** | **String** | Currency ISO code | 
+**estimated_cost** | **Float** | Total estimated cost | 
+**ext_line_item_id** | **String** | A unique identifier for your Line Item | 
+**incurred_cost** | **Float** | Total incurred cost | 
+**language_iso_code** | **String** | ISO language code | 
+**last_accepted_incidence_rate** | **Float** | Last accepted incidence rate | 
+**last_accepted_loi** | **Integer** | Last accepted length of interview | 
+**overquotas** | **Integer** | Total number of panelists that triggered an overquota for the project | 
+**remaining_completes** | **Integer** | Total remaining completes for the project | 
+**screenouts** | **Integer** | Total number of panelists that got screened out of the project | 
+**state** | **String** | The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED | 
+**state_reason** | **String** | The current state reason of the project | 
+**title** | **String** | LineItem title | 
+
+

data/docs/LineItemResponseData.md

@@ -0,0 +1,27 @@
+# SamplifyAPIClient::LineItemResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_iso_code** | **String** | ISO country code | [optional] 
+**created_at** | **String** | created time. | [optional] 
+**days_in_field** | **Integer** | Duration of the project in days. | [optional] 
+**delivery_type** | **String** | Delivery type: SLOW, BALANCED, FAST or BURST. | [optional] 
+**end_links** | [**EndLinks**](EndLinks.md) |  | [optional] 
+**ext_line_item_id** | **String** | Unique line item Id | [optional] 
+**indicative_incidence** | **Float** | Expected incidence of the survey | [optional] 
+**language_iso_code** | **String** | ISO language code | [optional] 
+**launched_at** | **String** | launched time. | [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] 
+**state** | **String** | state | [optional] 
+**state_last_updated_at** | **String** | state last updated at. | [optional] 
+**state_reason** | **String** | state reason | [optional] 
+**survey_test_url** | **String** | Entry link for the user. | [optional] 
+**survey_url** | **String** | Entry link for the user. | [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] 
+**updated_at** | **String** | updated time. | [optional] 
+
+

data/docs/LineItems.md

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

data/docs/LineItemsApi.md

@@ -0,0 +1,420 @@
+# SamplifyAPIClient::LineItemsApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**line_items_close**](LineItemsApi.md#line_items_close) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/close | close lineItems
+[**line_items_create**](LineItemsApi.md#line_items_create) | **POST** /sample/v1/projects/{extProjectId}/lineItems | create lineItems
+[**line_items_get**](LineItemsApi.md#line_items_get) | **GET** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | get lineItems
+[**line_items_launch**](LineItemsApi.md#line_items_launch) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/launch | launch lineItems
+[**line_items_list_line_items**](LineItemsApi.md#line_items_list_line_items) | **GET** /sample/v1/projects/{extProjectId}/lineItems | listLineItems lineItems
+[**line_items_pause**](LineItemsApi.md#line_items_pause) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/pause | pause lineItems
+[**line_items_update**](LineItemsApi.md#line_items_update) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | update lineItems
+
+
+# **line_items_close**
+> CreateLineItem line_items_close(ext_line_item_id, ext_project_id)
+
+close lineItems
+
+### 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::LineItemsApi.new
+
+ext_line_item_id = 'ext_line_item_id_example' # String | 
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+
+begin
+  #close lineItems
+  result = api_instance.line_items_close(ext_line_item_id, ext_project_id)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_close: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_line_item_id** | **String**|  | 
+ **ext_project_id** | **String**|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+
+# **line_items_create**
+> CreateLineItem line_items_create(ext_project_id, payload)
+
+create lineItems
+
+### 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::LineItemsApi.new
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+payload = SamplifyAPIClient::LineItemData.new # LineItemData | 
+
+
+begin
+  #create lineItems
+  result = api_instance.line_items_create(ext_project_id, payload)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_project_id** | **String**|  | 
+ **payload** | [**LineItemData**](LineItemData.md)|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+
+# **line_items_get**
+> CreateLineItem line_items_get(ext_line_item_id, ext_project_id)
+
+get lineItems
+
+### 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::LineItemsApi.new
+
+ext_line_item_id = 'ext_line_item_id_example' # String | 
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+
+begin
+  #get lineItems
+  result = api_instance.line_items_get(ext_line_item_id, ext_project_id)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_line_item_id** | **String**|  | 
+ **ext_project_id** | **String**|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+
+# **line_items_launch**
+> CreateLineItem line_items_launch(ext_line_item_id, ext_project_id)
+
+launch lineItems
+
+### 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::LineItemsApi.new
+
+ext_line_item_id = 'ext_line_item_id_example' # String | 
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+
+begin
+  #launch lineItems
+  result = api_instance.line_items_launch(ext_line_item_id, ext_project_id)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_launch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_line_item_id** | **String**|  | 
+ **ext_project_id** | **String**|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+
+# **line_items_list_line_items**
+> LineItems line_items_list_line_items(ext_project_id, opts)
+
+listLineItems lineItems
+
+### 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::LineItemsApi.new
+
+ext_project_id = 'ext_project_id_example' # String | External Project ID
+
+opts = { 
+  country_iso_code: 'country_iso_code_example', # String | Only return line items with the given country ISO Code
+  ext_line_item_id: 'ext_line_item_id_example', # String | Only return line items with the given extLineItemId
+  language_iso_code: 'language_iso_code_example', # String | Only return line items with the given language ISO Code
+  limit: 10, # Integer | Maximum number of line items to return
+  offset: 0, # Integer | The first zero-based offset line item to return
+  sort: ['sort_example'], # Array<String> | Sort the line items by the given key(s)
+  state: 'state_example', # String | Only return lineitems with the given state
+  state_reason: 'state_reason_example', # String | Only return line items with the given state reason
+  title: 'title_example' # String | Only return line items with the given title
+}
+
+begin
+  #listLineItems lineItems
+  result = api_instance.line_items_list_line_items(ext_project_id, opts)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_list_line_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_project_id** | **String**| External Project ID | 
+ **country_iso_code** | **String**| Only return line items with the given country ISO Code | [optional] 
+ **ext_line_item_id** | **String**| Only return line items with the given extLineItemId | [optional] 
+ **language_iso_code** | **String**| Only return line items with the given language ISO Code | [optional] 
+ **limit** | **Integer**| Maximum number of line items to return | [optional] [default to 10]
+ **offset** | **Integer**| The first zero-based offset line item to return | [optional] [default to 0]
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the line items by the given key(s) | [optional] 
+ **state** | **String**| Only return lineitems with the given state | [optional] 
+ **state_reason** | **String**| Only return line items with the given state reason | [optional] 
+ **title** | **String**| Only return line items with the given title | [optional] 
+
+### Return type
+
+[**LineItems**](LineItems.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.lineitems+json
+
+
+
+# **line_items_pause**
+> CreateLineItem line_items_pause(ext_line_item_id, ext_project_id)
+
+pause lineItems
+
+### 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::LineItemsApi.new
+
+ext_line_item_id = 'ext_line_item_id_example' # String | 
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+
+begin
+  #pause lineItems
+  result = api_instance.line_items_pause(ext_line_item_id, ext_project_id)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_pause: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_line_item_id** | **String**|  | 
+ **ext_project_id** | **String**|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+
+# **line_items_update**
+> CreateLineItem line_items_update(ext_line_item_id, ext_project_id, payload)
+
+update lineItems
+
+### 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::LineItemsApi.new
+
+ext_line_item_id = 'ext_line_item_id_example' # String | 
+
+ext_project_id = 'ext_project_id_example' # String | 
+
+payload = SamplifyAPIClient::UpdateLineItem.new # UpdateLineItem | 
+
+
+begin
+  #update lineItems
+  result = api_instance.line_items_update(ext_line_item_id, ext_project_id, payload)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling LineItemsApi->line_items_update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ext_line_item_id** | **String**|  | 
+ **ext_project_id** | **String**|  | 
+ **payload** | [**UpdateLineItem**](UpdateLineItem.md)|  | 
+
+### Return type
+
+[**CreateLineItem**](CreateLineItem.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.createlineitem+json
+
+
+