samplify_api_client 1.0.0

data/docs/AuthApi.md

@@ -0,0 +1,191 @@
+# SamplifyAPIClient::AuthApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**auth_code**](AuthApi.md#auth_code) | **POST** /auth/v1/token/code | code auth
+[**auth_logout**](AuthApi.md#auth_logout) | **POST** /auth/v1/logout | logout auth
+[**auth_password**](AuthApi.md#auth_password) | **POST** /auth/v1/token/password | password auth
+[**auth_refresh**](AuthApi.md#auth_refresh) | **POST** /auth/v1/token/refresh | refresh auth
+
+
+# **auth_code**
+> TokenMedia auth_code(payload)
+
+code auth
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::AuthApi.new
+
+payload = SamplifyAPIClient::CodePayload.new # CodePayload | 
+
+
+begin
+  #code auth
+  result = api_instance.auth_code(payload)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling AuthApi->auth_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payload** | [**CodePayload**](CodePayload.md)|  | 
+
+### Return type
+
+[**TokenMedia**](TokenMedia.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
+
+
+
+# **auth_logout**
+> auth_logout(payload)
+
+logout auth
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::AuthApi.new
+
+payload = SamplifyAPIClient::LogoutPayload.new # LogoutPayload | 
+
+
+begin
+  #logout auth
+  api_instance.auth_logout(payload)
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling AuthApi->auth_logout: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payload** | [**LogoutPayload**](LogoutPayload.md)|  | 
+
+### 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**: application/vnd.auth.error+json
+
+
+
+# **auth_password**
+> TokenMedia auth_password(payload)
+
+password auth
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::AuthApi.new
+
+payload = SamplifyAPIClient::TokenPayload.new # TokenPayload | 
+
+
+begin
+  #password auth
+  result = api_instance.auth_password(payload)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling AuthApi->auth_password: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payload** | [**TokenPayload**](TokenPayload.md)|  | 
+
+### Return type
+
+[**TokenMedia**](TokenMedia.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
+
+
+
+# **auth_refresh**
+> TokenMedia auth_refresh(payload)
+
+refresh auth
+
+### Example
+```ruby
+# load the gem
+require 'samplify_api_client'
+
+api_instance = SamplifyAPIClient::AuthApi.new
+
+payload = SamplifyAPIClient::RefreshTokenPayload.new # RefreshTokenPayload | 
+
+
+begin
+  #refresh auth
+  result = api_instance.auth_refresh(payload)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling AuthApi->auth_refresh: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payload** | [**RefreshTokenPayload**](RefreshTokenPayload.md)|  | 
+
+### Return type
+
+[**TokenMedia**](TokenMedia.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.auth.error+json, application/vnd.token+json
+
+
+

data/docs/AuthError.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::AuthError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | Error code | 
+**error_description** | **String** | Error description | 
+
+

data/docs/Author.md

@@ -0,0 +1,10 @@
+# SamplifyAPIClient::Author
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of author | 
+**type** | **String** | User type descriptor | 
+**username** | **String** | Username of author | 
+
+

data/docs/BuyProject.md

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

data/docs/BuyProjectItem.md

@@ -0,0 +1,12 @@
+# SamplifyAPIClient::BuyProjectItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ext_line_item_id** | **String** | A unique identifier for your Line Item | 
+**survey_test_url** | **String** | Survey Test URL. Required for survey verification | 
+**survey_test_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyTestURL Params of the line item. | [optional] 
+**survey_url** | **String** | Survey URL to send panelist into | 
+**survey_url_params** | [**Array<URLParam>**](URLParam.md) | SurveyURL Params of the line item. | [optional] 
+
+

data/docs/BuyProjectResponse.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::BuyProjectResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ext_line_item_id** | **String** | A unique identifier for your Line Item | [optional] 
+**state** | **String** | The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED | [optional] 
+
+

data/docs/BuyProjectsPayload.md

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

data/docs/Categories.md

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

data/docs/CategoriesApi.md

@@ -0,0 +1,72 @@
+# SamplifyAPIClient::CategoriesApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**categories_list**](CategoriesApi.md#categories_list) | **GET** /sample/v1/categories/surveyTopics | list categories
+
+
+# **categories_list**
+> Categories categories_list(opts)
+
+list categories
+
+### 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::CategoriesApi.new
+
+opts = { 
+  description: 'description_example', # String | Only return categories with the given description
+  id: 'id_example', # String | Only return categories with the given id
+  limit: 10, # Integer | Maximum number of categories to return
+  name: 'name_example', # String | Only return categories with the given name
+  offset: 0, # Integer | The first zero-based offset category to return
+  sort: ['sort_example'] # Array<String> | Sort the categories by the given key(s)
+}
+
+begin
+  #list categories
+  result = api_instance.categories_list(opts)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling CategoriesApi->categories_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **description** | **String**| Only return categories with the given description | [optional] 
+ **id** | **String**| Only return categories with the given id | [optional] 
+ **limit** | **Integer**| Maximum number of categories to return | [optional] [default to 10]
+ **name** | **String**| Only return categories with the given name | [optional] 
+ **offset** | **Integer**| The first zero-based offset category to return | [optional] [default to 0]
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the categories by the given key(s) | [optional] 
+
+### Return type
+
+[**Categories**](Categories.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.categories+json
+
+
+

data/docs/CategoryData.md

@@ -0,0 +1,9 @@
+# SamplifyAPIClient::CategoryData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Category Description | 
+**topic** | **String** | Category Enum | 
+
+

data/docs/CodePayload.md

@@ -0,0 +1,11 @@
+# SamplifyAPIClient::CodePayload
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | Client ID | 
+**client_secret** | **String** | Client Secret | [optional] 
+**code** | **String** | Authorization Code | 
+**redirect_uri** | **String** | Redirect URI | 
+
+

data/docs/Countries.md

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

data/docs/CountriesApi.md

@@ -0,0 +1,72 @@
+# SamplifyAPIClient::CountriesApi
+
+All URIs are relative to *https://api.uat.pe.researchnow.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**countries_list**](CountriesApi.md#countries_list) | **GET** /sample/v1/countries | list countries
+
+
+# **countries_list**
+> Countries countries_list(opts)
+
+list countries
+
+### 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::CountriesApi.new
+
+opts = { 
+  country_name: 'country_name_example', # String | Only return countries with the given name
+  id: 'id_example', # String | Only return countries with the given id
+  iso_code: 'iso_code_example', # String | Only return countries with the given ISO code
+  limit: 10, # Integer | Maximum number of countries to return
+  offset: 0, # Integer | The first zero-based offset country to return
+  sort: ['sort_example'] # Array<String> | Sort the countries by the given key(s)
+}
+
+begin
+  #list countries
+  result = api_instance.countries_list(opts)
+  p result
+rescue SamplifyAPIClient::ApiError => e
+  puts "Exception when calling CountriesApi->countries_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country_name** | **String**| Only return countries with the given name | [optional] 
+ **id** | **String**| Only return countries with the given id | [optional] 
+ **iso_code** | **String**| Only return countries with the given ISO code | [optional] 
+ **limit** | **Integer**| Maximum number of countries to return | [optional] [default to 10]
+ **offset** | **Integer**| The first zero-based offset country to return | [optional] [default to 0]
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the countries by the given key(s) | [optional] 
+
+### Return type
+
+[**Countries**](Countries.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/xml, application/gob, application/x-gob
+ - **Accept**: application/vnd.countries+json
+
+
+