talon_one 4.0.0 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -6
- data/docs/ActivateUserRequest.md +17 -0
- data/docs/Coupon.md +2 -2
- data/docs/CustomerInventory.md +1 -1
- data/docs/InlineResponse20044.md +1 -1
- data/docs/IntegrationApi.md +11 -11
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/InventoryCoupon.md +2 -2
- data/docs/LoyaltyCardBalances.md +21 -0
- data/docs/LoyaltyCardProfileRegistration.md +1 -1
- data/docs/ManagementApi.md +187 -69
- data/docs/MessageLogEntry.md +1 -3
- data/docs/NewCoupons.md +1 -1
- data/docs/NewExternalInvitation.md +21 -0
- data/docs/UpdateCoupon.md +1 -1
- data/docs/UpdateUser.md +1 -1
- data/lib/talon_one/api/integration_api.rb +18 -18
- data/lib/talon_one/api/management_api.rb +200 -76
- data/lib/talon_one/models/activate_user_request.rb +213 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +2 -2
- data/lib/talon_one/models/campaign.rb +2 -2
- data/lib/talon_one/models/coupon.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +1 -1
- data/lib/talon_one/models/integration_coupon.rb +2 -2
- data/lib/talon_one/models/inventory_coupon.rb +2 -2
- data/lib/talon_one/models/loyalty_card_balances.rb +231 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +1 -1
- data/lib/talon_one/models/message_log_entry.rb +4 -14
- data/lib/talon_one/models/new_coupons.rb +1 -1
- data/lib/talon_one/models/new_external_invitation.rb +235 -0
- data/lib/talon_one/models/update_coupon.rb +1 -1
- data/lib/talon_one/models/update_user.rb +1 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +3 -0
- data/spec/api/integration_api_spec.rb +7 -7
- data/spec/api/management_api_spec.rb +43 -19
- data/spec/models/activate_user_request_spec.rb +41 -0
- data/spec/models/additional_campaign_properties_spec.rb +1 -1
- data/spec/models/campaign_spec.rb +1 -1
- data/spec/models/loyalty_card_balances_spec.rb +53 -0
- data/spec/models/message_log_entry_spec.rb +1 -7
- data/spec/models/new_external_invitation_spec.rb +53 -0
- metadata +30 -18
data/docs/ManagementApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**activate_user_by_email**](ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Activate user by email address
|
7
8
|
[**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
|
8
9
|
[**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
|
9
10
|
[**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
|
@@ -58,7 +59,6 @@ Method | HTTP request | Description
|
|
58
59
|
[**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
|
59
60
|
[**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
60
61
|
[**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs
|
61
|
-
[**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | List roles
|
62
62
|
[**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
63
63
|
[**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health
|
64
64
|
[**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer
|
@@ -104,7 +104,7 @@ Method | HTTP request | Description
|
|
104
104
|
[**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
105
105
|
[**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
106
106
|
[**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
|
107
|
-
[**
|
107
|
+
[**get_role_v2**](ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
108
108
|
[**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
109
109
|
[**get_rulesets**](ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets
|
110
110
|
[**get_store**](ManagementApi.md#get_store) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store
|
@@ -124,8 +124,10 @@ Method | HTTP request | Description
|
|
124
124
|
[**import_loyalty_points**](ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points
|
125
125
|
[**import_pool_giveaways**](ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool
|
126
126
|
[**import_referrals**](ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals
|
127
|
+
[**invite_user_external**](ManagementApi.md#invite_user_external) | **POST** /v1/users/invite | Invite user from identity provider
|
127
128
|
[**list_account_collections**](ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
128
129
|
[**list_achievements**](ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
130
|
+
[**list_all_roles_v2**](ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
129
131
|
[**list_catalog_items**](ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
130
132
|
[**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
131
133
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
@@ -155,6 +157,64 @@ Method | HTTP request | Description
|
|
155
157
|
|
156
158
|
|
157
159
|
|
160
|
+
## activate_user_by_email
|
161
|
+
|
162
|
+
> activate_user_by_email(body)
|
163
|
+
|
164
|
+
Activate user by email address
|
165
|
+
|
166
|
+
Activate a deactivated user by their email address.
|
167
|
+
|
168
|
+
### Example
|
169
|
+
|
170
|
+
```ruby
|
171
|
+
# load the gem
|
172
|
+
require 'talon_one'
|
173
|
+
# setup authorization
|
174
|
+
TalonOne.configure do |config|
|
175
|
+
# Configure API key authorization: management_key
|
176
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
178
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
179
|
+
|
180
|
+
# Configure API key authorization: manager_auth
|
181
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
182
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
183
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
184
|
+
end
|
185
|
+
|
186
|
+
api_instance = TalonOne::ManagementApi.new
|
187
|
+
body = TalonOne::ActivateUserRequest.new # ActivateUserRequest | body
|
188
|
+
|
189
|
+
begin
|
190
|
+
#Activate user by email address
|
191
|
+
api_instance.activate_user_by_email(body)
|
192
|
+
rescue TalonOne::ApiError => e
|
193
|
+
puts "Exception when calling ManagementApi->activate_user_by_email: #{e}"
|
194
|
+
end
|
195
|
+
```
|
196
|
+
|
197
|
+
### Parameters
|
198
|
+
|
199
|
+
|
200
|
+
Name | Type | Description | Notes
|
201
|
+
------------- | ------------- | ------------- | -------------
|
202
|
+
**body** | [**ActivateUserRequest**](ActivateUserRequest.md)| body |
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
nil (empty response body)
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: application/json
|
215
|
+
- **Accept**: Not defined
|
216
|
+
|
217
|
+
|
158
218
|
## add_loyalty_card_points
|
159
219
|
|
160
220
|
> add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
|
@@ -2314,7 +2374,7 @@ Name | Type | Description | Notes
|
|
2314
2374
|
|
2315
2375
|
Export coupons
|
2316
2376
|
|
2317
|
-
Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the
|
2377
|
+
Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
|
2318
2378
|
|
2319
2379
|
### Example
|
2320
2380
|
|
@@ -3585,61 +3645,6 @@ Name | Type | Description | Notes
|
|
3585
3645
|
- **Accept**: application/json
|
3586
3646
|
|
3587
3647
|
|
3588
|
-
## get_all_roles
|
3589
|
-
|
3590
|
-
> InlineResponse20044 get_all_roles
|
3591
|
-
|
3592
|
-
List roles
|
3593
|
-
|
3594
|
-
List all roles.
|
3595
|
-
|
3596
|
-
### Example
|
3597
|
-
|
3598
|
-
```ruby
|
3599
|
-
# load the gem
|
3600
|
-
require 'talon_one'
|
3601
|
-
# setup authorization
|
3602
|
-
TalonOne.configure do |config|
|
3603
|
-
# Configure API key authorization: management_key
|
3604
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
3605
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3606
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3607
|
-
|
3608
|
-
# Configure API key authorization: manager_auth
|
3609
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
3610
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3611
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3612
|
-
end
|
3613
|
-
|
3614
|
-
api_instance = TalonOne::ManagementApi.new
|
3615
|
-
|
3616
|
-
begin
|
3617
|
-
#List roles
|
3618
|
-
result = api_instance.get_all_roles
|
3619
|
-
p result
|
3620
|
-
rescue TalonOne::ApiError => e
|
3621
|
-
puts "Exception when calling ManagementApi->get_all_roles: #{e}"
|
3622
|
-
end
|
3623
|
-
```
|
3624
|
-
|
3625
|
-
### Parameters
|
3626
|
-
|
3627
|
-
This endpoint does not need any parameter.
|
3628
|
-
|
3629
|
-
### Return type
|
3630
|
-
|
3631
|
-
[**InlineResponse20044**](InlineResponse20044.md)
|
3632
|
-
|
3633
|
-
### Authorization
|
3634
|
-
|
3635
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
3636
|
-
|
3637
|
-
### HTTP request headers
|
3638
|
-
|
3639
|
-
- **Content-Type**: Not defined
|
3640
|
-
- **Accept**: application/json
|
3641
|
-
|
3642
|
-
|
3643
3648
|
## get_application
|
3644
3649
|
|
3645
3650
|
> Application get_application(application_id)
|
@@ -6707,13 +6712,13 @@ Name | Type | Description | Notes
|
|
6707
6712
|
- **Accept**: application/json
|
6708
6713
|
|
6709
6714
|
|
6710
|
-
##
|
6715
|
+
## get_role_v2
|
6711
6716
|
|
6712
|
-
>
|
6717
|
+
> RoleV2 get_role_v2(role_id)
|
6713
6718
|
|
6714
6719
|
Get role
|
6715
6720
|
|
6716
|
-
Get the details of a specific role. To see all the roles, use [List roles](#operation/
|
6721
|
+
Get the details of a specific role. To see all the roles, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
6717
6722
|
|
6718
6723
|
### Example
|
6719
6724
|
|
@@ -6734,14 +6739,14 @@ TalonOne.configure do |config|
|
|
6734
6739
|
end
|
6735
6740
|
|
6736
6741
|
api_instance = TalonOne::ManagementApi.new
|
6737
|
-
role_id = 56 # Integer | ID of role. **Note**: To find the ID of a role, use the [List roles](
|
6742
|
+
role_id = 56 # Integer | The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
6738
6743
|
|
6739
6744
|
begin
|
6740
6745
|
#Get role
|
6741
|
-
result = api_instance.
|
6746
|
+
result = api_instance.get_role_v2(role_id)
|
6742
6747
|
p result
|
6743
6748
|
rescue TalonOne::ApiError => e
|
6744
|
-
puts "Exception when calling ManagementApi->
|
6749
|
+
puts "Exception when calling ManagementApi->get_role_v2: #{e}"
|
6745
6750
|
end
|
6746
6751
|
```
|
6747
6752
|
|
@@ -6750,11 +6755,11 @@ end
|
|
6750
6755
|
|
6751
6756
|
Name | Type | Description | Notes
|
6752
6757
|
------------- | ------------- | ------------- | -------------
|
6753
|
-
**role_id** | **Integer**| ID of role. **Note**: To find the ID of a role, use the [List roles](
|
6758
|
+
**role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
|
6754
6759
|
|
6755
6760
|
### Return type
|
6756
6761
|
|
6757
|
-
[**
|
6762
|
+
[**RoleV2**](RoleV2.md)
|
6758
6763
|
|
6759
6764
|
### Authorization
|
6760
6765
|
|
@@ -7635,7 +7640,7 @@ Name | Type | Description | Notes
|
|
7635
7640
|
|
7636
7641
|
Import coupons
|
7637
7642
|
|
7638
|
-
Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the
|
7643
|
+
Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
|
7639
7644
|
|
7640
7645
|
### Example
|
7641
7646
|
|
@@ -8013,6 +8018,64 @@ Name | Type | Description | Notes
|
|
8013
8018
|
- **Accept**: application/json
|
8014
8019
|
|
8015
8020
|
|
8021
|
+
## invite_user_external
|
8022
|
+
|
8023
|
+
> invite_user_external(body)
|
8024
|
+
|
8025
|
+
Invite user from identity provider
|
8026
|
+
|
8027
|
+
Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
|
8028
|
+
|
8029
|
+
### Example
|
8030
|
+
|
8031
|
+
```ruby
|
8032
|
+
# load the gem
|
8033
|
+
require 'talon_one'
|
8034
|
+
# setup authorization
|
8035
|
+
TalonOne.configure do |config|
|
8036
|
+
# Configure API key authorization: management_key
|
8037
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8038
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8039
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8040
|
+
|
8041
|
+
# Configure API key authorization: manager_auth
|
8042
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8043
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8044
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8045
|
+
end
|
8046
|
+
|
8047
|
+
api_instance = TalonOne::ManagementApi.new
|
8048
|
+
body = TalonOne::NewExternalInvitation.new # NewExternalInvitation | body
|
8049
|
+
|
8050
|
+
begin
|
8051
|
+
#Invite user from identity provider
|
8052
|
+
api_instance.invite_user_external(body)
|
8053
|
+
rescue TalonOne::ApiError => e
|
8054
|
+
puts "Exception when calling ManagementApi->invite_user_external: #{e}"
|
8055
|
+
end
|
8056
|
+
```
|
8057
|
+
|
8058
|
+
### Parameters
|
8059
|
+
|
8060
|
+
|
8061
|
+
Name | Type | Description | Notes
|
8062
|
+
------------- | ------------- | ------------- | -------------
|
8063
|
+
**body** | [**NewExternalInvitation**](NewExternalInvitation.md)| body |
|
8064
|
+
|
8065
|
+
### Return type
|
8066
|
+
|
8067
|
+
nil (empty response body)
|
8068
|
+
|
8069
|
+
### Authorization
|
8070
|
+
|
8071
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
8072
|
+
|
8073
|
+
### HTTP request headers
|
8074
|
+
|
8075
|
+
- **Content-Type**: application/json
|
8076
|
+
- **Accept**: Not defined
|
8077
|
+
|
8078
|
+
|
8016
8079
|
## list_account_collections
|
8017
8080
|
|
8018
8081
|
> InlineResponse20017 list_account_collections(opts)
|
@@ -8151,6 +8214,61 @@ Name | Type | Description | Notes
|
|
8151
8214
|
- **Accept**: application/json
|
8152
8215
|
|
8153
8216
|
|
8217
|
+
## list_all_roles_v2
|
8218
|
+
|
8219
|
+
> InlineResponse20044 list_all_roles_v2
|
8220
|
+
|
8221
|
+
List roles
|
8222
|
+
|
8223
|
+
List all roles.
|
8224
|
+
|
8225
|
+
### Example
|
8226
|
+
|
8227
|
+
```ruby
|
8228
|
+
# load the gem
|
8229
|
+
require 'talon_one'
|
8230
|
+
# setup authorization
|
8231
|
+
TalonOne.configure do |config|
|
8232
|
+
# Configure API key authorization: management_key
|
8233
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8234
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8235
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8236
|
+
|
8237
|
+
# Configure API key authorization: manager_auth
|
8238
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8239
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8240
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8241
|
+
end
|
8242
|
+
|
8243
|
+
api_instance = TalonOne::ManagementApi.new
|
8244
|
+
|
8245
|
+
begin
|
8246
|
+
#List roles
|
8247
|
+
result = api_instance.list_all_roles_v2
|
8248
|
+
p result
|
8249
|
+
rescue TalonOne::ApiError => e
|
8250
|
+
puts "Exception when calling ManagementApi->list_all_roles_v2: #{e}"
|
8251
|
+
end
|
8252
|
+
```
|
8253
|
+
|
8254
|
+
### Parameters
|
8255
|
+
|
8256
|
+
This endpoint does not need any parameter.
|
8257
|
+
|
8258
|
+
### Return type
|
8259
|
+
|
8260
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
8261
|
+
|
8262
|
+
### Authorization
|
8263
|
+
|
8264
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
8265
|
+
|
8266
|
+
### HTTP request headers
|
8267
|
+
|
8268
|
+
- **Content-Type**: Not defined
|
8269
|
+
- **Accept**: application/json
|
8270
|
+
|
8271
|
+
|
8154
8272
|
## list_catalog_items
|
8155
8273
|
|
8156
8274
|
> InlineResponse20035 list_catalog_items(catalog_id, opts)
|
@@ -9705,7 +9823,7 @@ TalonOne.configure do |config|
|
|
9705
9823
|
end
|
9706
9824
|
|
9707
9825
|
api_instance = TalonOne::ManagementApi.new
|
9708
|
-
role_id = 56 # Integer | The ID of role.
|
9826
|
+
role_id = 56 # Integer | The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
9709
9827
|
body = TalonOne::RoleV2Base.new # RoleV2Base | body
|
9710
9828
|
|
9711
9829
|
begin
|
@@ -9722,7 +9840,7 @@ end
|
|
9722
9840
|
|
9723
9841
|
Name | Type | Description | Notes
|
9724
9842
|
------------- | ------------- | ------------- | -------------
|
9725
|
-
**role_id** | **Integer**| The ID of role. |
|
9843
|
+
**role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
|
9726
9844
|
**body** | **RoleV2Base**| body |
|
9727
9845
|
|
9728
9846
|
### Return type
|
data/docs/MessageLogEntry.md
CHANGED
@@ -12,8 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**request** | [**MessageLogRequest**](MessageLogRequest.md) | | [optional]
|
13
13
|
**response** | [**MessageLogResponse**](MessageLogResponse.md) | | [optional]
|
14
14
|
**created_at** | **DateTime** | Timestamp when the log entry was created. |
|
15
|
-
**entity_type** | **String** | The entity type the
|
16
|
-
**url** | **String** | The target URL of the request. | [optional]
|
15
|
+
**entity_type** | **String** | The entity type the notification is related to. | [optional]
|
17
16
|
**application_id** | **Integer** | Identifier of the Application. | [optional]
|
18
17
|
**loyalty_program_id** | **Integer** | Identifier of the loyalty program. | [optional]
|
19
18
|
|
@@ -31,7 +30,6 @@ instance = TalonOne::MessageLogEntry.new(id: 123e4567-e89b-12d3-a456-42661417400
|
|
31
30
|
response: null,
|
32
31
|
created_at: 2021-07-20T22:00Z,
|
33
32
|
entity_type: loyalty_program,
|
34
|
-
url: www.my-company.com/my-endpoint-name,
|
35
33
|
application_id: 5,
|
36
34
|
loyalty_program_id: 2)
|
37
35
|
```
|
data/docs/NewCoupons.md
CHANGED
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
|
17
17
|
**valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional]
|
18
18
|
**coupon_pattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional]
|
19
|
-
**is_reservation_mandatory** | **Boolean** |
|
19
|
+
**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
|
20
20
|
**implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
|
21
21
|
|
22
22
|
## Code Sample
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::NewExternalInvitation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Name of the user. | [optional]
|
8
|
+
**user_groups** | **Array<String>** | List of user groups in the external identity provider. If there are roles in Talon.One whose names match these user groups, those roles will be automatically assigned to the user upon invitation. | [optional]
|
9
|
+
**email** | **String** | Email address of the user. |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::NewExternalInvitation.new(name: John Doe,
|
17
|
+
user_groups: [Managers, Customer support],
|
18
|
+
email: john.doe@example.com)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/UpdateCoupon.md
CHANGED
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
13
13
|
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
|
14
14
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
15
|
-
**is_reservation_mandatory** | **Boolean** |
|
15
|
+
**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
|
16
16
|
**implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/UpdateUser.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**state** | **String** | The state of the user. - `deactivated`: The user has been deactivated. - `active`: The user is active. **Note**: Only `admin` users can update the state of another user. | [optional]
|
9
9
|
**is_admin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
|
10
10
|
**policy** | **String** | Indicates the access level of the user. | [optional]
|
11
|
-
**roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. **Note**:
|
11
|
+
**roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. | [optional]
|
12
12
|
**application_notification_subscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|