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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: d6c3b7e414360ce172d4ab32f29767772d9a58a998fbe6789fd1a21accc509b4
|
4
|
+
data.tar.gz: 68854c4780723229b2754cb64f16ad5114b39c0934efcdba79e2e4cf232104f7
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 66b42aa9841331e9b2486af2fc3454f9bffa2da66098bbb9c5c895b4955daf83372a42ff03e1fba91e96120e8798fbec1a3d6e7659a149c21dfafcf3646995af
|
7
|
+
data.tar.gz: 2a11ab6eec9cb7afcca572d6607002876800d12400dcbb3b190c65ba4012d3b38331836c64d242da9bd3eb5ef8ba810c1fc950f3eaf2e61b871691cc5eba6a57
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
samplify_api_client (1.0.0)
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.2)
|
12
|
+
addressable (2.6.0)
|
13
|
+
public_suffix (>= 2.0.2, < 4.0)
|
14
|
+
autotest (4.4.6)
|
15
|
+
ZenTest (>= 4.4.1)
|
16
|
+
autotest-fsevent (0.2.14)
|
17
|
+
sys-uname
|
18
|
+
autotest-growl (0.2.16)
|
19
|
+
autotest-rails-pure (4.1.2)
|
20
|
+
crack (0.4.3)
|
21
|
+
safe_yaml (~> 1.0.0)
|
22
|
+
diff-lcs (1.3)
|
23
|
+
ethon (0.12.0)
|
24
|
+
ffi (>= 1.3.0)
|
25
|
+
ffi (1.10.0)
|
26
|
+
hashdiff (0.3.8)
|
27
|
+
json (2.2.0)
|
28
|
+
public_suffix (3.0.3)
|
29
|
+
rake (12.0.0)
|
30
|
+
rspec (3.8.0)
|
31
|
+
rspec-core (~> 3.8.0)
|
32
|
+
rspec-expectations (~> 3.8.0)
|
33
|
+
rspec-mocks (~> 3.8.0)
|
34
|
+
rspec-core (3.8.0)
|
35
|
+
rspec-support (~> 3.8.0)
|
36
|
+
rspec-expectations (3.8.2)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.8.0)
|
39
|
+
rspec-mocks (3.8.0)
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
+
rspec-support (~> 3.8.0)
|
42
|
+
rspec-support (3.8.0)
|
43
|
+
safe_yaml (1.0.5)
|
44
|
+
sys-uname (1.0.4)
|
45
|
+
ffi (>= 1.0.0)
|
46
|
+
typhoeus (1.3.1)
|
47
|
+
ethon (>= 0.9.0)
|
48
|
+
vcr (3.0.3)
|
49
|
+
webmock (1.24.6)
|
50
|
+
addressable (>= 2.3.6)
|
51
|
+
crack (>= 0.3.2)
|
52
|
+
hashdiff
|
53
|
+
|
54
|
+
PLATFORMS
|
55
|
+
ruby
|
56
|
+
|
57
|
+
DEPENDENCIES
|
58
|
+
autotest (~> 4.4, >= 4.4.6)
|
59
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
60
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
61
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
62
|
+
rake (~> 12.0.0)
|
63
|
+
rspec (~> 3.6, >= 3.6.0)
|
64
|
+
samplify_api_client!
|
65
|
+
vcr (~> 3.0, >= 3.0.1)
|
66
|
+
webmock (~> 1.24, >= 1.24.3)
|
67
|
+
|
68
|
+
BUNDLED WITH
|
69
|
+
1.16.1
|
data/README.md
ADDED
@@ -0,0 +1,221 @@
|
|
1
|
+
# samplify_api_client
|
2
|
+
|
3
|
+
SamplifyAPIClient - the Ruby gem for the Samplify API
|
4
|
+
|
5
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 1.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build samplify_api_client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./samplify_api_client-1.0.0.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./samplify_api_client-1.0.0.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'samplify_api_client', '~> 1.0.0'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'samplify_api_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'samplify_api_client'
|
56
|
+
|
57
|
+
# Setup authorization
|
58
|
+
SamplifyAPIClient.configure do |config|
|
59
|
+
# Configure API key authorization: jwt
|
60
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = SamplifyAPIClient::AttributesApi.new
|
66
|
+
|
67
|
+
country_iso_code = 'country_iso_code_example' # String | Country ISO code
|
68
|
+
|
69
|
+
language_iso_code = 'language_iso_code_example' # String | Language ISO code
|
70
|
+
|
71
|
+
opts = {
|
72
|
+
id: 'id_example', # String | Only return attributes with the given id
|
73
|
+
limit: 10, # Integer | Maximum number of attributes to return
|
74
|
+
name: 'name_example', # String | Only return attributes with the given name
|
75
|
+
offset: 0, # Integer | The first zero-based offset attribute to return
|
76
|
+
sort: ['sort_example'], # Array<String> | Sort the attributes by the given key(s)
|
77
|
+
text: 'text_example' # String | Only return attributes with the given text
|
78
|
+
}
|
79
|
+
|
80
|
+
begin
|
81
|
+
#list attributes
|
82
|
+
result = api_instance.attributes_list(country_iso_code, language_iso_code, opts)
|
83
|
+
p result
|
84
|
+
rescue SamplifyAPIClient::ApiError => e
|
85
|
+
puts "Exception when calling AttributesApi->attributes_list: #{e}"
|
86
|
+
end
|
87
|
+
|
88
|
+
```
|
89
|
+
|
90
|
+
## Documentation for API Endpoints
|
91
|
+
|
92
|
+
All URIs are relative to *https://api.uat.pe.researchnow.com*
|
93
|
+
|
94
|
+
Class | Method | HTTP request | Description
|
95
|
+
------------ | ------------- | ------------- | -------------
|
96
|
+
*SamplifyAPIClient::AttributesApi* | [**attributes_list**](docs/AttributesApi.md#attributes_list) | **GET** /sample/v1/attributes/{countryIsoCode}/{languageIsoCode} | list attributes
|
97
|
+
*SamplifyAPIClient::AuthApi* | [**auth_code**](docs/AuthApi.md#auth_code) | **POST** /auth/v1/token/code | code auth
|
98
|
+
*SamplifyAPIClient::AuthApi* | [**auth_logout**](docs/AuthApi.md#auth_logout) | **POST** /auth/v1/logout | logout auth
|
99
|
+
*SamplifyAPIClient::AuthApi* | [**auth_password**](docs/AuthApi.md#auth_password) | **POST** /auth/v1/token/password | password auth
|
100
|
+
*SamplifyAPIClient::AuthApi* | [**auth_refresh**](docs/AuthApi.md#auth_refresh) | **POST** /auth/v1/token/refresh | refresh auth
|
101
|
+
*SamplifyAPIClient::CategoriesApi* | [**categories_list**](docs/CategoriesApi.md#categories_list) | **GET** /sample/v1/categories/surveyTopics | list categories
|
102
|
+
*SamplifyAPIClient::CountriesApi* | [**countries_list**](docs/CountriesApi.md#countries_list) | **GET** /sample/v1/countries | list countries
|
103
|
+
*SamplifyAPIClient::DefaultApi* | [**swaggerswagger_json**](docs/DefaultApi.md#swaggerswagger_json) | **GET** /swagger.json | Download public/swagger/swagger.json
|
104
|
+
*SamplifyAPIClient::DefaultApi* | [**swaggerswagger_yaml**](docs/DefaultApi.md#swaggerswagger_yaml) | **GET** /swagger.yaml | Download public/swagger/swagger.yaml
|
105
|
+
*SamplifyAPIClient::EventsApi* | [**events_accept**](docs/EventsApi.md#events_accept) | **POST** /sample/v1/events/{eventId}/accept | accept events
|
106
|
+
*SamplifyAPIClient::EventsApi* | [**events_get**](docs/EventsApi.md#events_get) | **GET** /sample/v1/events/{eventId} | get events
|
107
|
+
*SamplifyAPIClient::EventsApi* | [**events_list**](docs/EventsApi.md#events_list) | **GET** /sample/v1/events | list events
|
108
|
+
*SamplifyAPIClient::EventsApi* | [**events_reject**](docs/EventsApi.md#events_reject) | **POST** /sample/v1/events/{eventId}/reject | reject events
|
109
|
+
*SamplifyAPIClient::EventsApi* | [**events_reprice**](docs/EventsApi.md#events_reprice) | **POST** /sample/v1/events/lineItems/reprice | reprice events
|
110
|
+
*SamplifyAPIClient::FeasibilityApi* | [**feasibility_show**](docs/FeasibilityApi.md#feasibility_show) | **GET** /sample/v1/projects/{extProjectId}/feasibility | show feasibility
|
111
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_close**](docs/LineItemsApi.md#line_items_close) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/close | close lineItems
|
112
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_create**](docs/LineItemsApi.md#line_items_create) | **POST** /sample/v1/projects/{extProjectId}/lineItems | create lineItems
|
113
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_get**](docs/LineItemsApi.md#line_items_get) | **GET** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | get lineItems
|
114
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_launch**](docs/LineItemsApi.md#line_items_launch) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/launch | launch lineItems
|
115
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_list_line_items**](docs/LineItemsApi.md#line_items_list_line_items) | **GET** /sample/v1/projects/{extProjectId}/lineItems | listLineItems lineItems
|
116
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_pause**](docs/LineItemsApi.md#line_items_pause) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/pause | pause lineItems
|
117
|
+
*SamplifyAPIClient::LineItemsApi* | [**line_items_update**](docs/LineItemsApi.md#line_items_update) | **POST** /sample/v1/projects/{extProjectId}/lineItems/{extLineItemId} | update lineItems
|
118
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_buy**](docs/ProjectsApi.md#projects_buy) | **POST** /sample/v1/projects/{extProjectId}/buy | buy projects
|
119
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_close**](docs/ProjectsApi.md#projects_close) | **POST** /sample/v1/projects/{extProjectId}/close | close projects
|
120
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_create**](docs/ProjectsApi.md#projects_create) | **POST** /sample/v1/projects | create projects
|
121
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_get**](docs/ProjectsApi.md#projects_get) | **GET** /sample/v1/projects/{extProjectId} | get projects
|
122
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_get_report**](docs/ProjectsApi.md#projects_get_report) | **GET** /sample/v1/projects/{extProjectId}/report | getReport projects
|
123
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_get_reports**](docs/ProjectsApi.md#projects_get_reports) | **GET** /sample/v1/projects/report | getReports projects
|
124
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_get_survey_end_links**](docs/ProjectsApi.md#projects_get_survey_end_links) | **GET** /sample/v1/projects/{extProjectId}/surveys/{surveyId}/links | getSurveyEndLinks projects
|
125
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_invoices**](docs/ProjectsApi.md#projects_invoices) | **GET** /sample/v1/projects/{extProjectId}/invoices | invoices projects
|
126
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /sample/v1/projects | list projects
|
127
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_reconcile**](docs/ProjectsApi.md#projects_reconcile) | **POST** /sample/v1/projects/{extProjectId}/reconcile | reconcile projects
|
128
|
+
*SamplifyAPIClient::ProjectsApi* | [**projects_update**](docs/ProjectsApi.md#projects_update) | **POST** /sample/v1/projects/{extProjectId} | update projects
|
129
|
+
*SamplifyAPIClient::RespondentApi* | [**respondent_entry**](docs/RespondentApi.md#respondent_entry) | **GET** /respondent/entry | entry respondent
|
130
|
+
*SamplifyAPIClient::RespondentApi* | [**respondent_exit**](docs/RespondentApi.md#respondent_exit) | **GET** /respondent/exit | exit respondent
|
131
|
+
*SamplifyAPIClient::UsersApi* | [**users_get_user_info**](docs/UsersApi.md#users_get_user_info) | **GET** /sample/v1/users/info | getUserInfo users
|
132
|
+
|
133
|
+
|
134
|
+
## Documentation for Models
|
135
|
+
|
136
|
+
- [SamplifyAPIClient::AppError](docs/AppError.md)
|
137
|
+
- [SamplifyAPIClient::ApplicationItemData](docs/ApplicationItemData.md)
|
138
|
+
- [SamplifyAPIClient::AttributeData](docs/AttributeData.md)
|
139
|
+
- [SamplifyAPIClient::AttributeOption](docs/AttributeOption.md)
|
140
|
+
- [SamplifyAPIClient::Attributes](docs/Attributes.md)
|
141
|
+
- [SamplifyAPIClient::AuthError](docs/AuthError.md)
|
142
|
+
- [SamplifyAPIClient::Author](docs/Author.md)
|
143
|
+
- [SamplifyAPIClient::BuyProject](docs/BuyProject.md)
|
144
|
+
- [SamplifyAPIClient::BuyProjectItem](docs/BuyProjectItem.md)
|
145
|
+
- [SamplifyAPIClient::BuyProjectResponse](docs/BuyProjectResponse.md)
|
146
|
+
- [SamplifyAPIClient::BuyProjectsPayload](docs/BuyProjectsPayload.md)
|
147
|
+
- [SamplifyAPIClient::Categories](docs/Categories.md)
|
148
|
+
- [SamplifyAPIClient::CategoryData](docs/CategoryData.md)
|
149
|
+
- [SamplifyAPIClient::CodePayload](docs/CodePayload.md)
|
150
|
+
- [SamplifyAPIClient::Countries](docs/Countries.md)
|
151
|
+
- [SamplifyAPIClient::CountryData](docs/CountryData.md)
|
152
|
+
- [SamplifyAPIClient::CreateLineItem](docs/CreateLineItem.md)
|
153
|
+
- [SamplifyAPIClient::EndLinks](docs/EndLinks.md)
|
154
|
+
- [SamplifyAPIClient::ErrorType](docs/ErrorType.md)
|
155
|
+
- [SamplifyAPIClient::Event](docs/Event.md)
|
156
|
+
- [SamplifyAPIClient::EventData](docs/EventData.md)
|
157
|
+
- [SamplifyAPIClient::EventListData](docs/EventListData.md)
|
158
|
+
- [SamplifyAPIClient::Events](docs/Events.md)
|
159
|
+
- [SamplifyAPIClient::ExclusionData](docs/ExclusionData.md)
|
160
|
+
- [SamplifyAPIClient::Feasibility](docs/Feasibility.md)
|
161
|
+
- [SamplifyAPIClient::FeasibilityData](docs/FeasibilityData.md)
|
162
|
+
- [SamplifyAPIClient::FeasibilityResponseData](docs/FeasibilityResponseData.md)
|
163
|
+
- [SamplifyAPIClient::LineItemActionResponse](docs/LineItemActionResponse.md)
|
164
|
+
- [SamplifyAPIClient::LineItemData](docs/LineItemData.md)
|
165
|
+
- [SamplifyAPIClient::LineItemItemData](docs/LineItemItemData.md)
|
166
|
+
- [SamplifyAPIClient::LineItemReportData](docs/LineItemReportData.md)
|
167
|
+
- [SamplifyAPIClient::LineItemResponseData](docs/LineItemResponseData.md)
|
168
|
+
- [SamplifyAPIClient::LineItems](docs/LineItems.md)
|
169
|
+
- [SamplifyAPIClient::Links](docs/Links.md)
|
170
|
+
- [SamplifyAPIClient::LogoutPayload](docs/LogoutPayload.md)
|
171
|
+
- [SamplifyAPIClient::Meta](docs/Meta.md)
|
172
|
+
- [SamplifyAPIClient::Project](docs/Project.md)
|
173
|
+
- [SamplifyAPIClient::ProjectAction](docs/ProjectAction.md)
|
174
|
+
- [SamplifyAPIClient::ProjectActionResponse](docs/ProjectActionResponse.md)
|
175
|
+
- [SamplifyAPIClient::ProjectCategoryData](docs/ProjectCategoryData.md)
|
176
|
+
- [SamplifyAPIClient::ProjectItemData](docs/ProjectItemData.md)
|
177
|
+
- [SamplifyAPIClient::ProjectReport](docs/ProjectReport.md)
|
178
|
+
- [SamplifyAPIClient::ProjectReportData](docs/ProjectReportData.md)
|
179
|
+
- [SamplifyAPIClient::ProjectReports](docs/ProjectReports.md)
|
180
|
+
- [SamplifyAPIClient::ProjectResponse](docs/ProjectResponse.md)
|
181
|
+
- [SamplifyAPIClient::ProjectResponseData](docs/ProjectResponseData.md)
|
182
|
+
- [SamplifyAPIClient::ProjectSurveyEndLinks](docs/ProjectSurveyEndLinks.md)
|
183
|
+
- [SamplifyAPIClient::ProjectSurveyEndLinksData](docs/ProjectSurveyEndLinksData.md)
|
184
|
+
- [SamplifyAPIClient::Projects](docs/Projects.md)
|
185
|
+
- [SamplifyAPIClient::QuotaCell](docs/QuotaCell.md)
|
186
|
+
- [SamplifyAPIClient::QuotaCellFeasibility](docs/QuotaCellFeasibility.md)
|
187
|
+
- [SamplifyAPIClient::QuotaGroupData](docs/QuotaGroupData.md)
|
188
|
+
- [SamplifyAPIClient::QuotaGroupFeasibility](docs/QuotaGroupFeasibility.md)
|
189
|
+
- [SamplifyAPIClient::QuotaPlanData](docs/QuotaPlanData.md)
|
190
|
+
- [SamplifyAPIClient::Reconcile](docs/Reconcile.md)
|
191
|
+
- [SamplifyAPIClient::ReconcileData](docs/ReconcileData.md)
|
192
|
+
- [SamplifyAPIClient::RefreshTokenPayload](docs/RefreshTokenPayload.md)
|
193
|
+
- [SamplifyAPIClient::Reprice](docs/Reprice.md)
|
194
|
+
- [SamplifyAPIClient::RepriceData](docs/RepriceData.md)
|
195
|
+
- [SamplifyAPIClient::RepricePayload](docs/RepricePayload.md)
|
196
|
+
- [SamplifyAPIClient::Status](docs/Status.md)
|
197
|
+
- [SamplifyAPIClient::SupportedLanguage](docs/SupportedLanguage.md)
|
198
|
+
- [SamplifyAPIClient::SurveyEndLinks](docs/SurveyEndLinks.md)
|
199
|
+
- [SamplifyAPIClient::SurveyTestId](docs/SurveyTestId.md)
|
200
|
+
- [SamplifyAPIClient::SurveyTestLink](docs/SurveyTestLink.md)
|
201
|
+
- [SamplifyAPIClient::Target](docs/Target.md)
|
202
|
+
- [SamplifyAPIClient::TargetingAttribute](docs/TargetingAttribute.md)
|
203
|
+
- [SamplifyAPIClient::TokenMedia](docs/TokenMedia.md)
|
204
|
+
- [SamplifyAPIClient::TokenPayload](docs/TokenPayload.md)
|
205
|
+
- [SamplifyAPIClient::URLParam](docs/URLParam.md)
|
206
|
+
- [SamplifyAPIClient::UpdateLineItem](docs/UpdateLineItem.md)
|
207
|
+
- [SamplifyAPIClient::UpdateProjectData](docs/UpdateProjectData.md)
|
208
|
+
- [SamplifyAPIClient::UpdateProjectLineItem](docs/UpdateProjectLineItem.md)
|
209
|
+
- [SamplifyAPIClient::UserInfo](docs/UserInfo.md)
|
210
|
+
- [SamplifyAPIClient::UserInfoResponseData](docs/UserInfoResponseData.md)
|
211
|
+
|
212
|
+
|
213
|
+
## Documentation for Authorization
|
214
|
+
|
215
|
+
|
216
|
+
### jwt
|
217
|
+
|
218
|
+
- **Type**: API key
|
219
|
+
- **API key parameter name**: Authorization
|
220
|
+
- **Location**: HTTP header
|
221
|
+
|
data/Rakefile
ADDED
data/docs/AppError.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::AppError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [****](.md) | Data |
|
7
|
+
**meta** | [**Meta**](Meta.md) | |
|
8
|
+
**status** | [**Status**](Status.md) | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SamplifyAPIClient::ApplicationItemData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**app_id** | **Integer** | A unique identifier for your application |
|
7
|
+
**current** | **BOOLEAN** | Is this the current application for the user |
|
8
|
+
**default** | **BOOLEAN** | Is this the default application for the user |
|
9
|
+
**name** | **String** | Application name |
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# SamplifyAPIClient::AttributeData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**format** | **String** | Regex for validation | [optional]
|
7
|
+
**id** | **String** | Unique attribute ID |
|
8
|
+
**is_allowed_in_filters** | **BOOLEAN** | Is allowed in filters |
|
9
|
+
**is_allowed_in_quotas** | **BOOLEAN** | Is allowed in quotas |
|
10
|
+
**localized_text** | **String** | Localized attribute text |
|
11
|
+
**name** | **String** | Attribute name |
|
12
|
+
**options** | [**Array<AttributeOption>**](AttributeOption.md) | | [optional]
|
13
|
+
**text** | **String** | Attribute text |
|
14
|
+
**type** | **String** | Attribute type |
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::AttributeOption
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Unique Option ID (within an attribute) |
|
7
|
+
**localized_text** | **String** | Localized option text |
|
8
|
+
**text** | **String** | Option text |
|
9
|
+
|
10
|
+
|
data/docs/Attributes.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SamplifyAPIClient::Attributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**Array<AttributeData>**](AttributeData.md) | |
|
7
|
+
**meta** | [**Meta**](Meta.md) | |
|
8
|
+
**status** | [**Status**](Status.md) | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# SamplifyAPIClient::AttributesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.uat.pe.researchnow.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**attributes_list**](AttributesApi.md#attributes_list) | **GET** /sample/v1/attributes/{countryIsoCode}/{languageIsoCode} | list attributes
|
8
|
+
|
9
|
+
|
10
|
+
# **attributes_list**
|
11
|
+
> Attributes attributes_list(country_iso_code, language_iso_code, opts)
|
12
|
+
|
13
|
+
list attributes
|
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::AttributesApi.new
|
28
|
+
|
29
|
+
country_iso_code = 'country_iso_code_example' # String | Country ISO code
|
30
|
+
|
31
|
+
language_iso_code = 'language_iso_code_example' # String | Language ISO code
|
32
|
+
|
33
|
+
opts = {
|
34
|
+
id: 'id_example', # String | Only return attributes with the given id
|
35
|
+
limit: 10, # Integer | Maximum number of attributes to return
|
36
|
+
name: 'name_example', # String | Only return attributes with the given name
|
37
|
+
offset: 0, # Integer | The first zero-based offset attribute to return
|
38
|
+
sort: ['sort_example'], # Array<String> | Sort the attributes by the given key(s)
|
39
|
+
text: 'text_example' # String | Only return attributes with the given text
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#list attributes
|
44
|
+
result = api_instance.attributes_list(country_iso_code, language_iso_code, opts)
|
45
|
+
p result
|
46
|
+
rescue SamplifyAPIClient::ApiError => e
|
47
|
+
puts "Exception when calling AttributesApi->attributes_list: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**country_iso_code** | **String**| Country ISO code |
|
56
|
+
**language_iso_code** | **String**| Language ISO code |
|
57
|
+
**id** | **String**| Only return attributes with the given id | [optional]
|
58
|
+
**limit** | **Integer**| Maximum number of attributes to return | [optional] [default to 10]
|
59
|
+
**name** | **String**| Only return attributes with the given name | [optional]
|
60
|
+
**offset** | **Integer**| The first zero-based offset attribute to return | [optional] [default to 0]
|
61
|
+
**sort** | [**Array<String>**](String.md)| Sort the attributes by the given key(s) | [optional]
|
62
|
+
**text** | **String**| Only return attributes with the given text | [optional]
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
[**Attributes**](Attributes.md)
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
[jwt](../README.md#jwt)
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: application/json, application/xml, application/gob, application/x-gob
|
75
|
+
- **Accept**: application/vnd.attributes+json
|
76
|
+
|
77
|
+
|
78
|
+
|