talon_one 3.0.0 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/docs/AddLoyaltyPoints.md +2 -2
- data/docs/CustomEffect.md +1 -1
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +2 -2
- data/docs/InlineResponse20014.md +3 -5
- data/docs/InlineResponse20015.md +4 -2
- data/docs/InlineResponse20016.md +2 -4
- data/docs/InlineResponse20017.md +4 -2
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +1 -1
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse20020.md +2 -4
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +3 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +2 -2
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +3 -3
- data/docs/InlineResponse20028.md +3 -5
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +5 -3
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +1 -1
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +2 -4
- data/docs/InlineResponse20038.md +4 -2
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse20040.md +19 -0
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +1 -1
- data/docs/IntegrationApi.md +26 -26
- data/docs/ManagementApi.md +141 -141
- data/docs/MultiApplicationEntity.md +1 -1
- data/docs/NewCustomEffect.md +1 -1
- data/docs/NewOutgoingIntegrationWebhook.md +19 -0
- data/docs/NewWebhook.md +3 -3
- data/docs/OutgoingIntegrationConfiguration.md +3 -1
- data/docs/OutgoingIntegrationWebhookTemplate.md +3 -1
- data/docs/ReopenSessionResponse.md +17 -0
- data/docs/StrikethroughCustomEffectPerItemProps.md +21 -0
- data/docs/UpdateCustomEffect.md +1 -1
- data/docs/Webhook.md +3 -3
- data/lib/talon_one/api/integration_api.rb +48 -48
- data/lib/talon_one/api/management_api.rb +234 -234
- data/lib/talon_one/models/add_loyalty_points.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -11
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +1 -3
- data/lib/talon_one/models/inline_response20014.rb +9 -11
- data/lib/talon_one/models/inline_response20015.rb +11 -7
- data/lib/talon_one/models/inline_response20016.rb +7 -11
- data/lib/talon_one/models/inline_response20017.rb +11 -7
- data/lib/talon_one/models/inline_response20018.rb +10 -10
- data/lib/talon_one/models/inline_response20019.rb +1 -1
- data/lib/talon_one/models/inline_response2002.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +7 -11
- data/lib/talon_one/models/inline_response20021.rb +10 -10
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +10 -6
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +6 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -6
- data/lib/talon_one/models/inline_response20027.rb +11 -11
- data/lib/talon_one/models/inline_response20028.rb +7 -11
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +11 -7
- data/lib/talon_one/models/inline_response20031.rb +1 -1
- data/lib/talon_one/models/inline_response20032.rb +1 -1
- data/lib/talon_one/models/inline_response20033.rb +1 -1
- data/lib/talon_one/models/inline_response20034.rb +1 -1
- data/lib/talon_one/models/inline_response20035.rb +1 -1
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +7 -11
- data/lib/talon_one/models/inline_response20038.rb +11 -7
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +227 -0
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +10 -10
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +1 -1
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- data/lib/talon_one/models/new_custom_effect.rb +1 -1
- data/lib/talon_one/models/new_outgoing_integration_webhook.rb +229 -0
- data/lib/talon_one/models/new_webhook.rb +3 -3
- data/lib/talon_one/models/outgoing_integration_configuration.rb +16 -1
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +53 -4
- data/lib/talon_one/models/reopen_session_response.rb +215 -0
- data/lib/talon_one/models/strikethrough_custom_effect_per_item_props.rb +243 -0
- data/lib/talon_one/models/update_custom_effect.rb +1 -1
- data/lib/talon_one/models/webhook.rb +3 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +4 -0
- data/spec/api/integration_api_spec.rb +9 -9
- data/spec/api/management_api_spec.rb +59 -59
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +0 -6
- data/spec/models/inline_response20015_spec.rb +6 -0
- data/spec/models/inline_response20016_spec.rb +0 -6
- data/spec/models/inline_response20017_spec.rb +6 -0
- data/spec/models/inline_response20018_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +0 -6
- data/spec/models/inline_response20021_spec.rb +2 -2
- data/spec/models/inline_response20023_spec.rb +6 -0
- data/spec/models/inline_response20027_spec.rb +1 -1
- data/spec/models/inline_response20028_spec.rb +0 -6
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +6 -0
- data/spec/models/inline_response20037_spec.rb +0 -6
- data/spec/models/inline_response20038_spec.rb +6 -0
- data/spec/models/inline_response20040_spec.rb +47 -0
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/new_outgoing_integration_webhook_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +6 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +10 -0
- data/spec/models/reopen_session_response_spec.rb +41 -0
- data/spec/models/strikethrough_custom_effect_per_item_props_spec.rb +53 -0
- metadata +18 -2
data/docs/ManagementApi.md
CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
7
|
+
[**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
|
8
8
|
[**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
|
9
9
|
[**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
|
10
10
|
[**create_account_collection**](ManagementApi.md#create_account_collection) | **POST** /v1/collections | Create account-level collection
|
@@ -18,13 +18,13 @@ Method | HTTP request | Description
|
|
18
18
|
[**create_notification_webhook**](ManagementApi.md#create_notification_webhook) | **POST** /v1/applications/{applicationId}/notification_webhooks | Create notification about campaign-related changes
|
19
19
|
[**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
20
20
|
[**create_session**](ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
|
21
|
-
[**deduct_loyalty_card_points**](ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
21
|
+
[**deduct_loyalty_card_points**](ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
|
22
22
|
[**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
23
23
|
[**delete_campaign**](ManagementApi.md#delete_campaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
|
24
24
|
[**delete_collection**](ManagementApi.md#delete_collection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete collection
|
25
25
|
[**delete_coupon**](ManagementApi.md#delete_coupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon
|
26
26
|
[**delete_coupons**](ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons
|
27
|
-
[**delete_loyalty_card**](ManagementApi.md#delete_loyalty_card) | **DELETE** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
27
|
+
[**delete_loyalty_card**](ManagementApi.md#delete_loyalty_card) | **DELETE** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card
|
28
28
|
[**delete_notification_webhook**](ManagementApi.md#delete_notification_webhook) | **DELETE** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Delete notification about campaign-related changes
|
29
29
|
[**delete_referral**](ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral
|
30
30
|
[**destroy_session**](ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy session
|
@@ -35,8 +35,8 @@ Method | HTTP request | Description
|
|
35
35
|
[**export_effects**](ManagementApi.md#export_effects) | **GET** /v1/applications/{applicationId}/export_effects | Export triggered effects
|
36
36
|
[**export_loyalty_balance**](ManagementApi.md#export_loyalty_balance) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV
|
37
37
|
[**export_loyalty_balances**](ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
|
38
|
-
[**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export
|
39
|
-
[**export_loyalty_card_ledger**](ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
38
|
+
[**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs
|
39
|
+
[**export_loyalty_card_ledger**](ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log
|
40
40
|
[**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs
|
41
41
|
[**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
|
42
42
|
[**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application
|
@@ -78,8 +78,8 @@ Method | HTTP request | Description
|
|
78
78
|
[**get_customers_by_attributes**](ManagementApi.md#get_customers_by_attributes) | **POST** /v1/customer_search/no_total | List customer profiles matching the given attributes
|
79
79
|
[**get_event_types**](ManagementApi.md#get_event_types) | **GET** /v1/event_types | List event types
|
80
80
|
[**get_exports**](ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports
|
81
|
-
[**get_loyalty_card**](ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
82
|
-
[**get_loyalty_card_transaction_logs**](ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
81
|
+
[**get_loyalty_card**](ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
|
82
|
+
[**get_loyalty_card_transaction_logs**](ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions
|
83
83
|
[**get_loyalty_cards**](ManagementApi.md#get_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards
|
84
84
|
[**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger
|
85
85
|
[**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program
|
@@ -115,7 +115,7 @@ Method | HTTP request | Description
|
|
115
115
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
116
116
|
[**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count)
|
117
117
|
[**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
|
118
|
-
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
118
|
+
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
119
119
|
[**update_account_collection**](ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
120
120
|
[**update_additional_cost**](ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update additional cost
|
121
121
|
[**update_attribute**](ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update custom attribute
|
@@ -123,7 +123,7 @@ Method | HTTP request | Description
|
|
123
123
|
[**update_collection**](ManagementApi.md#update_collection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update collection description
|
124
124
|
[**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon
|
125
125
|
[**update_coupon_batch**](ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons
|
126
|
-
[**update_loyalty_card**](ManagementApi.md#update_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{
|
126
|
+
[**update_loyalty_card**](ManagementApi.md#update_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status
|
127
127
|
[**update_notification_webhook**](ManagementApi.md#update_notification_webhook) | **PUT** /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId} | Update notification about campaign-related changes
|
128
128
|
[**update_referral**](ManagementApi.md#update_referral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral
|
129
129
|
|
@@ -131,9 +131,9 @@ Method | HTTP request | Description
|
|
131
131
|
|
132
132
|
## add_loyalty_card_points
|
133
133
|
|
134
|
-
> add_loyalty_card_points(loyalty_program_id,
|
134
|
+
> add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
|
135
135
|
|
136
|
-
Add points to card
|
136
|
+
Add points to card
|
137
137
|
|
138
138
|
Add points to the given loyalty card in the specified card-based loyalty program.
|
139
139
|
|
@@ -157,12 +157,12 @@ end
|
|
157
157
|
|
158
158
|
api_instance = TalonOne::ManagementApi.new
|
159
159
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
160
|
-
|
160
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
161
161
|
body = TalonOne::AddLoyaltyPoints.new # AddLoyaltyPoints | body
|
162
162
|
|
163
163
|
begin
|
164
|
-
#Add points to card
|
165
|
-
api_instance.add_loyalty_card_points(loyalty_program_id,
|
164
|
+
#Add points to card
|
165
|
+
api_instance.add_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
|
166
166
|
rescue TalonOne::ApiError => e
|
167
167
|
puts "Exception when calling ManagementApi->add_loyalty_card_points: #{e}"
|
168
168
|
end
|
@@ -174,7 +174,7 @@ end
|
|
174
174
|
Name | Type | Description | Notes
|
175
175
|
------------- | ------------- | ------------- | -------------
|
176
176
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
177
|
-
**
|
177
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
178
178
|
**body** | [**AddLoyaltyPoints**](AddLoyaltyPoints.md)| body |
|
179
179
|
|
180
180
|
### Return type
|
@@ -255,7 +255,7 @@ nil (empty response body)
|
|
255
255
|
|
256
256
|
## copy_campaign_to_applications
|
257
257
|
|
258
|
-
>
|
258
|
+
> InlineResponse2004 copy_campaign_to_applications(application_id, campaign_id, body)
|
259
259
|
|
260
260
|
Copy the campaign into the specified Application
|
261
261
|
|
@@ -304,7 +304,7 @@ Name | Type | Description | Notes
|
|
304
304
|
|
305
305
|
### Return type
|
306
306
|
|
307
|
-
[**
|
307
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
308
308
|
|
309
309
|
### Authorization
|
310
310
|
|
@@ -619,7 +619,7 @@ Name | Type | Description | Notes
|
|
619
619
|
|
620
620
|
## create_coupons
|
621
621
|
|
622
|
-
>
|
622
|
+
> InlineResponse2007 create_coupons(application_id, campaign_id, body, opts)
|
623
623
|
|
624
624
|
Create coupons
|
625
625
|
|
@@ -672,7 +672,7 @@ Name | Type | Description | Notes
|
|
672
672
|
|
673
673
|
### Return type
|
674
674
|
|
675
|
-
[**
|
675
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
676
676
|
|
677
677
|
### Authorization
|
678
678
|
|
@@ -749,7 +749,7 @@ Name | Type | Description | Notes
|
|
749
749
|
|
750
750
|
## create_coupons_for_multiple_recipients
|
751
751
|
|
752
|
-
>
|
752
|
+
> InlineResponse2007 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
|
753
753
|
|
754
754
|
Create coupons for multiple recipients
|
755
755
|
|
@@ -802,7 +802,7 @@ Name | Type | Description | Notes
|
|
802
802
|
|
803
803
|
### Return type
|
804
804
|
|
805
|
-
[**
|
805
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
806
806
|
|
807
807
|
### Authorization
|
808
808
|
|
@@ -995,9 +995,9 @@ Name | Type | Description | Notes
|
|
995
995
|
|
996
996
|
## deduct_loyalty_card_points
|
997
997
|
|
998
|
-
> deduct_loyalty_card_points(loyalty_program_id,
|
998
|
+
> deduct_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
|
999
999
|
|
1000
|
-
Deduct points from card
|
1000
|
+
Deduct points from card
|
1001
1001
|
|
1002
1002
|
Deduct points from the given loyalty card in the specified card-based loyalty program.
|
1003
1003
|
|
@@ -1021,12 +1021,12 @@ end
|
|
1021
1021
|
|
1022
1022
|
api_instance = TalonOne::ManagementApi.new
|
1023
1023
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1024
|
-
|
1024
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1025
1025
|
body = TalonOne::DeductLoyaltyPoints.new # DeductLoyaltyPoints | body
|
1026
1026
|
|
1027
1027
|
begin
|
1028
|
-
#Deduct points from card
|
1029
|
-
api_instance.deduct_loyalty_card_points(loyalty_program_id,
|
1028
|
+
#Deduct points from card
|
1029
|
+
api_instance.deduct_loyalty_card_points(loyalty_program_id, loyalty_card_id, body)
|
1030
1030
|
rescue TalonOne::ApiError => e
|
1031
1031
|
puts "Exception when calling ManagementApi->deduct_loyalty_card_points: #{e}"
|
1032
1032
|
end
|
@@ -1038,7 +1038,7 @@ end
|
|
1038
1038
|
Name | Type | Description | Notes
|
1039
1039
|
------------- | ------------- | ------------- | -------------
|
1040
1040
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
1041
|
-
**
|
1041
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
1042
1042
|
**body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
|
1043
1043
|
|
1044
1044
|
### Return type
|
@@ -1387,7 +1387,7 @@ nil (empty response body)
|
|
1387
1387
|
|
1388
1388
|
## delete_loyalty_card
|
1389
1389
|
|
1390
|
-
> delete_loyalty_card(loyalty_program_id,
|
1390
|
+
> delete_loyalty_card(loyalty_program_id, loyalty_card_id)
|
1391
1391
|
|
1392
1392
|
Delete loyalty card
|
1393
1393
|
|
@@ -1413,11 +1413,11 @@ end
|
|
1413
1413
|
|
1414
1414
|
api_instance = TalonOne::ManagementApi.new
|
1415
1415
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
1416
|
-
|
1416
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1417
1417
|
|
1418
1418
|
begin
|
1419
1419
|
#Delete loyalty card
|
1420
|
-
api_instance.delete_loyalty_card(loyalty_program_id,
|
1420
|
+
api_instance.delete_loyalty_card(loyalty_program_id, loyalty_card_id)
|
1421
1421
|
rescue TalonOne::ApiError => e
|
1422
1422
|
puts "Exception when calling ManagementApi->delete_loyalty_card: #{e}"
|
1423
1423
|
end
|
@@ -1429,7 +1429,7 @@ end
|
|
1429
1429
|
Name | Type | Description | Notes
|
1430
1430
|
------------- | ------------- | ------------- | -------------
|
1431
1431
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
1432
|
-
**
|
1432
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
1433
1433
|
|
1434
1434
|
### Return type
|
1435
1435
|
|
@@ -2100,7 +2100,7 @@ Name | Type | Description | Notes
|
|
2100
2100
|
|
2101
2101
|
> String export_loyalty_card_balances(loyalty_program_id, opts)
|
2102
2102
|
|
2103
|
-
Export
|
2103
|
+
Export all card transaction logs
|
2104
2104
|
|
2105
2105
|
Download a CSV file containing the balances of all cards in the loyalty program. **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 contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
|
2106
2106
|
|
@@ -2129,7 +2129,7 @@ opts = {
|
|
2129
2129
|
}
|
2130
2130
|
|
2131
2131
|
begin
|
2132
|
-
#Export
|
2132
|
+
#Export all card transaction logs
|
2133
2133
|
result = api_instance.export_loyalty_card_balances(loyalty_program_id, opts)
|
2134
2134
|
p result
|
2135
2135
|
rescue TalonOne::ApiError => e
|
@@ -2161,9 +2161,9 @@ Name | Type | Description | Notes
|
|
2161
2161
|
|
2162
2162
|
## export_loyalty_card_ledger
|
2163
2163
|
|
2164
|
-
> String export_loyalty_card_ledger(loyalty_program_id,
|
2164
|
+
> String export_loyalty_card_ledger(loyalty_program_id, loyalty_card_id, range_start, range_end, opts)
|
2165
2165
|
|
2166
|
-
Export
|
2166
|
+
Export card's ledger log
|
2167
2167
|
|
2168
2168
|
Download a CSV file containing a loyalty card ledger log of the loyalty program. **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/).
|
2169
2169
|
|
@@ -2187,7 +2187,7 @@ end
|
|
2187
2187
|
|
2188
2188
|
api_instance = TalonOne::ManagementApi.new
|
2189
2189
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2190
|
-
|
2190
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
2191
2191
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
2192
2192
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
2193
2193
|
opts = {
|
@@ -2195,8 +2195,8 @@ opts = {
|
|
2195
2195
|
}
|
2196
2196
|
|
2197
2197
|
begin
|
2198
|
-
#Export
|
2199
|
-
result = api_instance.export_loyalty_card_ledger(loyalty_program_id,
|
2198
|
+
#Export card's ledger log
|
2199
|
+
result = api_instance.export_loyalty_card_ledger(loyalty_program_id, loyalty_card_id, range_start, range_end, opts)
|
2200
2200
|
p result
|
2201
2201
|
rescue TalonOne::ApiError => e
|
2202
2202
|
puts "Exception when calling ManagementApi->export_loyalty_card_ledger: #{e}"
|
@@ -2209,7 +2209,7 @@ end
|
|
2209
2209
|
Name | Type | Description | Notes
|
2210
2210
|
------------- | ------------- | ------------- | -------------
|
2211
2211
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
2212
|
-
**
|
2212
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
2213
2213
|
**range_start** | **DateTime**| Only return results from after this timestamp. This must be an RFC3339 timestamp string. |
|
2214
2214
|
**range_end** | **DateTime**| Only return results from before this timestamp. This must be an RFC3339 timestamp string. |
|
2215
2215
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
@@ -2374,7 +2374,7 @@ Name | Type | Description | Notes
|
|
2374
2374
|
|
2375
2375
|
## get_access_logs_without_total_count
|
2376
2376
|
|
2377
|
-
>
|
2377
|
+
> InlineResponse20018 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
|
2378
2378
|
|
2379
2379
|
Get access logs for Application
|
2380
2380
|
|
@@ -2437,7 +2437,7 @@ Name | Type | Description | Notes
|
|
2437
2437
|
|
2438
2438
|
### Return type
|
2439
2439
|
|
2440
|
-
[**
|
2440
|
+
[**InlineResponse20018**](InlineResponse20018.md)
|
2441
2441
|
|
2442
2442
|
### Authorization
|
2443
2443
|
|
@@ -2687,7 +2687,7 @@ Name | Type | Description | Notes
|
|
2687
2687
|
|
2688
2688
|
## get_additional_costs
|
2689
2689
|
|
2690
|
-
>
|
2690
|
+
> InlineResponse20032 get_additional_costs(opts)
|
2691
2691
|
|
2692
2692
|
List additional costs
|
2693
2693
|
|
@@ -2738,7 +2738,7 @@ Name | Type | Description | Notes
|
|
2738
2738
|
|
2739
2739
|
### Return type
|
2740
2740
|
|
2741
|
-
[**
|
2741
|
+
[**InlineResponse20032**](InlineResponse20032.md)
|
2742
2742
|
|
2743
2743
|
### Authorization
|
2744
2744
|
|
@@ -2752,7 +2752,7 @@ Name | Type | Description | Notes
|
|
2752
2752
|
|
2753
2753
|
## get_all_access_logs
|
2754
2754
|
|
2755
|
-
>
|
2755
|
+
> InlineResponse20019 get_all_access_logs(range_start, range_end, opts)
|
2756
2756
|
|
2757
2757
|
List access logs
|
2758
2758
|
|
@@ -2813,7 +2813,7 @@ Name | Type | Description | Notes
|
|
2813
2813
|
|
2814
2814
|
### Return type
|
2815
2815
|
|
2816
|
-
[**
|
2816
|
+
[**InlineResponse20019**](InlineResponse20019.md)
|
2817
2817
|
|
2818
2818
|
### Authorization
|
2819
2819
|
|
@@ -2827,7 +2827,7 @@ Name | Type | Description | Notes
|
|
2827
2827
|
|
2828
2828
|
## get_all_roles
|
2829
2829
|
|
2830
|
-
>
|
2830
|
+
> InlineResponse20040 get_all_roles
|
2831
2831
|
|
2832
2832
|
List roles
|
2833
2833
|
|
@@ -2868,7 +2868,7 @@ This endpoint does not need any parameter.
|
|
2868
2868
|
|
2869
2869
|
### Return type
|
2870
2870
|
|
2871
|
-
[**
|
2871
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
2872
2872
|
|
2873
2873
|
### Authorization
|
2874
2874
|
|
@@ -3061,7 +3061,7 @@ Name | Type | Description | Notes
|
|
3061
3061
|
|
3062
3062
|
## get_application_customer_friends
|
3063
3063
|
|
3064
|
-
>
|
3064
|
+
> InlineResponse20030 get_application_customer_friends(application_id, integration_id, opts)
|
3065
3065
|
|
3066
3066
|
List friends referred by customer profile
|
3067
3067
|
|
@@ -3118,7 +3118,7 @@ Name | Type | Description | Notes
|
|
3118
3118
|
|
3119
3119
|
### Return type
|
3120
3120
|
|
3121
|
-
[**
|
3121
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
3122
3122
|
|
3123
3123
|
### Authorization
|
3124
3124
|
|
@@ -3132,7 +3132,7 @@ Name | Type | Description | Notes
|
|
3132
3132
|
|
3133
3133
|
## get_application_customers
|
3134
3134
|
|
3135
|
-
>
|
3135
|
+
> InlineResponse20021 get_application_customers(application_id, opts)
|
3136
3136
|
|
3137
3137
|
List application's customers
|
3138
3138
|
|
@@ -3187,7 +3187,7 @@ Name | Type | Description | Notes
|
|
3187
3187
|
|
3188
3188
|
### Return type
|
3189
3189
|
|
3190
|
-
[**
|
3190
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
3191
3191
|
|
3192
3192
|
### Authorization
|
3193
3193
|
|
@@ -3201,7 +3201,7 @@ Name | Type | Description | Notes
|
|
3201
3201
|
|
3202
3202
|
## get_application_customers_by_attributes
|
3203
3203
|
|
3204
|
-
>
|
3204
|
+
> InlineResponse20022 get_application_customers_by_attributes(application_id, body, opts)
|
3205
3205
|
|
3206
3206
|
List application customers matching the given attributes
|
3207
3207
|
|
@@ -3256,7 +3256,7 @@ Name | Type | Description | Notes
|
|
3256
3256
|
|
3257
3257
|
### Return type
|
3258
3258
|
|
3259
|
-
[**
|
3259
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
3260
3260
|
|
3261
3261
|
### Authorization
|
3262
3262
|
|
@@ -3270,7 +3270,7 @@ Name | Type | Description | Notes
|
|
3270
3270
|
|
3271
3271
|
## get_application_event_types
|
3272
3272
|
|
3273
|
-
>
|
3273
|
+
> InlineResponse20028 get_application_event_types(application_id, opts)
|
3274
3274
|
|
3275
3275
|
List Applications event types
|
3276
3276
|
|
@@ -3323,7 +3323,7 @@ Name | Type | Description | Notes
|
|
3323
3323
|
|
3324
3324
|
### Return type
|
3325
3325
|
|
3326
|
-
[**
|
3326
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
3327
3327
|
|
3328
3328
|
### Authorization
|
3329
3329
|
|
@@ -3337,7 +3337,7 @@ Name | Type | Description | Notes
|
|
3337
3337
|
|
3338
3338
|
## get_application_events_without_total_count
|
3339
3339
|
|
3340
|
-
>
|
3340
|
+
> InlineResponse20027 get_application_events_without_total_count(application_id, opts)
|
3341
3341
|
|
3342
3342
|
List Applications events
|
3343
3343
|
|
@@ -3412,7 +3412,7 @@ Name | Type | Description | Notes
|
|
3412
3412
|
|
3413
3413
|
### Return type
|
3414
3414
|
|
3415
|
-
[**
|
3415
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
3416
3416
|
|
3417
3417
|
### Authorization
|
3418
3418
|
|
@@ -3487,7 +3487,7 @@ Name | Type | Description | Notes
|
|
3487
3487
|
|
3488
3488
|
## get_application_sessions
|
3489
3489
|
|
3490
|
-
>
|
3490
|
+
> InlineResponse20026 get_application_sessions(application_id, opts)
|
3491
3491
|
|
3492
3492
|
List Application sessions
|
3493
3493
|
|
@@ -3554,7 +3554,7 @@ Name | Type | Description | Notes
|
|
3554
3554
|
|
3555
3555
|
### Return type
|
3556
3556
|
|
3557
|
-
[**
|
3557
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
3558
3558
|
|
3559
3559
|
### Authorization
|
3560
3560
|
|
@@ -3568,7 +3568,7 @@ Name | Type | Description | Notes
|
|
3568
3568
|
|
3569
3569
|
## get_applications
|
3570
3570
|
|
3571
|
-
>
|
3571
|
+
> InlineResponse2003 get_applications(opts)
|
3572
3572
|
|
3573
3573
|
List Applications
|
3574
3574
|
|
@@ -3619,7 +3619,7 @@ Name | Type | Description | Notes
|
|
3619
3619
|
|
3620
3620
|
### Return type
|
3621
3621
|
|
3622
|
-
[**
|
3622
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
3623
3623
|
|
3624
3624
|
### Authorization
|
3625
3625
|
|
@@ -3692,7 +3692,7 @@ Name | Type | Description | Notes
|
|
3692
3692
|
|
3693
3693
|
## get_attributes
|
3694
3694
|
|
3695
|
-
>
|
3695
|
+
> InlineResponse20031 get_attributes(opts)
|
3696
3696
|
|
3697
3697
|
List custom attributes
|
3698
3698
|
|
@@ -3745,7 +3745,7 @@ Name | Type | Description | Notes
|
|
3745
3745
|
|
3746
3746
|
### Return type
|
3747
3747
|
|
3748
|
-
[**
|
3748
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
3749
3749
|
|
3750
3750
|
### Authorization
|
3751
3751
|
|
@@ -3759,7 +3759,7 @@ Name | Type | Description | Notes
|
|
3759
3759
|
|
3760
3760
|
## get_audiences
|
3761
3761
|
|
3762
|
-
>
|
3762
|
+
> InlineResponse20029 get_audiences(opts)
|
3763
3763
|
|
3764
3764
|
List audiences
|
3765
3765
|
|
@@ -3812,7 +3812,7 @@ Name | Type | Description | Notes
|
|
3812
3812
|
|
3813
3813
|
### Return type
|
3814
3814
|
|
3815
|
-
[**
|
3815
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
3816
3816
|
|
3817
3817
|
### Authorization
|
3818
3818
|
|
@@ -3887,7 +3887,7 @@ Name | Type | Description | Notes
|
|
3887
3887
|
|
3888
3888
|
## get_campaign_analytics
|
3889
3889
|
|
3890
|
-
>
|
3890
|
+
> InlineResponse20020 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
3891
3891
|
|
3892
3892
|
Get analytics of campaigns
|
3893
3893
|
|
@@ -3942,7 +3942,7 @@ Name | Type | Description | Notes
|
|
3942
3942
|
|
3943
3943
|
### Return type
|
3944
3944
|
|
3945
|
-
[**
|
3945
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
3946
3946
|
|
3947
3947
|
### Authorization
|
3948
3948
|
|
@@ -3956,7 +3956,7 @@ Name | Type | Description | Notes
|
|
3956
3956
|
|
3957
3957
|
## get_campaign_by_attributes
|
3958
3958
|
|
3959
|
-
>
|
3959
|
+
> InlineResponse2004 get_campaign_by_attributes(application_id, body, opts)
|
3960
3960
|
|
3961
3961
|
List campaigns that match the given attributes
|
3962
3962
|
|
@@ -4013,7 +4013,7 @@ Name | Type | Description | Notes
|
|
4013
4013
|
|
4014
4014
|
### Return type
|
4015
4015
|
|
4016
|
-
[**
|
4016
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
4017
4017
|
|
4018
4018
|
### Authorization
|
4019
4019
|
|
@@ -4027,7 +4027,7 @@ Name | Type | Description | Notes
|
|
4027
4027
|
|
4028
4028
|
## get_campaign_templates
|
4029
4029
|
|
4030
|
-
>
|
4030
|
+
> InlineResponse20010 get_campaign_templates(opts)
|
4031
4031
|
|
4032
4032
|
List campaign templates
|
4033
4033
|
|
@@ -4086,7 +4086,7 @@ Name | Type | Description | Notes
|
|
4086
4086
|
|
4087
4087
|
### Return type
|
4088
4088
|
|
4089
|
-
[**
|
4089
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
4090
4090
|
|
4091
4091
|
### Authorization
|
4092
4092
|
|
@@ -4100,7 +4100,7 @@ Name | Type | Description | Notes
|
|
4100
4100
|
|
4101
4101
|
## get_campaigns
|
4102
4102
|
|
4103
|
-
>
|
4103
|
+
> InlineResponse2004 get_campaigns(application_id, opts)
|
4104
4104
|
|
4105
4105
|
List campaigns
|
4106
4106
|
|
@@ -4167,7 +4167,7 @@ Name | Type | Description | Notes
|
|
4167
4167
|
|
4168
4168
|
### Return type
|
4169
4169
|
|
4170
|
-
[**
|
4170
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
4171
4171
|
|
4172
4172
|
### Authorization
|
4173
4173
|
|
@@ -4181,7 +4181,7 @@ Name | Type | Description | Notes
|
|
4181
4181
|
|
4182
4182
|
## get_changes
|
4183
4183
|
|
4184
|
-
>
|
4184
|
+
> InlineResponse20038 get_changes(opts)
|
4185
4185
|
|
4186
4186
|
Get audit logs for an account
|
4187
4187
|
|
@@ -4248,7 +4248,7 @@ Name | Type | Description | Notes
|
|
4248
4248
|
|
4249
4249
|
### Return type
|
4250
4250
|
|
4251
|
-
[**
|
4251
|
+
[**InlineResponse20038**](InlineResponse20038.md)
|
4252
4252
|
|
4253
4253
|
### Authorization
|
4254
4254
|
|
@@ -4325,7 +4325,7 @@ Name | Type | Description | Notes
|
|
4325
4325
|
|
4326
4326
|
## get_collection_items
|
4327
4327
|
|
4328
|
-
>
|
4328
|
+
> InlineResponse20016 get_collection_items(collection_id, opts)
|
4329
4329
|
|
4330
4330
|
Get collection items
|
4331
4331
|
|
@@ -4376,7 +4376,7 @@ Name | Type | Description | Notes
|
|
4376
4376
|
|
4377
4377
|
### Return type
|
4378
4378
|
|
4379
|
-
[**
|
4379
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
4380
4380
|
|
4381
4381
|
### Authorization
|
4382
4382
|
|
@@ -4390,7 +4390,7 @@ Name | Type | Description | Notes
|
|
4390
4390
|
|
4391
4391
|
## get_coupons_without_total_count
|
4392
4392
|
|
4393
|
-
>
|
4393
|
+
> InlineResponse2008 get_coupons_without_total_count(application_id, campaign_id, opts)
|
4394
4394
|
|
4395
4395
|
List coupons
|
4396
4396
|
|
@@ -4463,7 +4463,7 @@ Name | Type | Description | Notes
|
|
4463
4463
|
|
4464
4464
|
### Return type
|
4465
4465
|
|
4466
|
-
[**
|
4466
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
4467
4467
|
|
4468
4468
|
### Authorization
|
4469
4469
|
|
@@ -4548,7 +4548,7 @@ Name | Type | Description | Notes
|
|
4548
4548
|
|
4549
4549
|
## get_customer_activity_reports_without_total_count
|
4550
4550
|
|
4551
|
-
>
|
4551
|
+
> InlineResponse20025 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
4552
4552
|
|
4553
4553
|
Get Activity Reports for Application Customers
|
4554
4554
|
|
@@ -4613,7 +4613,7 @@ Name | Type | Description | Notes
|
|
4613
4613
|
|
4614
4614
|
### Return type
|
4615
4615
|
|
4616
|
-
[**
|
4616
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
4617
4617
|
|
4618
4618
|
### Authorization
|
4619
4619
|
|
@@ -4755,7 +4755,7 @@ Name | Type | Description | Notes
|
|
4755
4755
|
|
4756
4756
|
## get_customer_profiles
|
4757
4757
|
|
4758
|
-
>
|
4758
|
+
> InlineResponse20024 get_customer_profiles(opts)
|
4759
4759
|
|
4760
4760
|
List customer profiles
|
4761
4761
|
|
@@ -4806,7 +4806,7 @@ Name | Type | Description | Notes
|
|
4806
4806
|
|
4807
4807
|
### Return type
|
4808
4808
|
|
4809
|
-
[**
|
4809
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
4810
4810
|
|
4811
4811
|
### Authorization
|
4812
4812
|
|
@@ -4820,7 +4820,7 @@ Name | Type | Description | Notes
|
|
4820
4820
|
|
4821
4821
|
## get_customers_by_attributes
|
4822
4822
|
|
4823
|
-
>
|
4823
|
+
> InlineResponse20023 get_customers_by_attributes(body, opts)
|
4824
4824
|
|
4825
4825
|
List customer profiles matching the given attributes
|
4826
4826
|
|
@@ -4873,7 +4873,7 @@ Name | Type | Description | Notes
|
|
4873
4873
|
|
4874
4874
|
### Return type
|
4875
4875
|
|
4876
|
-
[**
|
4876
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
4877
4877
|
|
4878
4878
|
### Authorization
|
4879
4879
|
|
@@ -4887,7 +4887,7 @@ Name | Type | Description | Notes
|
|
4887
4887
|
|
4888
4888
|
## get_event_types
|
4889
4889
|
|
4890
|
-
>
|
4890
|
+
> InlineResponse20036 get_event_types(opts)
|
4891
4891
|
|
4892
4892
|
List event types
|
4893
4893
|
|
@@ -4942,7 +4942,7 @@ Name | Type | Description | Notes
|
|
4942
4942
|
|
4943
4943
|
### Return type
|
4944
4944
|
|
4945
|
-
[**
|
4945
|
+
[**InlineResponse20036**](InlineResponse20036.md)
|
4946
4946
|
|
4947
4947
|
### Authorization
|
4948
4948
|
|
@@ -4956,7 +4956,7 @@ Name | Type | Description | Notes
|
|
4956
4956
|
|
4957
4957
|
## get_exports
|
4958
4958
|
|
4959
|
-
>
|
4959
|
+
> InlineResponse20039 get_exports(opts)
|
4960
4960
|
|
4961
4961
|
Get exports
|
4962
4962
|
|
@@ -5011,7 +5011,7 @@ Name | Type | Description | Notes
|
|
5011
5011
|
|
5012
5012
|
### Return type
|
5013
5013
|
|
5014
|
-
[**
|
5014
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
5015
5015
|
|
5016
5016
|
### Authorization
|
5017
5017
|
|
@@ -5025,7 +5025,7 @@ Name | Type | Description | Notes
|
|
5025
5025
|
|
5026
5026
|
## get_loyalty_card
|
5027
5027
|
|
5028
|
-
> LoyaltyCard get_loyalty_card(loyalty_program_id,
|
5028
|
+
> LoyaltyCard get_loyalty_card(loyalty_program_id, loyalty_card_id)
|
5029
5029
|
|
5030
5030
|
Get loyalty card
|
5031
5031
|
|
@@ -5051,11 +5051,11 @@ end
|
|
5051
5051
|
|
5052
5052
|
api_instance = TalonOne::ManagementApi.new
|
5053
5053
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5054
|
-
|
5054
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5055
5055
|
|
5056
5056
|
begin
|
5057
5057
|
#Get loyalty card
|
5058
|
-
result = api_instance.get_loyalty_card(loyalty_program_id,
|
5058
|
+
result = api_instance.get_loyalty_card(loyalty_program_id, loyalty_card_id)
|
5059
5059
|
p result
|
5060
5060
|
rescue TalonOne::ApiError => e
|
5061
5061
|
puts "Exception when calling ManagementApi->get_loyalty_card: #{e}"
|
@@ -5068,7 +5068,7 @@ end
|
|
5068
5068
|
Name | Type | Description | Notes
|
5069
5069
|
------------- | ------------- | ------------- | -------------
|
5070
5070
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
5071
|
-
**
|
5071
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
5072
5072
|
|
5073
5073
|
### Return type
|
5074
5074
|
|
@@ -5086,9 +5086,9 @@ Name | Type | Description | Notes
|
|
5086
5086
|
|
5087
5087
|
## get_loyalty_card_transaction_logs
|
5088
5088
|
|
5089
|
-
>
|
5089
|
+
> InlineResponse20014 get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
|
5090
5090
|
|
5091
|
-
|
5091
|
+
List card's transactions
|
5092
5092
|
|
5093
5093
|
Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
5094
5094
|
|
@@ -5112,7 +5112,7 @@ end
|
|
5112
5112
|
|
5113
5113
|
api_instance = TalonOne::ManagementApi.new
|
5114
5114
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
5115
|
-
|
5115
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
5116
5116
|
opts = {
|
5117
5117
|
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
5118
5118
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
@@ -5122,8 +5122,8 @@ opts = {
|
|
5122
5122
|
}
|
5123
5123
|
|
5124
5124
|
begin
|
5125
|
-
#
|
5126
|
-
result = api_instance.get_loyalty_card_transaction_logs(loyalty_program_id,
|
5125
|
+
#List card's transactions
|
5126
|
+
result = api_instance.get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
|
5127
5127
|
p result
|
5128
5128
|
rescue TalonOne::ApiError => e
|
5129
5129
|
puts "Exception when calling ManagementApi->get_loyalty_card_transaction_logs: #{e}"
|
@@ -5136,7 +5136,7 @@ end
|
|
5136
5136
|
Name | Type | Description | Notes
|
5137
5137
|
------------- | ------------- | ------------- | -------------
|
5138
5138
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
5139
|
-
**
|
5139
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
5140
5140
|
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
5141
5141
|
**end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
5142
5142
|
**page_size** | **Integer**| The number of items in this response. | [optional] [default to 1000]
|
@@ -5145,7 +5145,7 @@ Name | Type | Description | Notes
|
|
5145
5145
|
|
5146
5146
|
### Return type
|
5147
5147
|
|
5148
|
-
[**
|
5148
|
+
[**InlineResponse20014**](InlineResponse20014.md)
|
5149
5149
|
|
5150
5150
|
### Authorization
|
5151
5151
|
|
@@ -5159,7 +5159,7 @@ Name | Type | Description | Notes
|
|
5159
5159
|
|
5160
5160
|
## get_loyalty_cards
|
5161
5161
|
|
5162
|
-
>
|
5162
|
+
> InlineResponse20013 get_loyalty_cards(loyalty_program_id, opts)
|
5163
5163
|
|
5164
5164
|
List loyalty cards
|
5165
5165
|
|
@@ -5216,7 +5216,7 @@ Name | Type | Description | Notes
|
|
5216
5216
|
|
5217
5217
|
### Return type
|
5218
5218
|
|
5219
|
-
[**
|
5219
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
5220
5220
|
|
5221
5221
|
### Authorization
|
5222
5222
|
|
@@ -5350,7 +5350,7 @@ Name | Type | Description | Notes
|
|
5350
5350
|
|
5351
5351
|
## get_loyalty_program_transactions
|
5352
5352
|
|
5353
|
-
>
|
5353
|
+
> InlineResponse20012 get_loyalty_program_transactions(loyalty_program_id, opts)
|
5354
5354
|
|
5355
5355
|
List loyalty program transactions
|
5356
5356
|
|
@@ -5409,7 +5409,7 @@ Name | Type | Description | Notes
|
|
5409
5409
|
|
5410
5410
|
### Return type
|
5411
5411
|
|
5412
|
-
[**
|
5412
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
5413
5413
|
|
5414
5414
|
### Authorization
|
5415
5415
|
|
@@ -5423,7 +5423,7 @@ Name | Type | Description | Notes
|
|
5423
5423
|
|
5424
5424
|
## get_loyalty_programs
|
5425
5425
|
|
5426
|
-
>
|
5426
|
+
> InlineResponse20011 get_loyalty_programs
|
5427
5427
|
|
5428
5428
|
List loyalty programs
|
5429
5429
|
|
@@ -5464,7 +5464,7 @@ This endpoint does not need any parameter.
|
|
5464
5464
|
|
5465
5465
|
### Return type
|
5466
5466
|
|
5467
|
-
[**
|
5467
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
5468
5468
|
|
5469
5469
|
### Authorization
|
5470
5470
|
|
@@ -5598,7 +5598,7 @@ Name | Type | Description | Notes
|
|
5598
5598
|
|
5599
5599
|
## get_notification_webhooks
|
5600
5600
|
|
5601
|
-
>
|
5601
|
+
> InlineResponse2005 get_notification_webhooks(application_id)
|
5602
5602
|
|
5603
5603
|
List notifications about campaign-related changes
|
5604
5604
|
|
@@ -5643,7 +5643,7 @@ Name | Type | Description | Notes
|
|
5643
5643
|
|
5644
5644
|
### Return type
|
5645
5645
|
|
5646
|
-
[**
|
5646
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
5647
5647
|
|
5648
5648
|
### Authorization
|
5649
5649
|
|
@@ -5657,7 +5657,7 @@ Name | Type | Description | Notes
|
|
5657
5657
|
|
5658
5658
|
## get_referrals_without_total_count
|
5659
5659
|
|
5660
|
-
>
|
5660
|
+
> InlineResponse2009 get_referrals_without_total_count(application_id, campaign_id, opts)
|
5661
5661
|
|
5662
5662
|
List referrals
|
5663
5663
|
|
@@ -5724,7 +5724,7 @@ Name | Type | Description | Notes
|
|
5724
5724
|
|
5725
5725
|
### Return type
|
5726
5726
|
|
5727
|
-
[**
|
5727
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
5728
5728
|
|
5729
5729
|
### Authorization
|
5730
5730
|
|
@@ -5860,7 +5860,7 @@ Name | Type | Description | Notes
|
|
5860
5860
|
|
5861
5861
|
## get_rulesets
|
5862
5862
|
|
5863
|
-
>
|
5863
|
+
> InlineResponse2006 get_rulesets(application_id, campaign_id, opts)
|
5864
5864
|
|
5865
5865
|
List campaign rulesets
|
5866
5866
|
|
@@ -5915,7 +5915,7 @@ Name | Type | Description | Notes
|
|
5915
5915
|
|
5916
5916
|
### Return type
|
5917
5917
|
|
5918
|
-
[**
|
5918
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
5919
5919
|
|
5920
5920
|
### Authorization
|
5921
5921
|
|
@@ -5988,7 +5988,7 @@ Name | Type | Description | Notes
|
|
5988
5988
|
|
5989
5989
|
## get_users
|
5990
5990
|
|
5991
|
-
>
|
5991
|
+
> InlineResponse20037 get_users(opts)
|
5992
5992
|
|
5993
5993
|
List users in account
|
5994
5994
|
|
@@ -6039,7 +6039,7 @@ Name | Type | Description | Notes
|
|
6039
6039
|
|
6040
6040
|
### Return type
|
6041
6041
|
|
6042
|
-
[**
|
6042
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
6043
6043
|
|
6044
6044
|
### Authorization
|
6045
6045
|
|
@@ -6112,7 +6112,7 @@ Name | Type | Description | Notes
|
|
6112
6112
|
|
6113
6113
|
## get_webhook_activation_logs
|
6114
6114
|
|
6115
|
-
>
|
6115
|
+
> InlineResponse20034 get_webhook_activation_logs(opts)
|
6116
6116
|
|
6117
6117
|
List webhook activation log entries
|
6118
6118
|
|
@@ -6175,7 +6175,7 @@ Name | Type | Description | Notes
|
|
6175
6175
|
|
6176
6176
|
### Return type
|
6177
6177
|
|
6178
|
-
[**
|
6178
|
+
[**InlineResponse20034**](InlineResponse20034.md)
|
6179
6179
|
|
6180
6180
|
### Authorization
|
6181
6181
|
|
@@ -6189,7 +6189,7 @@ Name | Type | Description | Notes
|
|
6189
6189
|
|
6190
6190
|
## get_webhook_logs
|
6191
6191
|
|
6192
|
-
>
|
6192
|
+
> InlineResponse20035 get_webhook_logs(opts)
|
6193
6193
|
|
6194
6194
|
List webhook log entries
|
6195
6195
|
|
@@ -6254,7 +6254,7 @@ Name | Type | Description | Notes
|
|
6254
6254
|
|
6255
6255
|
### Return type
|
6256
6256
|
|
6257
|
-
[**
|
6257
|
+
[**InlineResponse20035**](InlineResponse20035.md)
|
6258
6258
|
|
6259
6259
|
### Authorization
|
6260
6260
|
|
@@ -6268,7 +6268,7 @@ Name | Type | Description | Notes
|
|
6268
6268
|
|
6269
6269
|
## get_webhooks
|
6270
6270
|
|
6271
|
-
>
|
6271
|
+
> InlineResponse20033 get_webhooks(opts)
|
6272
6272
|
|
6273
6273
|
List webhooks
|
6274
6274
|
|
@@ -6321,7 +6321,7 @@ Name | Type | Description | Notes
|
|
6321
6321
|
|
6322
6322
|
### Return type
|
6323
6323
|
|
6324
|
-
[**
|
6324
|
+
[**InlineResponse20033**](InlineResponse20033.md)
|
6325
6325
|
|
6326
6326
|
### Authorization
|
6327
6327
|
|
@@ -6847,7 +6847,7 @@ Name | Type | Description | Notes
|
|
6847
6847
|
|
6848
6848
|
## list_account_collections
|
6849
6849
|
|
6850
|
-
>
|
6850
|
+
> InlineResponse20015 list_account_collections(opts)
|
6851
6851
|
|
6852
6852
|
List collections in account
|
6853
6853
|
|
@@ -6902,7 +6902,7 @@ Name | Type | Description | Notes
|
|
6902
6902
|
|
6903
6903
|
### Return type
|
6904
6904
|
|
6905
|
-
[**
|
6905
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
6906
6906
|
|
6907
6907
|
### Authorization
|
6908
6908
|
|
@@ -6916,7 +6916,7 @@ Name | Type | Description | Notes
|
|
6916
6916
|
|
6917
6917
|
## list_collections
|
6918
6918
|
|
6919
|
-
>
|
6919
|
+
> InlineResponse20017 list_collections(application_id, campaign_id, opts)
|
6920
6920
|
|
6921
6921
|
List collections
|
6922
6922
|
|
@@ -6975,7 +6975,7 @@ Name | Type | Description | Notes
|
|
6975
6975
|
|
6976
6976
|
### Return type
|
6977
6977
|
|
6978
|
-
[**
|
6978
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
6979
6979
|
|
6980
6980
|
### Authorization
|
6981
6981
|
|
@@ -6989,7 +6989,7 @@ Name | Type | Description | Notes
|
|
6989
6989
|
|
6990
6990
|
## list_collections_in_application
|
6991
6991
|
|
6992
|
-
>
|
6992
|
+
> InlineResponse20017 list_collections_in_application(application_id, opts)
|
6993
6993
|
|
6994
6994
|
List collections in application
|
6995
6995
|
|
@@ -7046,7 +7046,7 @@ Name | Type | Description | Notes
|
|
7046
7046
|
|
7047
7047
|
### Return type
|
7048
7048
|
|
7049
|
-
[**
|
7049
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
7050
7050
|
|
7051
7051
|
### Authorization
|
7052
7052
|
|
@@ -7303,7 +7303,7 @@ Name | Type | Description | Notes
|
|
7303
7303
|
|
7304
7304
|
## search_coupons_advanced_application_wide_without_total_count
|
7305
7305
|
|
7306
|
-
>
|
7306
|
+
> InlineResponse2008 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
7307
7307
|
|
7308
7308
|
List coupons that match the given attributes (without total count)
|
7309
7309
|
|
@@ -7378,7 +7378,7 @@ Name | Type | Description | Notes
|
|
7378
7378
|
|
7379
7379
|
### Return type
|
7380
7380
|
|
7381
|
-
[**
|
7381
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
7382
7382
|
|
7383
7383
|
### Authorization
|
7384
7384
|
|
@@ -7392,7 +7392,7 @@ Name | Type | Description | Notes
|
|
7392
7392
|
|
7393
7393
|
## search_coupons_advanced_without_total_count
|
7394
7394
|
|
7395
|
-
>
|
7395
|
+
> InlineResponse2008 search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts)
|
7396
7396
|
|
7397
7397
|
List coupons that match the given attributes in campaign (without total count)
|
7398
7398
|
|
@@ -7467,7 +7467,7 @@ Name | Type | Description | Notes
|
|
7467
7467
|
|
7468
7468
|
### Return type
|
7469
7469
|
|
7470
|
-
[**
|
7470
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
7471
7471
|
|
7472
7472
|
### Authorization
|
7473
7473
|
|
@@ -7481,11 +7481,11 @@ Name | Type | Description | Notes
|
|
7481
7481
|
|
7482
7482
|
## transfer_loyalty_card
|
7483
7483
|
|
7484
|
-
> transfer_loyalty_card(loyalty_program_id,
|
7484
|
+
> transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
7485
7485
|
|
7486
|
-
Transfer
|
7486
|
+
Transfer card data
|
7487
7487
|
|
7488
|
-
Transfer card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
7488
|
+
Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
7489
7489
|
|
7490
7490
|
### Example
|
7491
7491
|
|
@@ -7507,12 +7507,12 @@ end
|
|
7507
7507
|
|
7508
7508
|
api_instance = TalonOne::ManagementApi.new
|
7509
7509
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
7510
|
-
|
7510
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
7511
7511
|
body = TalonOne::TransferLoyaltyCard.new # TransferLoyaltyCard | body
|
7512
7512
|
|
7513
7513
|
begin
|
7514
|
-
#Transfer
|
7515
|
-
api_instance.transfer_loyalty_card(loyalty_program_id,
|
7514
|
+
#Transfer card data
|
7515
|
+
api_instance.transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
7516
7516
|
rescue TalonOne::ApiError => e
|
7517
7517
|
puts "Exception when calling ManagementApi->transfer_loyalty_card: #{e}"
|
7518
7518
|
end
|
@@ -7524,7 +7524,7 @@ end
|
|
7524
7524
|
Name | Type | Description | Notes
|
7525
7525
|
------------- | ------------- | ------------- | -------------
|
7526
7526
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
7527
|
-
**
|
7527
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
7528
7528
|
**body** | [**TransferLoyaltyCard**](TransferLoyaltyCard.md)| body |
|
7529
7529
|
|
7530
7530
|
### Return type
|
@@ -7981,7 +7981,7 @@ nil (empty response body)
|
|
7981
7981
|
|
7982
7982
|
## update_loyalty_card
|
7983
7983
|
|
7984
|
-
> LoyaltyCard update_loyalty_card(loyalty_program_id,
|
7984
|
+
> LoyaltyCard update_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
7985
7985
|
|
7986
7986
|
Update loyalty card status
|
7987
7987
|
|
@@ -8007,12 +8007,12 @@ end
|
|
8007
8007
|
|
8008
8008
|
api_instance = TalonOne::ManagementApi.new
|
8009
8009
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
8010
|
-
|
8010
|
+
loyalty_card_id = 'loyalty_card_id_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
8011
8011
|
body = TalonOne::UpdateLoyaltyCard.new # UpdateLoyaltyCard | body
|
8012
8012
|
|
8013
8013
|
begin
|
8014
8014
|
#Update loyalty card status
|
8015
|
-
result = api_instance.update_loyalty_card(loyalty_program_id,
|
8015
|
+
result = api_instance.update_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
8016
8016
|
p result
|
8017
8017
|
rescue TalonOne::ApiError => e
|
8018
8018
|
puts "Exception when calling ManagementApi->update_loyalty_card: #{e}"
|
@@ -8025,7 +8025,7 @@ end
|
|
8025
8025
|
Name | Type | Description | Notes
|
8026
8026
|
------------- | ------------- | ------------- | -------------
|
8027
8027
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
8028
|
-
**
|
8028
|
+
**loyalty_card_id** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
8029
8029
|
**body** | [**UpdateLoyaltyCard**](UpdateLoyaltyCard.md)| body |
|
8030
8030
|
|
8031
8031
|
### Return type
|