polar_accesslink 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +9 -5
- data/README.md +20 -65
- data/Rakefile +0 -2
- data/docs/DailyActivityApi.md +96 -123
- data/docs/ExercisesApi.md +35 -55
- data/docs/NightlyRechargeApi.md +96 -0
- data/docs/PhysicalInfoApi.md +60 -79
- data/docs/PullNotificationsApi.md +11 -20
- data/docs/SleepApi.md +137 -0
- data/docs/TrainingDataApi.md +175 -213
- data/docs/UsersApi.md +33 -56
- data/docs/WebhooksApi.md +43 -80
- data/git_push.sh +55 -0
- data/lib/polar_accesslink.rb +5 -36
- data/lib/polar_accesslink/api/daily_activity_api.rb +101 -201
- data/lib/polar_accesslink/api/exercises_api.rb +43 -81
- data/lib/polar_accesslink/api/nightly_recharge_api.rb +115 -0
- data/lib/polar_accesslink/api/physical_info_api.rb +65 -114
- data/lib/polar_accesslink/api/pull_notifications_api.rb +15 -27
- data/lib/polar_accesslink/api/sleep_api.rb +158 -0
- data/lib/polar_accesslink/api/training_data_api.rb +178 -332
- data/lib/polar_accesslink/api/users_api.rb +42 -96
- data/lib/polar_accesslink/api/webhooks_api.rb +59 -126
- data/lib/polar_accesslink/api_client.rb +45 -41
- data/lib/polar_accesslink/api_error.rb +3 -22
- data/lib/polar_accesslink/configuration.rb +9 -62
- data/lib/polar_accesslink/version.rb +3 -3
- data/polar_accesslink.gemspec +2 -1
- data/spec/api/daily_activity_api_spec.rb +11 -11
- data/spec/api/exercises_api_spec.rb +9 -9
- data/spec/api/nightly_recharge_api_spec.rb +58 -0
- data/spec/api/physical_info_api_spec.rb +9 -9
- data/spec/api/pull_notifications_api_spec.rb +7 -7
- data/spec/api/sleep_api_spec.rb +69 -0
- data/spec/api/training_data_api_spec.rb +16 -15
- data/spec/api/users_api_spec.rb +8 -9
- data/spec/api/webhooks_api_spec.rb +11 -13
- data/spec/api_client_spec.rb +21 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/spec_helper.rb +3 -3
- metadata +36 -145
- data/docs/Activity.md +0 -33
- data/docs/ActivityLog.md +0 -17
- data/docs/ActivityStepSample.md +0 -19
- data/docs/ActivityStepSamples.md +0 -19
- data/docs/ActivityZoneSample.md +0 -19
- data/docs/ActivityZoneSamples.md +0 -19
- data/docs/AvailableUserData.md +0 -21
- data/docs/AvailableUserDatas.md +0 -17
- data/docs/CreatedWebhook.md +0 -17
- data/docs/CreatedWebhookData.md +0 -23
- data/docs/DurationZone.md +0 -19
- data/docs/Error.md +0 -25
- data/docs/Exercise.md +0 -47
- data/docs/ExerciseHashId.md +0 -45
- data/docs/Exercises.md +0 -17
- data/docs/HeartRate.md +0 -19
- data/docs/PhysicalInformation.md +0 -39
- data/docs/PhysicalInformations.md +0 -17
- data/docs/Register.md +0 -17
- data/docs/Sample.md +0 -21
- data/docs/Samples.md +0 -17
- data/docs/TransactionLocation.md +0 -19
- data/docs/User.md +0 -35
- data/docs/UserExtraInfo.md +0 -21
- data/docs/WebhookInfo.md +0 -17
- data/docs/WebhookInfoData.md +0 -21
- data/docs/WebhookPatch.md +0 -19
- data/docs/WebhookPayload.md +0 -25
- data/docs/WebhookPing.md +0 -19
- data/docs/WebhookRequest.md +0 -19
- data/docs/WebhookType.md +0 -16
- data/docs/Zone.md +0 -23
- data/docs/Zones.md +0 -17
- data/lib/polar_accesslink/models/activity.rb +0 -288
- data/lib/polar_accesslink/models/activity_log.rb +0 -210
- data/lib/polar_accesslink/models/activity_step_sample.rb +0 -218
- data/lib/polar_accesslink/models/activity_step_samples.rb +0 -220
- data/lib/polar_accesslink/models/activity_zone_sample.rb +0 -220
- data/lib/polar_accesslink/models/activity_zone_samples.rb +0 -220
- data/lib/polar_accesslink/models/available_user_data.rb +0 -262
- data/lib/polar_accesslink/models/available_user_datas.rb +0 -210
- data/lib/polar_accesslink/models/created_webhook.rb +0 -206
- data/lib/polar_accesslink/models/created_webhook_data.rb +0 -236
- data/lib/polar_accesslink/models/duration_zone.rb +0 -218
- data/lib/polar_accesslink/models/error.rb +0 -248
- data/lib/polar_accesslink/models/exercise.rb +0 -357
- data/lib/polar_accesslink/models/exercise_hash_id.rb +0 -347
- data/lib/polar_accesslink/models/exercises.rb +0 -210
- data/lib/polar_accesslink/models/heart_rate.rb +0 -218
- data/lib/polar_accesslink/models/physical_information.rb +0 -352
- data/lib/polar_accesslink/models/physical_informations.rb +0 -210
- data/lib/polar_accesslink/models/register.rb +0 -213
- data/lib/polar_accesslink/models/sample.rb +0 -228
- data/lib/polar_accesslink/models/samples.rb +0 -210
- data/lib/polar_accesslink/models/transaction_location.rb +0 -218
- data/lib/polar_accesslink/models/user.rb +0 -334
- data/lib/polar_accesslink/models/user_extra_info.rb +0 -228
- data/lib/polar_accesslink/models/webhook_info.rb +0 -206
- data/lib/polar_accesslink/models/webhook_info_data.rb +0 -226
- data/lib/polar_accesslink/models/webhook_patch.rb +0 -219
- data/lib/polar_accesslink/models/webhook_payload.rb +0 -246
- data/lib/polar_accesslink/models/webhook_ping.rb +0 -252
- data/lib/polar_accesslink/models/webhook_request.rb +0 -229
- data/lib/polar_accesslink/models/webhook_type.rb +0 -37
- data/lib/polar_accesslink/models/zone.rb +0 -238
- data/lib/polar_accesslink/models/zones.rb +0 -210
- data/spec/models/activity_log_spec.rb +0 -41
- data/spec/models/activity_spec.rb +0 -89
- data/spec/models/activity_step_sample_spec.rb +0 -47
- data/spec/models/activity_step_samples_spec.rb +0 -47
- data/spec/models/activity_zone_sample_spec.rb +0 -47
- data/spec/models/activity_zone_samples_spec.rb +0 -47
- data/spec/models/available_user_data_spec.rb +0 -57
- data/spec/models/available_user_datas_spec.rb +0 -41
- data/spec/models/created_webhook_data_spec.rb +0 -59
- data/spec/models/created_webhook_spec.rb +0 -41
- data/spec/models/duration_zone_spec.rb +0 -47
- data/spec/models/error_spec.rb +0 -65
- data/spec/models/exercise_hash_id_spec.rb +0 -125
- data/spec/models/exercise_spec.rb +0 -131
- data/spec/models/exercises_spec.rb +0 -41
- data/spec/models/heart_rate_spec.rb +0 -47
- data/spec/models/physical_information_spec.rb +0 -111
- data/spec/models/physical_informations_spec.rb +0 -41
- data/spec/models/register_spec.rb +0 -41
- data/spec/models/sample_spec.rb +0 -53
- data/spec/models/samples_spec.rb +0 -41
- data/spec/models/transaction_location_spec.rb +0 -47
- data/spec/models/user_extra_info_spec.rb +0 -53
- data/spec/models/user_spec.rb +0 -99
- data/spec/models/webhook_info_data_spec.rb +0 -53
- data/spec/models/webhook_info_spec.rb +0 -41
- data/spec/models/webhook_patch_spec.rb +0 -47
- data/spec/models/webhook_payload_spec.rb +0 -65
- data/spec/models/webhook_ping_spec.rb +0 -51
- data/spec/models/webhook_request_spec.rb +0 -47
- data/spec/models/webhook_type_spec.rb +0 -35
- data/spec/models/zone_spec.rb +0 -59
- data/spec/models/zones_spec.rb +0 -41
data/docs/ExercisesApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# PolarAccesslink::ExercisesApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://localhost*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -9,33 +9,26 @@ Method | HTTP request | Description
|
|
9
9
|
[**list_exercises_without_transaction**](ExercisesApi.md#list_exercises_without_transaction) | **GET** /v3/exercises | List exercises
|
10
10
|
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
> String get_exercise_fit_without_transaction(exercise_id)
|
12
|
+
# **get_exercise_fit_without_transaction**
|
13
|
+
> get_exercise_fit_without_transaction(exercise_id)
|
16
14
|
|
17
15
|
Get exercise FIT
|
18
16
|
|
19
17
|
FIT file for users exercise.
|
20
18
|
|
21
19
|
### Example
|
22
|
-
|
23
20
|
```ruby
|
24
21
|
# load the gem
|
25
|
-
require '
|
26
|
-
# setup authorization
|
27
|
-
PolarAccesslink.configure do |config|
|
28
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
29
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
30
|
-
end
|
22
|
+
require 'polar_accesslink'
|
31
23
|
|
32
24
|
api_instance = PolarAccesslink::ExercisesApi.new
|
33
|
-
|
25
|
+
|
26
|
+
exercise_id = nil # Object | Hashed exercise id.
|
27
|
+
|
34
28
|
|
35
29
|
begin
|
36
30
|
#Get exercise FIT
|
37
|
-
|
38
|
-
p result
|
31
|
+
api_instance.get_exercise_fit_without_transaction(exercise_id)
|
39
32
|
rescue PolarAccesslink::ApiError => e
|
40
33
|
puts "Exception when calling ExercisesApi->get_exercise_fit_without_transaction: #{e}"
|
41
34
|
end
|
@@ -43,51 +36,45 @@ end
|
|
43
36
|
|
44
37
|
### Parameters
|
45
38
|
|
46
|
-
|
47
39
|
Name | Type | Description | Notes
|
48
40
|
------------- | ------------- | ------------- | -------------
|
49
|
-
**exercise_id** | **
|
41
|
+
**exercise_id** | [**Object**](.md)| Hashed exercise id. |
|
50
42
|
|
51
43
|
### Return type
|
52
44
|
|
53
|
-
|
45
|
+
nil (empty response body)
|
54
46
|
|
55
47
|
### Authorization
|
56
48
|
|
57
|
-
|
49
|
+
No authorization required
|
58
50
|
|
59
51
|
### HTTP request headers
|
60
52
|
|
61
|
-
- **Content-Type**: Not defined
|
62
|
-
- **Accept**:
|
53
|
+
- **Content-Type**: Not defined
|
54
|
+
- **Accept**: Not defined
|
63
55
|
|
64
56
|
|
65
|
-
## get_exercise_without_transaction
|
66
57
|
|
67
|
-
|
58
|
+
# **get_exercise_without_transaction**
|
59
|
+
> get_exercise_without_transaction(exercise_id)
|
68
60
|
|
69
61
|
Get exercise
|
70
62
|
|
71
63
|
Get users exercise using hashed id.
|
72
64
|
|
73
65
|
### Example
|
74
|
-
|
75
66
|
```ruby
|
76
67
|
# load the gem
|
77
|
-
require '
|
78
|
-
# setup authorization
|
79
|
-
PolarAccesslink.configure do |config|
|
80
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
81
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
82
|
-
end
|
68
|
+
require 'polar_accesslink'
|
83
69
|
|
84
70
|
api_instance = PolarAccesslink::ExercisesApi.new
|
85
|
-
|
71
|
+
|
72
|
+
exercise_id = nil # Object | Hashed exercise id.
|
73
|
+
|
86
74
|
|
87
75
|
begin
|
88
76
|
#Get exercise
|
89
|
-
|
90
|
-
p result
|
77
|
+
api_instance.get_exercise_without_transaction(exercise_id)
|
91
78
|
rescue PolarAccesslink::ApiError => e
|
92
79
|
puts "Exception when calling ExercisesApi->get_exercise_without_transaction: #{e}"
|
93
80
|
end
|
@@ -95,69 +82,62 @@ end
|
|
95
82
|
|
96
83
|
### Parameters
|
97
84
|
|
98
|
-
|
99
85
|
Name | Type | Description | Notes
|
100
86
|
------------- | ------------- | ------------- | -------------
|
101
|
-
**exercise_id** | **
|
87
|
+
**exercise_id** | [**Object**](.md)| Hashed exercise id. |
|
102
88
|
|
103
89
|
### Return type
|
104
90
|
|
105
|
-
|
91
|
+
nil (empty response body)
|
106
92
|
|
107
93
|
### Authorization
|
108
94
|
|
109
|
-
|
95
|
+
No authorization required
|
110
96
|
|
111
97
|
### HTTP request headers
|
112
98
|
|
113
|
-
- **Content-Type**: Not defined
|
114
|
-
- **Accept**:
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: Not defined
|
115
101
|
|
116
102
|
|
117
|
-
## list_exercises_without_transaction
|
118
103
|
|
119
|
-
|
104
|
+
# **list_exercises_without_transaction**
|
105
|
+
> list_exercises_without_transaction
|
120
106
|
|
121
107
|
List exercises
|
122
108
|
|
123
109
|
List users exercises available in Accesslink.
|
124
110
|
|
125
111
|
### Example
|
126
|
-
|
127
112
|
```ruby
|
128
113
|
# load the gem
|
129
|
-
require '
|
130
|
-
# setup authorization
|
131
|
-
PolarAccesslink.configure do |config|
|
132
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
133
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
134
|
-
end
|
114
|
+
require 'polar_accesslink'
|
135
115
|
|
136
116
|
api_instance = PolarAccesslink::ExercisesApi.new
|
137
117
|
|
138
118
|
begin
|
139
119
|
#List exercises
|
140
|
-
|
141
|
-
p result
|
120
|
+
api_instance.list_exercises_without_transaction
|
142
121
|
rescue PolarAccesslink::ApiError => e
|
143
122
|
puts "Exception when calling ExercisesApi->list_exercises_without_transaction: #{e}"
|
144
123
|
end
|
145
124
|
```
|
146
125
|
|
147
126
|
### Parameters
|
148
|
-
|
149
127
|
This endpoint does not need any parameter.
|
150
128
|
|
151
129
|
### Return type
|
152
130
|
|
153
|
-
|
131
|
+
nil (empty response body)
|
154
132
|
|
155
133
|
### Authorization
|
156
134
|
|
157
|
-
|
135
|
+
No authorization required
|
158
136
|
|
159
137
|
### HTTP request headers
|
160
138
|
|
161
|
-
- **Content-Type**: Not defined
|
162
|
-
- **Accept**:
|
139
|
+
- **Content-Type**: Not defined
|
140
|
+
- **Accept**: Not defined
|
141
|
+
|
142
|
+
|
163
143
|
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# PolarAccesslink::NightlyRechargeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_nightly_recharge**](NightlyRechargeApi.md#list_nightly_recharge) | **GET** /v3/users/nightly-recharge | List Nightly Recharges
|
8
|
+
[**v3_users_nightly_recharge_date_get**](NightlyRechargeApi.md#v3_users_nightly_recharge_date_get) | **GET** /v3/users/nightly-recharge/{date} | Get Nightly Recharge
|
9
|
+
|
10
|
+
|
11
|
+
# **list_nightly_recharge**
|
12
|
+
> list_nightly_recharge
|
13
|
+
|
14
|
+
List Nightly Recharges
|
15
|
+
|
16
|
+
List Nightly Recharge data of user for the last 28 days.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'polar_accesslink'
|
22
|
+
|
23
|
+
api_instance = PolarAccesslink::NightlyRechargeApi.new
|
24
|
+
|
25
|
+
begin
|
26
|
+
#List Nightly Recharges
|
27
|
+
api_instance.list_nightly_recharge
|
28
|
+
rescue PolarAccesslink::ApiError => e
|
29
|
+
puts "Exception when calling NightlyRechargeApi->list_nightly_recharge: #{e}"
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
### Parameters
|
34
|
+
This endpoint does not need any parameter.
|
35
|
+
|
36
|
+
### Return type
|
37
|
+
|
38
|
+
nil (empty response body)
|
39
|
+
|
40
|
+
### Authorization
|
41
|
+
|
42
|
+
No authorization required
|
43
|
+
|
44
|
+
### HTTP request headers
|
45
|
+
|
46
|
+
- **Content-Type**: Not defined
|
47
|
+
- **Accept**: Not defined
|
48
|
+
|
49
|
+
|
50
|
+
|
51
|
+
# **v3_users_nightly_recharge_date_get**
|
52
|
+
> v3_users_nightly_recharge_date_get(date)
|
53
|
+
|
54
|
+
Get Nightly Recharge
|
55
|
+
|
56
|
+
Get Users Nightly Recharge data for given date.
|
57
|
+
|
58
|
+
### Example
|
59
|
+
```ruby
|
60
|
+
# load the gem
|
61
|
+
require 'polar_accesslink'
|
62
|
+
|
63
|
+
api_instance = PolarAccesslink::NightlyRechargeApi.new
|
64
|
+
|
65
|
+
date = nil # Object | Date of Nightly Recharge as ISO-8601 date string, example: \"2020-01-01\"
|
66
|
+
|
67
|
+
|
68
|
+
begin
|
69
|
+
#Get Nightly Recharge
|
70
|
+
api_instance.v3_users_nightly_recharge_date_get(date)
|
71
|
+
rescue PolarAccesslink::ApiError => e
|
72
|
+
puts "Exception when calling NightlyRechargeApi->v3_users_nightly_recharge_date_get: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
Name | Type | Description | Notes
|
79
|
+
------------- | ------------- | ------------- | -------------
|
80
|
+
**date** | [**Object**](.md)| Date of Nightly Recharge as ISO-8601 date string, example: \"2020-01-01\" |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
nil (empty response body)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
No authorization required
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: Not defined
|
94
|
+
|
95
|
+
|
96
|
+
|
data/docs/PhysicalInfoApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# PolarAccesslink::PhysicalInfoApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://localhost*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -10,9 +10,7 @@ Method | HTTP request | Description
|
|
10
10
|
[**list_physical_infos**](PhysicalInfoApi.md#list_physical_infos) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | List physical infos
|
11
11
|
|
12
12
|
|
13
|
-
|
14
|
-
## commit_physical_info_transaction
|
15
|
-
|
13
|
+
# **commit_physical_info_transaction**
|
16
14
|
> commit_physical_info_transaction(transaction_id, user_id)
|
17
15
|
|
18
16
|
Commit transaction
|
@@ -20,19 +18,16 @@ Commit transaction
|
|
20
18
|
After successfully retrieving physical information within a transaction, partners are expected to commit the transaction.
|
21
19
|
|
22
20
|
### Example
|
23
|
-
|
24
21
|
```ruby
|
25
22
|
# load the gem
|
26
|
-
require '
|
27
|
-
# setup authorization
|
28
|
-
PolarAccesslink.configure do |config|
|
29
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
30
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
31
|
-
end
|
23
|
+
require 'polar_accesslink'
|
32
24
|
|
33
25
|
api_instance = PolarAccesslink::PhysicalInfoApi.new
|
34
|
-
|
35
|
-
|
26
|
+
|
27
|
+
transaction_id = nil # Object | Transaction identifier
|
28
|
+
|
29
|
+
user_id = nil # Object | User identifier
|
30
|
+
|
36
31
|
|
37
32
|
begin
|
38
33
|
#Commit transaction
|
@@ -44,11 +39,10 @@ end
|
|
44
39
|
|
45
40
|
### Parameters
|
46
41
|
|
47
|
-
|
48
42
|
Name | Type | Description | Notes
|
49
43
|
------------- | ------------- | ------------- | -------------
|
50
|
-
**transaction_id** | **
|
51
|
-
**user_id** | **
|
44
|
+
**transaction_id** | [**Object**](.md)| Transaction identifier |
|
45
|
+
**user_id** | [**Object**](.md)| User identifier |
|
52
46
|
|
53
47
|
### Return type
|
54
48
|
|
@@ -56,40 +50,35 @@ nil (empty response body)
|
|
56
50
|
|
57
51
|
### Authorization
|
58
52
|
|
59
|
-
|
53
|
+
No authorization required
|
60
54
|
|
61
55
|
### HTTP request headers
|
62
56
|
|
63
|
-
- **Content-Type**: Not defined
|
64
|
-
- **Accept**: Not defined
|
57
|
+
- **Content-Type**: Not defined
|
58
|
+
- **Accept**: Not defined
|
65
59
|
|
66
60
|
|
67
|
-
## create_physical_info_transaction
|
68
61
|
|
69
|
-
|
62
|
+
# **create_physical_info_transaction**
|
63
|
+
> create_physical_info_transaction(user_id)
|
70
64
|
|
71
65
|
Create transaction
|
72
66
|
|
73
67
|
Initiate physical info transaction. Check for new physical info and create a new transaction if found.
|
74
68
|
|
75
69
|
### Example
|
76
|
-
|
77
70
|
```ruby
|
78
71
|
# load the gem
|
79
|
-
require '
|
80
|
-
# setup authorization
|
81
|
-
PolarAccesslink.configure do |config|
|
82
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
83
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
84
|
-
end
|
72
|
+
require 'polar_accesslink'
|
85
73
|
|
86
74
|
api_instance = PolarAccesslink::PhysicalInfoApi.new
|
87
|
-
|
75
|
+
|
76
|
+
user_id = nil # Object | User identifier
|
77
|
+
|
88
78
|
|
89
79
|
begin
|
90
80
|
#Create transaction
|
91
|
-
|
92
|
-
p result
|
81
|
+
api_instance.create_physical_info_transaction(user_id)
|
93
82
|
rescue PolarAccesslink::ApiError => e
|
94
83
|
puts "Exception when calling PhysicalInfoApi->create_physical_info_transaction: #{e}"
|
95
84
|
end
|
@@ -97,53 +86,49 @@ end
|
|
97
86
|
|
98
87
|
### Parameters
|
99
88
|
|
100
|
-
|
101
89
|
Name | Type | Description | Notes
|
102
90
|
------------- | ------------- | ------------- | -------------
|
103
|
-
**user_id** | **
|
91
|
+
**user_id** | [**Object**](.md)| User identifier |
|
104
92
|
|
105
93
|
### Return type
|
106
94
|
|
107
|
-
|
95
|
+
nil (empty response body)
|
108
96
|
|
109
97
|
### Authorization
|
110
98
|
|
111
|
-
|
99
|
+
No authorization required
|
112
100
|
|
113
101
|
### HTTP request headers
|
114
102
|
|
115
|
-
- **Content-Type**: Not defined
|
116
|
-
- **Accept**:
|
103
|
+
- **Content-Type**: Not defined
|
104
|
+
- **Accept**: Not defined
|
117
105
|
|
118
106
|
|
119
|
-
## get_physical_info
|
120
107
|
|
121
|
-
|
108
|
+
# **get_physical_info**
|
109
|
+
> get_physical_info(user_id, transaction_id, physical_info_id)
|
122
110
|
|
123
111
|
Get physical info
|
124
112
|
|
125
113
|
Get physical info entity data
|
126
114
|
|
127
115
|
### Example
|
128
|
-
|
129
116
|
```ruby
|
130
117
|
# load the gem
|
131
|
-
require '
|
132
|
-
# setup authorization
|
133
|
-
PolarAccesslink.configure do |config|
|
134
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
135
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
136
|
-
end
|
118
|
+
require 'polar_accesslink'
|
137
119
|
|
138
120
|
api_instance = PolarAccesslink::PhysicalInfoApi.new
|
139
|
-
|
140
|
-
|
141
|
-
|
121
|
+
|
122
|
+
user_id = nil # Object | User identifier
|
123
|
+
|
124
|
+
transaction_id = nil # Object | Transaction identifier
|
125
|
+
|
126
|
+
physical_info_id = nil # Object | Physical information identifier
|
127
|
+
|
142
128
|
|
143
129
|
begin
|
144
130
|
#Get physical info
|
145
|
-
|
146
|
-
p result
|
131
|
+
api_instance.get_physical_info(user_id, transaction_id, physical_info_id)
|
147
132
|
rescue PolarAccesslink::ApiError => e
|
148
133
|
puts "Exception when calling PhysicalInfoApi->get_physical_info: #{e}"
|
149
134
|
end
|
@@ -151,54 +136,49 @@ end
|
|
151
136
|
|
152
137
|
### Parameters
|
153
138
|
|
154
|
-
|
155
139
|
Name | Type | Description | Notes
|
156
140
|
------------- | ------------- | ------------- | -------------
|
157
|
-
**user_id** | **
|
158
|
-
**transaction_id** | **
|
159
|
-
**physical_info_id** | **
|
141
|
+
**user_id** | [**Object**](.md)| User identifier |
|
142
|
+
**transaction_id** | [**Object**](.md)| Transaction identifier |
|
143
|
+
**physical_info_id** | [**Object**](.md)| Physical information identifier |
|
160
144
|
|
161
145
|
### Return type
|
162
146
|
|
163
|
-
|
147
|
+
nil (empty response body)
|
164
148
|
|
165
149
|
### Authorization
|
166
150
|
|
167
|
-
|
151
|
+
No authorization required
|
168
152
|
|
169
153
|
### HTTP request headers
|
170
154
|
|
171
|
-
- **Content-Type**: Not defined
|
172
|
-
- **Accept**:
|
155
|
+
- **Content-Type**: Not defined
|
156
|
+
- **Accept**: Not defined
|
173
157
|
|
174
158
|
|
175
|
-
## list_physical_infos
|
176
159
|
|
177
|
-
|
160
|
+
# **list_physical_infos**
|
161
|
+
> list_physical_infos(transaction_id, user_id)
|
178
162
|
|
179
163
|
List physical infos
|
180
164
|
|
181
165
|
List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId.
|
182
166
|
|
183
167
|
### Example
|
184
|
-
|
185
168
|
```ruby
|
186
169
|
# load the gem
|
187
|
-
require '
|
188
|
-
# setup authorization
|
189
|
-
PolarAccesslink.configure do |config|
|
190
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
191
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
192
|
-
end
|
170
|
+
require 'polar_accesslink'
|
193
171
|
|
194
172
|
api_instance = PolarAccesslink::PhysicalInfoApi.new
|
195
|
-
|
196
|
-
|
173
|
+
|
174
|
+
transaction_id = nil # Object | Transaction identifier
|
175
|
+
|
176
|
+
user_id = nil # Object | User identifier
|
177
|
+
|
197
178
|
|
198
179
|
begin
|
199
180
|
#List physical infos
|
200
|
-
|
201
|
-
p result
|
181
|
+
api_instance.list_physical_infos(transaction_id, user_id)
|
202
182
|
rescue PolarAccesslink::ApiError => e
|
203
183
|
puts "Exception when calling PhysicalInfoApi->list_physical_infos: #{e}"
|
204
184
|
end
|
@@ -206,22 +186,23 @@ end
|
|
206
186
|
|
207
187
|
### Parameters
|
208
188
|
|
209
|
-
|
210
189
|
Name | Type | Description | Notes
|
211
190
|
------------- | ------------- | ------------- | -------------
|
212
|
-
**transaction_id** | **
|
213
|
-
**user_id** | **
|
191
|
+
**transaction_id** | [**Object**](.md)| Transaction identifier |
|
192
|
+
**user_id** | [**Object**](.md)| User identifier |
|
214
193
|
|
215
194
|
### Return type
|
216
195
|
|
217
|
-
|
196
|
+
nil (empty response body)
|
218
197
|
|
219
198
|
### Authorization
|
220
199
|
|
221
|
-
|
200
|
+
No authorization required
|
222
201
|
|
223
202
|
### HTTP request headers
|
224
203
|
|
225
|
-
- **Content-Type**: Not defined
|
226
|
-
- **Accept**:
|
204
|
+
- **Content-Type**: Not defined
|
205
|
+
- **Accept**: Not defined
|
206
|
+
|
207
|
+
|
227
208
|
|