Skip to content

Commit ce6c0d4

Browse files
altJakealtJake
authored
v3.0.0: Reopen session endpoint, loyalty data integration endpoints and loyalty card management endpoints (#30)
## Summary ### Integration API - [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) - [Get customer's loyalty points](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyBalances) - [List customer's loyalty transactions](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions) - [Get card's point balances](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/getLoyaltyCardBalances) - [List card's transactions](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/getLoyaltyCardTransactions) - [Link customer profile to card](https://docs.talon.one/integration-api#tag/Loyalty-cards/operation/linkLoyaltyCardToProfile) ### Management API - [Add points to card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/addLoyaltyCardPoints) - [Deduct points from card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/deductLoyaltyCardPoints) - [Delete loyalty card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/deleteLoyaltyCard) - [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) - [Get loyalty card](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCard) - [Import loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/importLoyaltyCards) - [Transfer card data](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/transferLoyaltyCard) - [Update loyalty card status](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/updateLoyaltyCard) - [List card's transactions](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCardTransactionLogs) - [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) - [Export customer loyalty balances](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalances) -- please note deprecation notice blow - [Export all card transaction logs](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/exportLoyaltyCardBalances) - [Export card's ledger log](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/exportLoyaltyCardLedger) ## ⚠️ Deprecation Notice: Export customer loyalty balance to CSV endpoint Please note that the [Export customer loyalty balance to CSV](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalance) endpoint is getting deprecated, please update your code to point at the new [Export customer loyalty balances](https://docs.talon.one/management-api#tag/Loyalty/operation/exportLoyaltyBalances) ## Commit summary * Initial commit * Update README management api sample to use management keys authorization * update old references to mycompany.talon.one URL
1 parent 5700652 commit ce6c0d4

File tree

1,118 files changed

+41437
-5809
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,118 files changed

+41437
-5809
lines changed

‎README.md

+161-54
Large diffs are not rendered by default.

‎docs/AcceptCouponEffectProps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **String** | The coupon code that was accepted |
7+
**value** | **String** | The coupon code that was accepted. |
88

99
## Code Sample
1010

‎docs/AcceptReferralEffectProps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **String** | The referral code that was accepted |
7+
**value** | **String** | The referral code that was accepted. |
88

99
## Code Sample
1010

‎docs/AccessLogEntry.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**uuid** | **String** | UUID reference of request |
8-
**status** | **Integer** | HTTP status code of response |
9-
**method** | **String** | HTTP method of request |
7+
**uuid** | **String** | UUID reference of request. |
8+
**status** | **Integer** | HTTP status code of response. |
9+
**method** | **String** | HTTP method of request. |
1010
**request_uri** | **String** | target URI of request |
1111
**time** | **DateTime** | timestamp of request |
1212
**request_payload** | **String** | payload of request |
@@ -17,13 +17,18 @@ Name | Type | Description | Notes
1717
```ruby
1818
require 'TalonOne'
1919

20-
instance = TalonOne::AccessLogEntry.new(uuid: null,
21-
status: null,
22-
method: null,
23-
request_uri: null,
24-
time: null,
25-
request_payload: null,
26-
response_payload: null)
20+
instance = TalonOne::AccessLogEntry.new(uuid: 606e7d34-2d36-4d53-ac71-d4442c325985,
21+
status: 200,
22+
method: PUT,
23+
request_uri: /v2/customer_sessions/Session136667,
24+
time: 2023-01-16T16:00:00.700763Z,
25+
request_payload: {
26+
"customerSession": {
27+
"profileId": "customer123",
28+
"state": "closed",
29+
...
30+
},
31+
response_payload: {"coupons":[],"createdCoupons":[],...})
2732
```
2833

2934

‎docs/Account.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**id** | **Integer** | Unique ID for this entity. |
8-
**created** | **DateTime** | The exact moment this entity was created. |
9-
**modified** | **DateTime** | The exact moment this entity was last modified. |
7+
**id** | **Integer** | Internal ID of this entity. |
8+
**created** | **DateTime** | The time this entity was created. |
9+
**modified** | **DateTime** | The time this entity was last modified. |
1010
**company_name** | **String** | |
11-
**domain_name** | **String** | Subdomain Name for yourcompany.talon.one |
12-
**state** | **String** | State of the account (active, deactivated) |
11+
**domain_name** | **String** | Subdomain Name for yourcompany.talon.one. |
12+
**state** | **String** | State of the account (active, deactivated). |
1313
**billing_email** | **String** | The billing email address associated with your company account. |
1414
**plan_name** | **String** | The name of your booked plan. | [optional]
1515
**plan_expires** | **DateTime** | The point in time at which your current plan expires. | [optional]
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
2121
**user_count** | **Integer** | The current number of Campaign Manager Users in your account. |
2222
**campaigns_active_count** | **Integer** | The current number of active Campaigns in your account. |
2323
**campaigns_inactive_count** | **Integer** | The current number of inactive Campaigns in your account. |
24-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
24+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
2525

2626
## Code Sample
2727

‎docs/AccountAdditionalCost.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**id** | **Integer** | Unique ID for this entity. |
8-
**created** | **DateTime** | The exact moment this entity was created. |
7+
**id** | **Integer** | Internal ID of this entity. |
8+
**created** | **DateTime** | The time this entity was created. |
99
**account_id** | **Integer** | The ID of the account that owns this entity. |
10-
**name** | **String** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. |
10+
**name** | **String** | The internal name used in API requests. |
1111
**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. |
1212
**description** | **String** | A description of this additional cost. |
13-
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost | [optional]
14-
**type** | **String** | The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. | [optional] [default to 'session']
13+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
14+
**type** | **String** | The type of additional cost. Possible value: - `session`: Additional cost will be added per session. - `item`: Additional cost will be added per item. - `both`: Additional cost will be added per item and session. | [optional] [default to 'session']
1515

1616
## Code Sample
1717

@@ -21,11 +21,11 @@ require 'TalonOne'
2121
instance = TalonOne::AccountAdditionalCost.new(id: 6,
2222
created: 2020-06-10T09:05:27.993483Z,
2323
account_id: 3886,
24-
name: null,
25-
title: null,
26-
description: null,
27-
subscribed_applications_ids: null,
28-
type: null)
24+
name: shippingFee,
25+
title: Shipping fee,
26+
description: A shipping fee,
27+
subscribed_applications_ids: [3, 13],
28+
type: session)
2929
```
3030

3131

‎docs/AccountAnalytics.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**applications** | **Integer** | Total number of applications in the account |
8-
**live_applications** | **Integer** | Total number of live applications in the account |
9-
**sandbox_applications** | **Integer** | Total number of sandbox applications in the account |
10-
**campaigns** | **Integer** | Total number of campaigns in the account |
11-
**active_campaigns** | **Integer** | Total number of active campaigns in the account |
12-
**live_active_campaigns** | **Integer** | Total number of active campaigns in live applications in the account |
13-
**coupons** | **Integer** | Total number of coupons in the account |
14-
**active_coupons** | **Integer** | Total number of active coupons in the account |
15-
**expired_coupons** | **Integer** | Total number of expired coupons in the account |
16-
**referral_codes** | **Integer** | Total number of referral codes in the account |
17-
**active_referral_codes** | **Integer** | Total number of active referral codes in the account |
18-
**expired_referral_codes** | **Integer** | Total number of expired referral codes in the account |
19-
**active_rules** | **Integer** | Total number of active rules in the account |
20-
**users** | **Integer** | Total number of users in the account |
21-
**roles** | **Integer** | Total number of roles in the account |
22-
**custom_attributes** | **Integer** | Total number of custom attributes in the account |
23-
**webhooks** | **Integer** | Total number of webhooks in the account |
24-
**loyalty_programs** | **Integer** | Total number of all loyalty programs in the account |
25-
**live_loyalty_programs** | **Integer** | Total number of live loyalty programs in the account |
7+
**applications** | **Integer** | Total number of applications in the account. |
8+
**live_applications** | **Integer** | Total number of live applications in the account. |
9+
**sandbox_applications** | **Integer** | Total number of sandbox applications in the account. |
10+
**campaigns** | **Integer** | Total number of campaigns in the account. |
11+
**active_campaigns** | **Integer** | Total number of active campaigns in the account. |
12+
**live_active_campaigns** | **Integer** | Total number of active campaigns in live applications in the account. |
13+
**coupons** | **Integer** | Total number of coupons in the account. |
14+
**active_coupons** | **Integer** | Total number of active coupons in the account. |
15+
**expired_coupons** | **Integer** | Total number of expired coupons in the account. |
16+
**referral_codes** | **Integer** | Total number of referral codes in the account. |
17+
**active_referral_codes** | **Integer** | Total number of active referral codes in the account. |
18+
**expired_referral_codes** | **Integer** | Total number of expired referral codes in the account. |
19+
**active_rules** | **Integer** | Total number of active rules in the account. |
20+
**users** | **Integer** | Total number of users in the account. |
21+
**roles** | **Integer** | Total number of roles in the account. |
22+
**custom_attributes** | **Integer** | Total number of custom attributes in the account. |
23+
**webhooks** | **Integer** | Total number of webhooks in the account. |
24+
**loyalty_programs** | **Integer** | Total number of all loyalty programs in the account. |
25+
**live_loyalty_programs** | **Integer** | Total number of live loyalty programs in the account. |
2626

2727
## Code Sample
2828

‎docs/AccountDashboardStatistic.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# TalonOne::AccountDashboardStatistic
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**revenue** | [**Array<AccountDashboardStatisticRevenue>**](AccountDashboardStatisticRevenue.md) | Aggregated statistic for account revenue. | [optional]
8+
**discounts** | [**Array<AccountDashboardStatisticDiscount>**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional]
9+
**loyalty_points** | [**Array<AccountDashboardStatisticLoyaltyPoints>**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional]
10+
**referrals** | [**Array<AccountDashboardStatisticReferrals>**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional]
11+
**api_calls** | [**Array<AccountDashboardStatisticApiCalls>**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional]
12+
**campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.md) | |
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'TalonOne'
18+
19+
instance = TalonOne::AccountDashboardStatistic.new(revenue: null,
20+
discounts: null,
21+
loyalty_points: null,
22+
referrals: null,
23+
api_calls: null,
24+
campaigns: null)
25+
```
26+
27+

‎docs/AccountDashboardStatisticApiCalls.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# TalonOne::AccountDashboardStatisticApiCalls
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **Float** | Total number of API calls received. |
8+
**datetime** | **DateTime** | Values aggregated for the specified date. |
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'TalonOne'
14+
15+
instance = TalonOne::AccountDashboardStatisticApiCalls.new(total: null,
16+
datetime: null)
17+
```
18+
19+

‎docs/AccountDashboardStatisticCampaigns.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# TalonOne::AccountDashboardStatisticCampaigns
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**live** | **Integer** | Number of campaigns that are active and live (across all Applications). |
8+
**ending_soon** | **Integer** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. |
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'TalonOne'
14+
15+
instance = TalonOne::AccountDashboardStatisticCampaigns.new(live: null,
16+
ending_soon: null)
17+
```
18+
19+

‎docs/AccountDashboardStatisticDiscount.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# TalonOne::AccountDashboardStatisticDiscount
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **Float** | Total discount value redeemed by users. |
8+
**average** | **Float** | Average discount percentage. |
9+
**datetime** | **DateTime** | Values aggregated for the specified date. |
10+
11+
## Code Sample
12+
13+
```ruby
14+
require 'TalonOne'
15+
16+
instance = TalonOne::AccountDashboardStatisticDiscount.new(total: null,
17+
average: null,
18+
datetime: null)
19+
```
20+
21+

‎docs/AccountDashboardStatisticLoyaltyPoints.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# TalonOne::AccountDashboardStatisticLoyaltyPoints
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **Float** | Total loyalty points earned by users. |
8+
**datetime** | **DateTime** | Values aggregated for the specified date. |
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'TalonOne'
14+
15+
instance = TalonOne::AccountDashboardStatisticLoyaltyPoints.new(total: null,
16+
datetime: null)
17+
```
18+
19+

‎docs/AccountDashboardStatisticReferrals.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# TalonOne::AccountDashboardStatisticReferrals
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **Float** | Total number of referrals initiated by users. |
8+
**datetime** | **DateTime** | Values aggregated for the specified date. |
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'TalonOne'
14+
15+
instance = TalonOne::AccountDashboardStatisticReferrals.new(total: null,
16+
datetime: null)
17+
```
18+
19+

‎docs/AccountDashboardStatisticRevenue.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# TalonOne::AccountDashboardStatisticRevenue
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**total** | **Float** | All revenue that went through the client's shop (including purchases that didn’t trigger an effect). |
8+
**influenced** | **Float** | The revenue that was created by a purchase that triggered an effect (excluding web hooks, notifications). |
9+
**datetime** | **DateTime** | Values aggregated for the specified date. |
10+
11+
## Code Sample
12+
13+
```ruby
14+
require 'TalonOne'
15+
16+
instance = TalonOne::AccountDashboardStatisticRevenue.new(total: null,
17+
influenced: null,
18+
datetime: null)
19+
```
20+
21+

‎docs/AccountLimits.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**live_applications** | **Integer** | Total number of allowed live applications in the account |
8-
**sandbox_applications** | **Integer** | Total number of allowed sandbox applications in the account |
9-
**active_campaigns** | **Integer** | Total number of allowed active campaigns in live applications in the account |
10-
**coupons** | **Integer** | Total number of allowed coupons in the account |
11-
**referral_codes** | **Integer** | Total number of allowed referral codes in the account |
12-
**active_rules** | **Integer** | Total number of allowed active rulesets in the account |
13-
**live_loyalty_programs** | **Integer** | Total number of allowed live loyalty programs in the account |
14-
**sandbox_loyalty_programs** | **Integer** | Total number of allowed sandbox loyalty programs in the account |
15-
**webhooks** | **Integer** | Total number of allowed webhooks in the account |
16-
**users** | **Integer** | Total number of allowed users in the account |
17-
**api_volume** | **Integer** | Allowed volume of API requests to the account |
18-
**promotion_types** | **Array<String>** | Array of promotion types that are employed in the account |
7+
**live_applications** | **Integer** | Total number of allowed live applications in the account. |
8+
**sandbox_applications** | **Integer** | Total number of allowed sandbox applications in the account. |
9+
**active_campaigns** | **Integer** | Total number of allowed active campaigns in live applications in the account. |
10+
**coupons** | **Integer** | Total number of allowed coupons in the account. |
11+
**referral_codes** | **Integer** | Total number of allowed referral codes in the account. |
12+
**active_rules** | **Integer** | Total number of allowed active rulesets in the account. |
13+
**live_loyalty_programs** | **Integer** | Total number of allowed live loyalty programs in the account. |
14+
**sandbox_loyalty_programs** | **Integer** | Total number of allowed sandbox loyalty programs in the account. |
15+
**webhooks** | **Integer** | Total number of allowed webhooks in the account. |
16+
**users** | **Integer** | Total number of allowed users in the account. |
17+
**api_volume** | **Integer** | Allowed volume of API requests to the account. |
18+
**promotion_types** | **Array<String>** | Array of promotion types that are employed in the account. |
1919

2020
## Code Sample
2121

‎docs/AddFreeItemEffectProps.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**sku** | **String** | SKU of the item that needs to be added |
8-
**name** | **String** | The name/description of the effect |
7+
**sku** | **String** | SKU of the item that needs to be added. |
8+
**name** | **String** | The name / description of the effect |
99

1010
## Code Sample
1111

‎docs/AddItemCatalogAction.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# TalonOne::AddItemCatalogAction
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**sku** | **String** | The unique SKU of the item to add. |
8+
**price** | **Float** | Price of the item. | [optional]
9+
**attributes** | [**Object**](.md) | The attributes of the item to add. | [optional]
10+
**replace_if_exists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to false]
11+
12+
## Code Sample
13+
14+
```ruby
15+
require 'TalonOne'
16+
17+
instance = TalonOne::AddItemCatalogAction.new(sku: SKU1241028,
18+
price: 99.99,
19+
attributes: {"origin":"germany","color":"blue"},
20+
replace_if_exists: false)
21+
```
22+
23+

0 commit comments

Comments
 (0)