Skip to content

Commit

Permalink
v3.0.0: Integration API V2 (#7)
Browse files Browse the repository at this point in the history
 - Replace code generator to [OpenAPITools [email protected]](https://github.com/OpenAPITools/openapi-generator/releases/tag/v4.2.3)
 - Add our new v2 integration api endpoint for customer sessions. Read more here: https://developers.talon.one/Getting-Started/APIV2
 - Add v2-related management endpoints for managing [AdditionalCosts](https://developers.talon.one/Getting-Started/APIV2#additional-costs)

Commit Summary
=============
* Initial Commit
* Update nunit version -> 3.11.0
* Align mono_unit_test script
* Add APIv2 code example to README
* Fix nuspec file's icon --> iconUrl tag
* Add icon.png
* Skip symbols generation for now
  • Loading branch information
altJake authored Apr 20, 2020
1 parent dad6c7b commit 42275b9
Show file tree
Hide file tree
Showing 628 changed files with 19,495 additions and 6,400 deletions.
6 changes: 3 additions & 3 deletions .swagger-codegen-ignore → .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
Expand Down
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4.2.3
1 change: 0 additions & 1 deletion .swagger-codegen/VERSION

This file was deleted.

2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Generated by: https://github.com/swagger-api/swagger-codegen.git
# Generated by: https://github.com/openapitools/openapi-generator.git
#
language: csharp
mono:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Talon.One GmbH
Copyright (c) 2020 Talon.One GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ endif
-v $(PWD):/tmp/talon-client \
-w "/tmp/talon-client/$(BUILD_DIR)" \
mono:6 \
nuget pack TalonOne.csproj -Build -Symbols -SymbolPackageFormat snupkg -Properties Configuration=Release -Version $(VERSION)
nuget pack TalonOne.csproj -Build -Properties Configuration=Release -Version $(VERSION)

publish: clean
ifeq ($(VERSION),)
Expand All @@ -31,7 +31,7 @@ endif
-v $(PWD):/tmp/talon-client \
-w "/tmp/talon-client/$(BUILD_DIR)" \
mono:6 \
/bin/bash -c "nuget pack TalonOne.csproj -Build -Symbols -SymbolPackageFormat snupkg -Properties Configuration=Release -Version $(VERSION) && \
/bin/bash -c "nuget pack TalonOne.csproj -Build -Properties Configuration=Release -Version $(VERSION) && \
nuget push TalonOne.$(VERSION).nupkg $(apiKey) -Source https://api.nuget.org/v3/index.json"

testenv:
Expand Down
220 changes: 192 additions & 28 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.bat
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:: Generated by: https://github.com/swagger-api/swagger-codegen.git
:: Generated by: https://github.com/openapitools/openapi-generator.git
::

@echo off
Expand Down
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
#
# Generated by: https://github.com/swagger-api/swagger-codegen.git
# Generated by: https://github.com/openapitools/openapi-generator.git
#

frameworkVersion=net461
Expand Down
6 changes: 5 additions & 1 deletion docs/APIError.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

# TalonOne.Model.APIError

## Properties

Name | Type | Description | Notes
Expand All @@ -7,5 +9,7 @@ Name | Type | Description | Notes
**Details** | **string** | Longer description of this specific instance of the problem. | [optional]
**Source** | [**ErrorSource**](ErrorSource.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)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)

13 changes: 13 additions & 0 deletions docs/AcceptCouponEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# TalonOne.Model.AcceptCouponEffectProps

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **string** | The coupon code that was accepted |

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

13 changes: 13 additions & 0 deletions docs/AcceptReferralEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# TalonOne.Model.AcceptReferralEffectProps

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **string** | The referral code that was accepted |

[[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: 7 additions & 3 deletions docs/AccessLogEntry.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@

# TalonOne.Model.AccessLogEntry

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **string** | UUID reference of request |
**Status** | **int?** | HTTP status code of response |
**Status** | **int** | HTTP status code of response |
**Method** | **string** | HTTP method of request |
**RequestUri** | **string** | target URI of request |
**Time** | **DateTime?** | timestamp of request |
**Time** | **DateTime** | timestamp of request |
**RequestPayload** | **string** | payload of request |
**ResponsePayload** | **string** | payload of response |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.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)

34 changes: 19 additions & 15 deletions docs/Account.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@

# TalonOne.Model.Account

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int?** | Unique ID for this entity. |
**Created** | **DateTime?** | The exact moment this entity was created. |
**Modified** | **DateTime?** | The exact moment this entity was last modified. |
**Id** | **int** | Unique ID for this entity. |
**Created** | **DateTime** | The exact moment this entity was created. |
**Modified** | **DateTime** | The exact moment this entity was last modified. |
**CompanyName** | **string** | |
**DomainName** | **string** | Subdomain Name for yourcompany.talon.one |
**State** | **string** | State of the account (trial, active, trial_expired) |
**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** | **DateTime?** | The point in time at which your current plan expires. | [optional]
**ApplicationLimit** | **int?** | The maximum number of Applications covered by your plan. | [optional]
**UserLimit** | **int?** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
**CampaignLimit** | **int?** | The maximum number of Campaigns covered by your plan. | [optional]
**ApiLimit** | **int?** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
**ApplicationCount** | **int?** | The current number of Applications in your account. |
**UserCount** | **int?** | The current number of Campaign Manager Users in your account. |
**CampaignsActiveCount** | **int?** | The current number of active Campaigns in your account. |
**CampaignsInactiveCount** | **int?** | The current number of inactive Campaigns in your account. |
**Attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
**PlanExpires** | **DateTime** | The point in time at which your current plan expires. | [optional]
**ApplicationLimit** | **int** | The maximum number of Applications covered by your plan. | [optional]
**UserLimit** | **int** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
**CampaignLimit** | **int** | The maximum number of Campaigns covered by your plan. | [optional]
**ApiLimit** | **int** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
**ApplicationCount** | **int** | The current number of Applications in your account. |
**UserCount** | **int** | The current number of Campaign Manager Users in your account. |
**CampaignsActiveCount** | **int** | The current number of active Campaigns in your account. |
**CampaignsInactiveCount** | **int** | The current number of inactive Campaigns in your account. |
**Attributes** | [**Object**](.md) | Arbitrary properties associated with this 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)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)

19 changes: 19 additions & 0 deletions docs/AccountAdditionalCost.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# TalonOne.Model.AccountAdditionalCost

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | Unique ID for this entity. |
**Created** | **DateTime** | The exact moment this entity was created. |
**AccountId** | **int** | 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** | **List<int>** | A list of the IDs of the applications that are subscribed to this additional cost | [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)

36 changes: 20 additions & 16 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@

# TalonOne.Model.AccountAnalytics

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Applications** | **int?** | Total Number of Applications inside the account |
**ActiveCampaigns** | **int?** | Total Number of Active Applications inside the account |
**Campaigns** | **int?** | Total Number of campaigns inside the account |
**Coupons** | **int?** | Total Number of coupons inside the account |
**ActiveCoupons** | **int?** | Total Number of active coupons inside the account |
**ExpiredCoupons** | **int?** | Total Number of expired coupons inside the account |
**CustomAttributes** | **int?** | Total Number of custom attributes inside the account |
**ReferralCodes** | **int?** | Total Number of referral codes inside the account |
**ActiveReferralCodes** | **int?** | Total Number of active referral codes inside the account |
**ExpiredReferralCodes** | **int?** | Total Number of expired referral codes inside the account |
**Users** | **int?** | Total Number of users inside the account |
**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 |
**Applications** | **int** | Total Number of Applications inside the account |
**ActiveCampaigns** | **int** | Total Number of Active Applications inside the account |
**Campaigns** | **int** | Total Number of campaigns inside the account |
**Coupons** | **int** | Total Number of coupons inside the account |
**ActiveCoupons** | **int** | Total Number of active coupons inside the account |
**ExpiredCoupons** | **int** | Total Number of expired coupons inside the account |
**CustomAttributes** | **int** | Total Number of custom attributes inside the account |
**ReferralCodes** | **int** | Total Number of referral codes inside the account |
**ActiveReferralCodes** | **int** | Total Number of active referral codes inside the account |
**ExpiredReferralCodes** | **int** | Total Number of expired referral codes inside the account |
**Users** | **int** | Total Number of users inside the account |
**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)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)

8 changes: 6 additions & 2 deletions docs/AccountEntity.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@

# TalonOne.Model.AccountEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **int?** | The ID of the account that owns this entity. |
**AccountId** | **int** | The ID of the account that owns this entity. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.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)

28 changes: 16 additions & 12 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@

# TalonOne.Model.AccountLimits

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LiveApplications** | **int?** | Total Number of allowed live applications in the account |
**SandboxApplications** | **int?** | Total Number of allowed sandbox applications in the account |
**ActiveCampaigns** | **int?** | Total Number of allowed active campaigns in the account |
**Coupons** | **int?** | Total Number of allowed coupons in the account |
**ReferralCodes** | **int?** | Total Number of allowed referral codes in the account |
**LiveLoyaltyPrograms** | **int?** | Total Number of allowed live loyalty programs in the account |
**SandboxLoyaltyPrograms** | **int?** | Total Number of allowed sandbox loyalty programs in the account |
**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]
**LiveApplications** | **int** | Total Number of allowed live applications in the account |
**SandboxApplications** | **int** | Total Number of allowed sandbox applications in the account |
**ActiveCampaigns** | **int** | Total Number of allowed active campaigns in the account |
**Coupons** | **int** | Total Number of allowed coupons in the account |
**ReferralCodes** | **int** | Total Number of allowed referral codes in the account |
**LiveLoyaltyPrograms** | **int** | Total Number of allowed live loyalty programs in the account |
**SandboxLoyaltyPrograms** | **int** | Total Number of allowed sandbox loyalty programs in the account |
**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<string>** | 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)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)

14 changes: 14 additions & 0 deletions docs/AddFreeItemEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# TalonOne.Model.AddFreeItemEffectProps

## Properties

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

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

18 changes: 18 additions & 0 deletions docs/AddLoyaltyPointsEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

# TalonOne.Model.AddLoyaltyPointsEffectProps

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | The name/description of this loyalty point addition |
**ProgramId** | **int** | 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** | **decimal** | The amount of points that were added |
**RecipientIntegrationId** | **string** | The user for whom these points were added |
**ExpiryCondition** | **string** | The amount of time (in days) these points are valid |

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

13 changes: 13 additions & 0 deletions docs/AdditionalCost.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# TalonOne.Model.AdditionalCost

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Price** | **decimal** | |

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

17 changes: 10 additions & 7 deletions docs/Application.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@

# TalonOne.Model.Application

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int?** | Unique ID for this entity. |
**Created** | **DateTime?** | The exact moment this entity was created. |
**Modified** | **DateTime?** | The exact moment this entity was last modified. |
**AccountId** | **int?** | The ID of the account that owns this entity. |
**Id** | **int** | Unique ID for this entity. |
**Created** | **DateTime** | The exact moment this entity was created. |
**Modified** | **DateTime** | The exact moment this entity was last modified. |
**AccountId** | **int** | The ID of the account that owns this entity. |
**Name** | **string** | The name of this application. |
**Description** | **string** | A longer description of the application. | [optional]
**Timezone** | **string** | A string containing an IANA timezone descriptor. |
**Currency** | **string** | A string describing a default currency for new customer sessions. |
**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]
**Attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
**Limits** | [**List<LimitConfig>**](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<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.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 42275b9

Please sign in to comment.