Skip to content

Commit

Permalink
v4.0.0: Integration APIv2 Release (#13)
Browse files Browse the repository at this point in the history
 - Replace code generator to [OpenAPITools generator@v.4.2.3](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)
  • Loading branch information
altJake committed Mar 31, 2020
1 parent a9d2f23 commit 1623f20
Show file tree
Hide file tree
Showing 614 changed files with 30,445 additions and 24,490 deletions.
33 changes: 33 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"presets": [
"@babel/preset-env"
],
"plugins": [
"@babel/plugin-syntax-dynamic-import",
"@babel/plugin-syntax-import-meta",
"@babel/plugin-proposal-class-properties",
"@babel/plugin-proposal-json-strings",
[
"@babel/plugin-proposal-decorators",
{
"legacy": true
}
],
"@babel/plugin-proposal-function-sent",
"@babel/plugin-proposal-export-namespace-from",
"@babel/plugin-proposal-numeric-separator",
"@babel/plugin-proposal-throw-expressions",
"@babel/plugin-proposal-export-default-from",
"@babel/plugin-proposal-logical-assignment-operators",
"@babel/plugin-proposal-optional-chaining",
[
"@babel/plugin-proposal-pipeline-operator",
{
"proposal": "minimal"
}
],
"@babel/plugin-proposal-nullish-coalescing-operator",
"@babel/plugin-proposal-do-expressions",
"@babel/plugin-proposal-function-bind"
]
}
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 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 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 (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
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: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
language: node_js
cache: npm
node_js:
- "10.13.0"
- "8.11.0"
Expand Down
195 changes: 175 additions & 20 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/APIError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.APIError

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Short description of the problem. |
Expand Down
9 changes: 9 additions & 0 deletions docs/AcceptCouponEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TalonOne.AcceptCouponEffectProps

## Properties

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


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

## Properties

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


1 change: 1 addition & 0 deletions docs/AccessLogEntry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.AccessLogEntry

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **String** | UUID reference of request |
Expand Down
11 changes: 5 additions & 6 deletions docs/Account.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# TalonOne.Account

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**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 (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** | **Date** | The point in time at which your current plan expires. | [optional]
Expand All @@ -20,18 +21,16 @@ 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** | Arbitrary properties associated with this campaign | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]


<a name="StateEnum"></a>
## Enum: StateEnum

## Enum: StateEnum

* `trial` (value: `"trial"`)

* `active` (value: `"active"`)

* `trial_expired` (value: `"trial_expired"`)
* `deactivated` (value: `"deactivated"`)



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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**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 &#x60;name &#x3D;&#x3D; \&quot;shipping\&quot;&#x60; then you would set the shipping additional cost by including an &#x60;additionalCosts.shipping&#x60; property in your request payload. |
**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like &#x60;name&#x60;, 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]


1 change: 1 addition & 0 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.AccountAnalytics

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**applications** | **Number** | Total Number of Applications inside the account |
Expand Down
1 change: 1 addition & 0 deletions docs/AccountEntity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.AccountEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountId** | **Number** | The ID of the account that owns this entity. |
Expand Down
1 change: 1 addition & 0 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.AccountLimits

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**liveApplications** | **Number** | Total Number of allowed live applications in the account |
Expand Down
10 changes: 10 additions & 0 deletions docs/AddFreeItemEffectProps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.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 |


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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | The name/description of this loyalty 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 |
**recipientIntegrationId** | **String** | The user for whom these points were added |
**expiryCondition** | **String** | The amount of time (in days) these points are valid |


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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**price** | **Number** | |


6 changes: 3 additions & 3 deletions docs/Application.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.Application

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
Expand All @@ -12,14 +13,13 @@ Name | Type | Description | Notes
**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** | [**[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** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |


<a name="CaseSensitivityEnum"></a>

## Enum: CaseSensitivityEnum


Expand Down
1 change: 1 addition & 0 deletions docs/ApplicationAPIKey.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.ApplicationAPIKey

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | ID of the API Key |
Expand Down
3 changes: 2 additions & 1 deletion docs/ApplicationApiHealth.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# TalonOne.ApplicationApiHealth

## Properties

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 |


<a name="SummaryEnum"></a>

## Enum: SummaryEnum


Expand Down
3 changes: 2 additions & 1 deletion docs/ApplicationCustomer.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# TalonOne.ApplicationCustomer

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**created** | **Date** | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. |
**integrationId** | **String** | The ID used for this entity in the application system. The ID used for this entity in the application system. |
**attributes** | **Object** | Arbitrary properties associated with this item |
**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 |
Expand Down
1 change: 1 addition & 0 deletions docs/ApplicationCustomerEntity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.ApplicationCustomerEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/ApplicationCustomerSearch.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# TalonOne.ApplicationCustomerSearch

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | **Object** | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional]
**attributes** | [**Object**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional]
**integrationIDs** | **[String]** | | [optional]
**profileIDs** | **[Number]** | | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/ApplicationEntity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.ApplicationEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**applicationId** | **Number** | The ID of the application that owns this entity. |
Expand Down
3 changes: 2 additions & 1 deletion docs/ApplicationEvent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.ApplicationEvent

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
Expand All @@ -9,7 +10,7 @@ Name | Type | Description | Notes
**profileId** | **Number** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
**sessionId** | **Number** | The globally unique Talon.One ID of the session that contains this event. | [optional]
**type** | **String** | A string representing the event. Must not be a reserved event name. |
**attributes** | **Object** | Additional JSON serialized data associated with the event. |
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
**effects** | **[Object]** | An array containing the effects that were applied as a result of this event. |


6 changes: 4 additions & 2 deletions docs/ApplicationSession.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# TalonOne.ApplicationSession

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**created** | **Date** | The exact moment this entity was created. 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]
**integrationId** | **String** | The ID used for this entity in the application system. |
**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional]
**coupon** | **String** | Any coupon code entered. |
**referral** | **String** | Any referral code entered. |
**state** | **String** | Indicating if the customer session is in progress (\&quot;open\&quot;), \&quot;closed\&quot;, or \&quot;cancelled\&quot;. |
**cartItems** | [**[CartItem]**](CartItem.md) | Serialized JSON representation. |
**discounts** | **{String: Number}** | A map of labelled discount values, in the same currency as the session. |
**total** | **Number** | The total sum of the session before any discounts applied. | [optional]
**attributes** | **Object** | Arbitrary properties associated with this item | [optional]
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]



<a name="StateEnum"></a>
## Enum: StateEnum


Expand Down
1 change: 1 addition & 0 deletions docs/ApplicationSessionEntity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TalonOne.ApplicationSessionEntity

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sessionId** | **Number** | The globally unique Talon.One ID of the session where this entity was created. |
Expand Down
8 changes: 5 additions & 3 deletions docs/Attribute.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
# TalonOne.Attribute

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Unique ID for this entity. |
**created** | **Date** | The exact moment this entity was created. |
**accountId** | **Number** | The ID of the account that owns this entity. |
**entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an &#x60;attributes&#x60; object with keys corresponding to the &#x60;name&#x60; of the custom attributes for that type. |
**eventType** | **String** | | [optional]
**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if &#x60;name &#x3D;&#x3D; \&quot;region\&quot;&#x60; then you would set the region attribute by including an &#x60;attributes.region&#x60; property in your request payload. |
**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if &#x60;name &#x3D;&#x3D; \&quot;region\&quot;&#x60; then you would set the region attribute by including an &#x60;attributes.region&#x60; property in your request payload. |
**title** | **String** | The human-readable name for the attribute that will be shown in the Campaign Manager. Like &#x60;name&#x60;, the combination of entity and title must also be unique. |
**type** | **String** | The data type of the attribute, a &#x60;time&#x60; attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. |
**description** | **String** | A description of this attribute. |
**suggestions** | **[String]** | A list of suggestions for the attribute. |
**editable** | **Boolean** | Whether or not this attribute can be edited. |
**subscribedApplicationsIds** | **[Number]** | A list of the IDs of the applications that are subscribed to this attribute | [optional]



<a name="EntityEnum"></a>
## Enum: EntityEnum


Expand All @@ -39,7 +41,7 @@ Name | Type | Description | Notes



<a name="TypeEnum"></a>

## Enum: TypeEnum


Expand Down
Loading

0 comments on commit 1623f20

Please sign in to comment.