Skip to content

Commit

Permalink
v2.3.0 (#6)
Browse files Browse the repository at this point in the history
 - Expose new _profile inventory endpoint_. Consult our developer docs for more information: https://developers.talon.one/Integration-API/API-Reference#getCustomerInventory
 - Expose more attributes handling endpoints (create, update, get all)
 - `copyCampaignToApplications` endpoint extended and now allows to override original campaign's description scheduling details and tags as part of the copy functionality. See parameters here: https://developers.talon.one/Management-API/API-Reference#copyCampaignToApplications
  • Loading branch information
altJake authored Dec 23, 2019
1 parent 0a81b42 commit dc536b0
Show file tree
Hide file tree
Showing 78 changed files with 3,898 additions and 1,092 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ build/
#!**/packages/repositories.config

# MSTest test Results
[Tt]est[Rr]esult.xml
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The Talon.One API is used to manage applications and campaigns, as well as to in
This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- SDK version: 2.2.0
- SDK version: 2.3.0
- Build package: io.swagger.codegen.languages.CSharpClientCodegen

<a name="frameworks-supported"></a>
Expand All @@ -16,7 +16,7 @@ This C# SDK is automatically generated by the [Swagger Codegen](https://github.c
<a name="dependencies"></a>
## Dependencies
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.6.10 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 10.0.0 or later
- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.6.0 or later

The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
Expand Down Expand Up @@ -185,13 +185,15 @@ Class | Method | HTTP request | Description
*IntegrationApi* | [**CreateReferral**](docs/IntegrationApi.md#createreferral) | **POST** /v1/referrals | Create a referral code for an advocate
*IntegrationApi* | [**DeleteCouponReservation**](docs/IntegrationApi.md#deletecouponreservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
*IntegrationApi* | [**DeleteCustomerData**](docs/IntegrationApi.md#deletecustomerdata) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
*IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
*IntegrationApi* | [**GetReservedCoupons**](docs/IntegrationApi.md#getreservedcoupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
*IntegrationApi* | [**GetReservedCustomers**](docs/IntegrationApi.md#getreservedcustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
*IntegrationApi* | [**TrackEvent**](docs/IntegrationApi.md#trackevent) | **POST** /v1/events | Track an Event
*IntegrationApi* | [**UpdateCustomerProfile**](docs/IntegrationApi.md#updatecustomerprofile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
*IntegrationApi* | [**UpdateCustomerSession**](docs/IntegrationApi.md#updatecustomersession) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
*ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
*ManagementApi* | [**CopyCampaignToApplications**](docs/ManagementApi.md#copycampaigntoapplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
*ManagementApi* | [**CreateAttribute**](docs/ManagementApi.md#createattribute) | **POST** /v1/attributes | Define a new custom attribute
*ManagementApi* | [**CreateCampaign**](docs/ManagementApi.md#createcampaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
*ManagementApi* | [**CreateCoupons**](docs/ManagementApi.md#createcoupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
*ManagementApi* | [**CreatePasswordRecoveryEmail**](docs/ManagementApi.md#createpasswordrecoveryemail) | **POST** /v1/password_recovery_emails | Request a password reset
Expand All @@ -206,7 +208,6 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**GetAccessLogsWithoutTotalCount**](docs/ManagementApi.md#getaccesslogswithouttotalcount) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
*ManagementApi* | [**GetAccount**](docs/ManagementApi.md#getaccount) | **GET** /v1/accounts/{accountId} | Get Account Details
*ManagementApi* | [**GetAccountAnalytics**](docs/ManagementApi.md#getaccountanalytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
*ManagementApi* | [**GetAccountLimits**](docs/ManagementApi.md#getaccountlimits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
*ManagementApi* | [**GetAllAccessLogs**](docs/ManagementApi.md#getallaccesslogs) | **GET** /v1/access_logs | Get all access logs
*ManagementApi* | [**GetAllRoles**](docs/ManagementApi.md#getallroles) | **GET** /v1/roles | Get all roles.
*ManagementApi* | [**GetApplication**](docs/ManagementApi.md#getapplication) | **GET** /v1/applications/{applicationId} | Get Application
Expand All @@ -221,6 +222,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**GetApplicationSessions**](docs/ManagementApi.md#getapplicationsessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
*ManagementApi* | [**GetApplications**](docs/ManagementApi.md#getapplications) | **GET** /v1/applications | List Applications
*ManagementApi* | [**GetAttribute**](docs/ManagementApi.md#getattribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
*ManagementApi* | [**GetAttributes**](docs/ManagementApi.md#getattributes) | **GET** /v1/attributes | List custom attributes
*ManagementApi* | [**GetCampaign**](docs/ManagementApi.md#getcampaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
*ManagementApi* | [**GetCampaignAnalytics**](docs/ManagementApi.md#getcampaignanalytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
*ManagementApi* | [**GetCampaignByAttributes**](docs/ManagementApi.md#getcampaignbyattributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
Expand Down Expand Up @@ -262,7 +264,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**SearchCouponsAdvancedApplicationWide**](docs/ManagementApi.md#searchcouponsadvancedapplicationwide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
*ManagementApi* | [**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedapplicationwidewithouttotalcount) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
*ManagementApi* | [**SearchCouponsAdvancedWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedwithouttotalcount) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
*ManagementApi* | [**SetAccountLimits**](docs/ManagementApi.md#setaccountlimits) | **PUT** /v1/accounts/{accountId}/limits | Set account limits
*ManagementApi* | [**UpdateAttribute**](docs/ManagementApi.md#updateattribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
*ManagementApi* | [**UpdateCampaign**](docs/ManagementApi.md#updatecampaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
*ManagementApi* | [**UpdateCampaignSet**](docs/ManagementApi.md#updatecampaignset) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
*ManagementApi* | [**UpdateCoupon**](docs/ManagementApi.md#updatecoupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
Expand Down Expand Up @@ -291,6 +293,9 @@ Class | Method | HTTP request | Description
- [Model.ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
- [Model.Attribute](docs/Attribute.md)
- [Model.AttributeQuery](docs/AttributeQuery.md)
- [Model.AttributesMandatory](docs/AttributesMandatory.md)
- [Model.AttributesSettings](docs/AttributesSettings.md)
- [Model.BaseSamlConnection](docs/BaseSamlConnection.md)
- [Model.Binding](docs/Binding.md)
- [Model.Campaign](docs/Campaign.md)
- [Model.CampaignAnalytics](docs/CampaignAnalytics.md)
Expand All @@ -314,6 +319,7 @@ Class | Method | HTTP request | Description
- [Model.CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
- [Model.CustomerActivityReport](docs/CustomerActivityReport.md)
- [Model.CustomerAnalytics](docs/CustomerAnalytics.md)
- [Model.CustomerInventory](docs/CustomerInventory.md)
- [Model.CustomerProfile](docs/CustomerProfile.md)
- [Model.CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
- [Model.CustomerSession](docs/CustomerSession.md)
Expand Down Expand Up @@ -354,6 +360,7 @@ Class | Method | HTTP request | Description
- [Model.InlineResponse20026](docs/InlineResponse20026.md)
- [Model.InlineResponse20027](docs/InlineResponse20027.md)
- [Model.InlineResponse20028](docs/InlineResponse20028.md)
- [Model.InlineResponse20029](docs/InlineResponse20029.md)
- [Model.InlineResponse2003](docs/InlineResponse2003.md)
- [Model.InlineResponse2004](docs/InlineResponse2004.md)
- [Model.InlineResponse2005](docs/InlineResponse2005.md)
Expand Down Expand Up @@ -419,6 +426,7 @@ Class | Method | HTTP request | Description
- [Model.Rule](docs/Rule.md)
- [Model.Ruleset](docs/Ruleset.md)
- [Model.SamlConnection](docs/SamlConnection.md)
- [Model.SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
- [Model.Session](docs/Session.md)
- [Model.SlotDef](docs/SlotDef.md)
- [Model.TemplateArgDef](docs/TemplateArgDef.md)
Expand Down
1 change: 1 addition & 0 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Name | Type | Description | Notes
**Roles** | **int?** | Total Number of roles inside the account |
**Webhooks** | **int?** | Total Number of webhooks inside the account |
**LoyaltyPrograms** | **int?** | Total Number of loyalty programs inside the account |
**ActiveRules** | **int?** | Total Number of active rules in the account |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

1 change: 1 addition & 0 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**Webhooks** | **int?** | Total Number of allowed webhooks in the account |
**Users** | **int?** | Total Number of allowed users in the account |
**ApiVolume** | **int?** | Total allowed api volume |
**ActiveRules** | **int?** | Total allowed active rulesets | [optional]
**PromotionTypes** | **List&lt;string&gt;** | array of rulesets where webhook is used |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**CaseSensitivity** | **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
**Attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
**Limits** | [**List&lt;LimitConfig&gt;**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
**AttributesSettings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
**Key** | **string** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
**LoyaltyPrograms** | [**List&lt;LoyaltyProgram&gt;**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |

Expand Down
10 changes: 10 additions & 0 deletions docs/AttributesMandatory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.Model.AttributesMandatory
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Campaigns** | **List&lt;string&gt;** | List of mandatory attributes for campaigns. | [optional]
**Coupons** | **List&lt;string&gt;** | List of mandatory attributes for campaigns. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions docs/AttributesSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TalonOne.Model.AttributesSettings
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Mandatory** | [**AttributesMandatory**](AttributesMandatory.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16 changes: 16 additions & 0 deletions docs/BaseSamlConnection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# TalonOne.Model.BaseSamlConnection
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **int?** | The ID of the account that owns this entity. |
**Name** | **string** | ID of the SAML service. |
**Enabled** | **bool?** | Determines if this SAML connection active. |
**Issuer** | **string** | Identity Provider Entity ID. |
**SignOnURL** | **string** | Single Sign-On URL. |
**SignOutURL** | **string** | Single Sign-Out URL. | [optional]
**MetadataURL** | **string** | Metadata URL. | [optional]
**AudienceURI** | **string** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12 changes: 9 additions & 3 deletions docs/CampaignAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Date** | **DateTime?** | |
**CampaignRevenue** | **decimal?** | Amount of revenue in this campaign. |
**TotalCampaignRevenue** | **decimal?** | Amount of revenue in this campaign since it began. |
**CampaignRevenue** | **decimal?** | Amount of revenue in this campaign (for coupon or discount sessions). |
**TotalCampaignRevenue** | **decimal?** | Amount of revenue in this campaign since it began (for coupon or discount sessions). |
**CampaignRefund** | **decimal?** | Amount of refunds in this campaign (for coupon or discount sessions). |
**TotalCampaignRefund** | **decimal?** | Amount of refunds in this campaign since it began (for coupon or discount sessions). |
**CampaignDiscountCosts** | **decimal?** | Amount of cost caused by discounts given in the campaign. |
**TotalCampaignDiscountCosts** | **decimal?** | Amount of cost caused by discounts given in the campaign since it began. |
**CampaignRefundedDiscounts** | **decimal?** | Amount of discounts rolledback due to refund in the campaign. |
**TotalCampaignRefundedDiscounts** | **decimal?** | Amount of discounts rolledback due to refund in the campaign since it began. |
**CampaignFreeItems** | **int?** | Amount of free items given in the campaign. |
**TotalCampaignFreeItems** | **int?** | Amount of free items given in the campaign since it began. |
**CouponRedemptions** | **int?** | Number of coupon redemptions in the campaign (only accepted referrals on sessions that were closed are considered). |
**CouponRedemptions** | **int?** | Number of coupon redemptions in the campaign. |
**TotalCouponRedemptions** | **int?** | Number of coupon redemptions in the campaign since it began. |
**CouponRolledbackRedemptions** | **int?** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
**TotalCouponRolledbackRedemptions** | **int?** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
**ReferralRedemptions** | **int?** | Number of referral redemptions in the campaign. |
**TotalReferralRedemptions** | **int?** | Number of referral redemptions in the campaign since it began. |
**CouponsCreated** | **int?** | Number of coupons created in the campaign by the rule engine. |
Expand Down
4 changes: 4 additions & 0 deletions docs/CampaignCopy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | Name of the copied campaign (Defaults to \&quot;Copy of original campaign name\&quot;) | [optional]
**ApplicationIds** | **List&lt;string&gt;** | Application IDs of the applications to which a campaign should be copied to |
**Description** | **string** | A detailed description of the campaign. | [optional]
**StartTime** | **DateTime?** | Datetime when the campaign will become active. | [optional]
**EndTime** | **DateTime?** | Datetime when the campaign will become in-active. | [optional]
**Tags** | **List&lt;string&gt;** | A list of tags for the campaign. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

4 changes: 2 additions & 2 deletions docs/Change.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Name | Type | Description | Notes
**Created** | **DateTime?** | The exact moment this entity was created. |
**UserId** | **int?** | The ID of the account that owns this entity. |
**Entity** | **string** | API endpoint on which the change was initiated. |
**Old** | **Object** | Resource before the change occured. | [optional]
**New** | **Object** | Resource after the change occured. | [optional]
**Old** | **Object** | Resource before the change occurred. | [optional]
**New** | **Object** | Resource after the change occurred. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/CustomerInventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.Model.CustomerInventory
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
**Referrals** | [**List&lt;Referral&gt;**](Referral.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/InlineResponse20020.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TotalResultSize** | **int?** | |
**Data** | [**List&lt;Webhook&gt;**](Webhook.md) | |
**Data** | [**List&lt;Attribute&gt;**](Attribute.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/InlineResponse20021.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TotalResultSize** | **int?** | |
**Data** | [**List&lt;WebhookActivationLogEntry&gt;**](WebhookActivationLogEntry.md) | |
**Data** | [**List&lt;Webhook&gt;**](Webhook.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/InlineResponse20022.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TotalResultSize** | **int?** | |
**Data** | [**List&lt;WebhookLogEntry&gt;**](WebhookLogEntry.md) | |
**Data** | [**List&lt;WebhookActivationLogEntry&gt;**](WebhookActivationLogEntry.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/InlineResponse20023.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TotalResultSize** | **int?** | |
**Data** | [**List&lt;EventType&gt;**](EventType.md) | |
**Data** | [**List&lt;WebhookLogEntry&gt;**](WebhookLogEntry.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading

0 comments on commit dc536b0

Please sign in to comment.