Skip to content

Commit

Permalink
v4.6.0: Collection Items, Catalog Sync, Effects in getCustomerSession…
Browse files Browse the repository at this point in the history
… & Loyalty Transactions retrieval (#28)

## v4.6.0

## Commit Summary
 * Initial Commit
 * Fix mistype for loyalty transactions
  • Loading branch information
altJake committed Aug 16, 2022
1 parent 17a98ee commit 1479aad
Show file tree
Hide file tree
Showing 637 changed files with 10,505 additions and 2,440 deletions.
75 changes: 57 additions & 18 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/AcceptCouponEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **String** | The coupon code that was accepted |
**value** | **String** | The coupon code that was accepted. |


2 changes: 1 addition & 1 deletion docs/AcceptReferralEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **String** | The referral code that was accepted |
**value** | **String** | The referral code that was accepted. |


6 changes: 3 additions & 3 deletions docs/AccessLogEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **String** | UUID reference of request |
**status** | **Number** | HTTP status code of response |
**method** | **String** | HTTP method of request |
**uuid** | **String** | UUID reference of request. |
**status** | **Number** | HTTP status code of response. |
**method** | **String** | HTTP method of request. |
**requestUri** | **String** | target URI of request |
**time** | **Date** | timestamp of request |
**requestPayload** | **String** | payload of request |
Expand Down
8 changes: 4 additions & 4 deletions docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
**created** | **Date** | The exact moment this entity was created. |
**modified** | **Date** | The exact moment this entity was last modified. |
**companyName** | **String** | |
**domainName** | **String** | Subdomain Name for yourcompany.talon.one |
**state** | **String** | State of the account (active, deactivated) |
**domainName** | **String** | Subdomain Name for yourcompany.talon.one. |
**state** | **String** | State of the account (active, deactivated). |
**billingEmail** | **String** | The billing email address associated with your company account. |
**planName** | **String** | The name of your booked plan. | [optional]
**planExpires** | **Date** | The point in time at which your current plan expires. | [optional]
Expand All @@ -21,7 +21,7 @@ Name | Type | Description | Notes
**userCount** | **Number** | The current number of Campaign Manager Users in your account. |
**campaignsActiveCount** | **Number** | The current number of active Campaigns in your account. |
**campaignsInactiveCount** | **Number** | The current number of inactive Campaigns in your account. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]



Expand Down
4 changes: 2 additions & 2 deletions docs/AccountAdditionalCost.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
**created** | **Date** | The exact moment this entity was created. |
**accountId** | **Number** | The ID of the account that owns this entity. |
**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. |
**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. |
**description** | **String** | A description of this additional cost. |
**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that are subscribed to this additional cost | [optional]
**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
**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']


Expand Down
38 changes: 19 additions & 19 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**applications** | **Number** | Total number of applications in the account |
**liveApplications** | **Number** | Total number of live applications in the account |
**sandboxApplications** | **Number** | Total number of sandbox applications in the account |
**campaigns** | **Number** | Total number of campaigns in the account |
**activeCampaigns** | **Number** | Total number of active campaigns in the account |
**liveActiveCampaigns** | **Number** | Total number of active campaigns in live applications in the account |
**coupons** | **Number** | Total number of coupons in the account |
**activeCoupons** | **Number** | Total number of active coupons in the account |
**expiredCoupons** | **Number** | Total number of expired coupons in the account |
**referralCodes** | **Number** | Total number of referral codes in the account |
**activeReferralCodes** | **Number** | Total number of active referral codes in the account |
**expiredReferralCodes** | **Number** | Total number of expired referral codes in the account |
**activeRules** | **Number** | Total number of active rules in the account |
**users** | **Number** | Total number of users in the account |
**roles** | **Number** | Total number of roles in the account |
**customAttributes** | **Number** | Total number of custom attributes in the account |
**webhooks** | **Number** | Total number of webhooks in the account |
**loyaltyPrograms** | **Number** | Total number of all loyalty programs in the account |
**liveLoyaltyPrograms** | **Number** | Total number of live loyalty programs in the account |
**applications** | **Number** | Total number of applications in the account. |
**liveApplications** | **Number** | Total number of live applications in the account. |
**sandboxApplications** | **Number** | Total number of sandbox applications in the account. |
**campaigns** | **Number** | Total number of campaigns in the account. |
**activeCampaigns** | **Number** | Total number of active campaigns in the account. |
**liveActiveCampaigns** | **Number** | Total number of active campaigns in live applications in the account. |
**coupons** | **Number** | Total number of coupons in the account. |
**activeCoupons** | **Number** | Total number of active coupons in the account. |
**expiredCoupons** | **Number** | Total number of expired coupons in the account. |
**referralCodes** | **Number** | Total number of referral codes in the account. |
**activeReferralCodes** | **Number** | Total number of active referral codes in the account. |
**expiredReferralCodes** | **Number** | Total number of expired referral codes in the account. |
**activeRules** | **Number** | Total number of active rules in the account. |
**users** | **Number** | Total number of users in the account. |
**roles** | **Number** | Total number of roles in the account. |
**customAttributes** | **Number** | Total number of custom attributes in the account. |
**webhooks** | **Number** | Total number of webhooks in the account. |
**loyaltyPrograms** | **Number** | Total number of all loyalty programs in the account. |
**liveLoyaltyPrograms** | **Number** | Total number of live loyalty programs in the account. |


24 changes: 12 additions & 12 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**liveApplications** | **Number** | Total number of allowed live applications in the account |
**sandboxApplications** | **Number** | Total number of allowed sandbox applications in the account |
**activeCampaigns** | **Number** | Total number of allowed active campaigns in live applications in the account |
**coupons** | **Number** | Total number of allowed coupons in the account |
**referralCodes** | **Number** | Total number of allowed referral codes in the account |
**activeRules** | **Number** | Total number of allowed active rulesets in the account |
**liveLoyaltyPrograms** | **Number** | Total number of allowed live loyalty programs in the account |
**sandboxLoyaltyPrograms** | **Number** | Total number of allowed sandbox loyalty programs in the account |
**webhooks** | **Number** | Total number of allowed webhooks in the account |
**users** | **Number** | Total number of allowed users in the account |
**apiVolume** | **Number** | Allowed volume of API requests to the account |
**promotionTypes** | **[String]** | Array of promotion types that are employed in the account |
**liveApplications** | **Number** | Total number of allowed live applications in the account. |
**sandboxApplications** | **Number** | Total number of allowed sandbox applications in the account. |
**activeCampaigns** | **Number** | Total number of allowed active campaigns in live applications in the account. |
**coupons** | **Number** | Total number of allowed coupons in the account. |
**referralCodes** | **Number** | Total number of allowed referral codes in the account. |
**activeRules** | **Number** | Total number of allowed active rulesets in the account. |
**liveLoyaltyPrograms** | **Number** | Total number of allowed live loyalty programs in the account. |
**sandboxLoyaltyPrograms** | **Number** | Total number of allowed sandbox loyalty programs in the account. |
**webhooks** | **Number** | Total number of allowed webhooks in the account. |
**users** | **Number** | Total number of allowed users in the account. |
**apiVolume** | **Number** | Allowed volume of API requests to the account. |
**promotionTypes** | **[String]** | Array of promotion types that are employed in the account. |


4 changes: 2 additions & 2 deletions docs/AddFreeItemEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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


12 changes: 12 additions & 0 deletions docs/AddItemCatalogAction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# TalonOne.AddItemCatalogAction

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sku** | **String** | The unique SKU of the item to add. |
**price** | **Number** | Price of the item. | [optional]
**attributes** | [**Object**](.md) | The attributes of the item to add. | [optional]
**replaceIfExists** | **Boolean** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to false]


2 changes: 1 addition & 1 deletion docs/AddLoyaltyPointsEffectProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name/description of this loyalty point addition. |
**name** | **String** | The reason of the point addition. |
**programId** | **Number** | The ID of the loyalty program where these points were added. |
**subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added. |
**value** | **Number** | The amount of points that were added. |
Expand Down
4 changes: 2 additions & 2 deletions docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
**created** | **Date** | The exact moment this entity was created. |
**modified** | **Date** | The exact moment this entity was last modified. |
**accountId** | **Number** | The ID of the account that owns this entity. |
Expand All @@ -24,7 +24,7 @@ Name | Type | Description | Notes
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
**enablePartialDiscounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
**defaultDiscountAdditionalCostPerItemScope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
**loyaltyPrograms** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |
**loyaltyPrograms** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. |



Expand Down
16 changes: 9 additions & 7 deletions docs/ApplicationAPIKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Title for API Key |
**expires** | **Date** | The date the API key expired |
**title** | **String** | Title for API Key. |
**expires** | **Date** | The date the API key expired. |
**platform** | **String** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
**id** | **Number** | ID of the API Key |
**createdBy** | **Number** | ID of user who created |
**accountID** | **Number** | ID of account the key is used for |
**applicationID** | **Number** | ID of application the key is used for |
**created** | **Date** | The date the API key was created |
**id** | **Number** | ID of the API Key. |
**createdBy** | **Number** | ID of user who created. |
**accountID** | **Number** | ID of account the key is used for. |
**applicationID** | **Number** | ID of application the key is used for. |
**created** | **Date** | The date the API key was created. |



Expand All @@ -34,6 +34,8 @@ Name | Type | Description | Notes

* `customer_data` (value: `"customer_data"`)

* `salesforce` (value: `"salesforce"`)




4 changes: 2 additions & 2 deletions docs/ApplicationApiHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**summary** | **String** | One-word summary of the health of the API connection of an application |
**lastUsed** | **Date** | time of last request relevant to the API health test |
**summary** | **String** | One-word summary of the health of the API connection of an application. |
**lastUsed** | **Date** | time of last request relevant to the API health test. |



Expand Down
12 changes: 6 additions & 6 deletions docs/ApplicationCampaignStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**draft** | **Number** | Number of draft campaigns |
**disabled** | **Number** | Number of disabled campaigns |
**scheduled** | **Number** | Number of scheduled campaigns |
**running** | **Number** | Number of running campaigns |
**expired** | **Number** | Number of expired campaigns |
**archived** | **Number** | Number of archived campaigns |
**draft** | **Number** | Number of draft campaigns. |
**disabled** | **Number** | Number of disabled campaigns. |
**scheduled** | **Number** | Number of scheduled campaigns. |
**running** | **Number** | Number of running campaigns. |
**expired** | **Number** | Number of expired campaigns. |
**archived** | **Number** | Number of archived campaigns. |


10 changes: 5 additions & 5 deletions docs/ApplicationCustomer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. Unique ID for this entity. |
**id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
**created** | **Date** | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. |
**integrationId** | **String** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item |
**integrationId** | **String** | The integration ID set by your integration layer. The integration ID set by your integration layer. |
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
**accountId** | **Number** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. |
**closedSessions** | **Number** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
**totalSales** | **Number** | Sum of all purchases made by this customer |
**totalSales** | **Number** | Sum of all purchases made by this customer. |
**loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
**audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional]
**audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | A list of audiences the customer belongs to. | [optional]
**lastActivity** | **Date** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. |
**advocateIntegrationId** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**id** | **Number** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
**created** | **Date** | The exact moment this entity was created. |
**applicationId** | **Number** | The ID of the application that owns this entity. |
**profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
Expand Down
8 changes: 4 additions & 4 deletions docs/ApplicationReferee.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**applicationId** | **Number** | The ID of the application that owns this entity. |
**sessionId** | **String** | Integration ID of the session in which the customer redeemed the referral |
**advocateIntegrationId** | **String** | Integration ID of the Advocate's Profile |
**friendIntegrationId** | **String** | Integration ID of the Friend's Profile |
**sessionId** | **String** | Integration ID of the session in which the customer redeemed the referral. |
**advocateIntegrationId** | **String** | Integration ID of the Advocate's Profile. |
**friendIntegrationId** | **String** | Integration ID of the Friend's Profile. |
**code** | **String** | Advocate's referral code. |
**created** | **Date** | Timestamp of the moment the customer redeemed the referral |
**created** | **Date** | Timestamp of the moment the customer redeemed the referral. |


Loading

0 comments on commit 1479aad

Please sign in to comment.