Skip to content

Commit b3d14bd

Browse files
altJakealtJake
authored
v5.0.0: Reopen session endpoint, loyalty data integration endpoints and loyalty card management endpoints (#33)
## 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 * Nullable-attributes support in new classes * revert accidental deletions in 2 new model classes * Update readme mgmt api sample to use management api key
1 parent ba8e67a commit b3d14bd

File tree

1,108 files changed

+59175
-19027
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,108 files changed

+59175
-19027
lines changed

‎README.md‎

Lines changed: 159 additions & 48 deletions
Large diffs are not rendered by default.

‎api/openapi.yaml‎

Lines changed: 14260 additions & 8837 deletions
Large diffs are not rendered by default.

‎build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
33
apply plugin: 'java'
44

55
group = 'one.talon'
6-
version = '4.5.1'
6+
version = '5.0.0'
77

88
buildscript {
99
repositories {

‎build.sbt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "one.talon",
44
name := "talon-one-client",
5-
version := "4.5.1",
5+
version := "5.0.0",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

‎docs/AcceptCouponEffectProps.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The properties specific to the \"acceptCoupon\" effect. This gets triggered when
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**value** | **String** | The coupon code that was accepted |
10+
**value** | **String** | The coupon code that was accepted. |
1111

1212

1313

‎docs/AcceptReferralEffectProps.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The properties specific to the \"acceptReferral\" effect. TThis gets triggered w
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**value** | **String** | The referral code that was accepted |
10+
**value** | **String** | The referral code that was accepted. |
1111

1212

1313

‎docs/AccessLogEntry.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
# AccessLogEntry
44

5-
Log of application accesses
5+
Log of application accesses.
66
## Properties
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**uuid** | **String** | UUID reference of request |
11-
**status** | **Integer** | HTTP status code of response |
12-
**method** | **String** | HTTP method of request |
10+
**uuid** | **String** | UUID reference of request. |
11+
**status** | **Integer** | HTTP status code of response. |
12+
**method** | **String** | HTTP method of request. |
1313
**requestUri** | **String** | target URI of request |
1414
**time** | [**OffsetDateTime**](OffsetDateTime.md) | timestamp of request |
1515
**requestPayload** | **String** | payload of request |

‎docs/Account.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**id** | **Integer** | Unique ID for this entity. |
11-
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. |
12-
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was last modified. |
10+
**id** | **Integer** | Internal ID of this entity. |
11+
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
12+
**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was last modified. |
1313
**companyName** | **String** | |
14-
**domainName** | **String** | Subdomain Name for yourcompany.talon.one |
15-
**state** | [**StateEnum**](#StateEnum) | State of the account (active, deactivated) |
14+
**domainName** | **String** | Subdomain Name for yourcompany.talon.one. |
15+
**state** | [**StateEnum**](#StateEnum) | State of the account (active, deactivated). |
1616
**billingEmail** | **String** | The billing email address associated with your company account. |
1717
**planName** | **String** | The name of your booked plan. | [optional]
1818
**planExpires** | [**OffsetDateTime**](OffsetDateTime.md) | The point in time at which your current plan expires. | [optional]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
2424
**userCount** | **Integer** | The current number of Campaign Manager Users in your account. |
2525
**campaignsActiveCount** | **Integer** | The current number of active Campaigns in your account. |
2626
**campaignsInactiveCount** | **Integer** | The current number of inactive Campaigns in your account. |
27-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
27+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
2828

2929

3030

‎docs/AccountAdditionalCost.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**id** | **Integer** | Unique ID for this entity. |
11-
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The exact moment this entity was created. |
10+
**id** | **Integer** | Internal ID of this entity. |
11+
**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. |
1212
**accountId** | **Integer** | The ID of the account that owns this entity. |
13-
**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. |
13+
**name** | **String** | The internal name used in API requests. |
1414
**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. |
1515
**description** | **String** | A description of this additional cost. |
16-
**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost | [optional]
17-
**type** | [**TypeEnum**](#TypeEnum) | 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]
16+
**subscribedApplicationsIds** | **List<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
17+
**type** | [**TypeEnum**](#TypeEnum) | 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]
1818

1919

2020

‎docs/AccountAnalytics.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**applications** | **Integer** | Total number of applications in the account |
10-
**liveApplications** | **Integer** | Total number of live applications in the account |
11-
**sandboxApplications** | **Integer** | Total number of sandbox applications in the account |
12-
**campaigns** | **Integer** | Total number of campaigns in the account |
13-
**activeCampaigns** | **Integer** | Total number of active campaigns in the account |
14-
**liveActiveCampaigns** | **Integer** | Total number of active campaigns in live applications in the account |
15-
**coupons** | **Integer** | Total number of coupons in the account |
16-
**activeCoupons** | **Integer** | Total number of active coupons in the account |
17-
**expiredCoupons** | **Integer** | Total number of expired coupons in the account |
18-
**referralCodes** | **Integer** | Total number of referral codes in the account |
19-
**activeReferralCodes** | **Integer** | Total number of active referral codes in the account |
20-
**expiredReferralCodes** | **Integer** | Total number of expired referral codes in the account |
21-
**activeRules** | **Integer** | Total number of active rules in the account |
22-
**users** | **Integer** | Total number of users in the account |
23-
**roles** | **Integer** | Total number of roles in the account |
24-
**customAttributes** | **Integer** | Total number of custom attributes in the account |
25-
**webhooks** | **Integer** | Total number of webhooks in the account |
26-
**loyaltyPrograms** | **Integer** | Total number of all loyalty programs in the account |
27-
**liveLoyaltyPrograms** | **Integer** | Total number of live loyalty programs in the account |
9+
**applications** | **Integer** | Total number of applications in the account. |
10+
**liveApplications** | **Integer** | Total number of live applications in the account. |
11+
**sandboxApplications** | **Integer** | Total number of sandbox applications in the account. |
12+
**campaigns** | **Integer** | Total number of campaigns in the account. |
13+
**activeCampaigns** | **Integer** | Total number of active campaigns in the account. |
14+
**liveActiveCampaigns** | **Integer** | Total number of active campaigns in live applications in the account. |
15+
**coupons** | **Integer** | Total number of coupons in the account. |
16+
**activeCoupons** | **Integer** | Total number of active coupons in the account. |
17+
**expiredCoupons** | **Integer** | Total number of expired coupons in the account. |
18+
**referralCodes** | **Integer** | Total number of referral codes in the account. |
19+
**activeReferralCodes** | **Integer** | Total number of active referral codes in the account. |
20+
**expiredReferralCodes** | **Integer** | Total number of expired referral codes in the account. |
21+
**activeRules** | **Integer** | Total number of active rules in the account. |
22+
**users** | **Integer** | Total number of users in the account. |
23+
**roles** | **Integer** | Total number of roles in the account. |
24+
**customAttributes** | **Integer** | Total number of custom attributes in the account. |
25+
**webhooks** | **Integer** | Total number of webhooks in the account. |
26+
**loyaltyPrograms** | **Integer** | Total number of all loyalty programs in the account. |
27+
**liveLoyaltyPrograms** | **Integer** | Total number of live loyalty programs in the account. |
2828

2929

3030

0 commit comments

Comments
 (0)