talon_one 1.3.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -6
- data/docs/AccountAnalytics.md +1 -0
- data/docs/AccountLimits.md +1 -0
- data/docs/Application.md +1 -0
- data/docs/AttributesMandatory.md +9 -0
- data/docs/AttributesSettings.md +8 -0
- data/docs/BaseSamlConnection.md +15 -0
- data/docs/CampaignAnalytics.md +9 -3
- data/docs/CampaignCopy.md +4 -0
- data/docs/Change.md +2 -2
- data/docs/CustomerInventory.md +9 -0
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +2 -3
- data/docs/InlineResponse20026.md +3 -2
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +9 -0
- data/docs/IntegrationApi.md +66 -0
- data/docs/ManagementApi.md +162 -101
- data/docs/NewApplication.md +1 -0
- data/docs/NewSamlConnection.md +3 -2
- data/docs/SamlConnection.md +4 -5
- data/docs/SamlConnectionMetadata.md +11 -0
- data/docs/UpdateApplication.md +1 -0
- data/lib/talon_one.rb +6 -0
- data/lib/talon_one/api/integration_api.rb +60 -0
- data/lib/talon_one/api/management_api.rb +177 -119
- data/lib/talon_one/models/account_analytics.rb +19 -4
- data/lib/talon_one/models/account_limits.rb +11 -1
- data/lib/talon_one/models/application.rb +10 -1
- data/lib/talon_one/models/attributes_mandatory.rb +199 -0
- data/lib/talon_one/models/attributes_settings.rb +184 -0
- data/lib/talon_one/models/base_saml_connection.rb +336 -0
- data/lib/talon_one/models/campaign_analytics.rb +94 -4
- data/lib/talon_one/models/campaign_copy.rb +46 -4
- data/lib/talon_one/models/change.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +194 -0
- data/lib/talon_one/models/inline_response_200_20.rb +1 -1
- data/lib/talon_one/models/inline_response_200_21.rb +1 -1
- data/lib/talon_one/models/inline_response_200_22.rb +1 -1
- data/lib/talon_one/models/inline_response_200_23.rb +1 -1
- data/lib/talon_one/models/inline_response_200_24.rb +1 -1
- data/lib/talon_one/models/inline_response_200_25.rb +7 -11
- data/lib/talon_one/models/inline_response_200_26.rb +11 -7
- data/lib/talon_one/models/inline_response_200_27.rb +1 -1
- data/lib/talon_one/models/inline_response_200_28.rb +1 -1
- data/lib/talon_one/models/inline_response_200_29.rb +204 -0
- data/lib/talon_one/models/new_application.rb +10 -1
- data/lib/talon_one/models/new_saml_connection.rb +58 -43
- data/lib/talon_one/models/saml_connection.rb +45 -78
- data/lib/talon_one/models/saml_connection_metadata.rb +271 -0
- data/lib/talon_one/models/update_application.rb +13 -4
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +14 -0
- data/spec/api/management_api_spec.rb +50 -36
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_limits_spec.rb +6 -0
- data/spec/models/application_spec.rb +6 -0
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +83 -0
- data/spec/models/campaign_analytics_spec.rb +36 -0
- data/spec/models/campaign_copy_spec.rb +24 -0
- data/spec/models/customer_inventory_spec.rb +47 -0
- data/spec/models/inline_response_200_25_spec.rb +0 -6
- data/spec/models/inline_response_200_26_spec.rb +6 -0
- data/spec/models/inline_response_200_29_spec.rb +47 -0
- data/spec/models/new_application_spec.rb +6 -0
- data/spec/models/new_saml_connection_spec.rb +13 -7
- data/spec/models/saml_connection_metadata_spec.rb +59 -0
- data/spec/models/saml_connection_spec.rb +9 -15
- data/spec/models/update_application_spec.rb +6 -0
- data/talon_one-1.3.0.gem +0 -0
- metadata +27 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 45665e29a6992992ab245da3fc617f49ddf0468e4a192384c0872c3209f9cded
|
4
|
+
data.tar.gz: dfcf3b660ad5f8d19a17ca8914c2dfa94f5393f47fc6df5b2788d2687ece4481
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e49c926f6e86618f668f117f58a67382d09fa89297f0d1640baed8ef7476438e256eb8d401dce43c98e2f28def15ab2e7288f4b54ad8237ef3cfab38258edf8a
|
7
|
+
data.tar.gz: 7abe931e1870c161cac4935482976593cb3fca881c9fc75a912d0d537f300daefbaf4712c4a7f94432a6678e3b3045353d7c573aa451869bcfbbd85bf4954683
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The Talon.One API is used to manage applications and campaigns, as well as to in
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.4.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build talon_one.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./talon_one-1.
|
26
|
+
gem install ./talon_one-1.4.0.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./talon_one-1.
|
28
|
+
(for development, run `gem install --dev ./talon_one-1.4.0.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'talon_one', '~> 1.
|
34
|
+
gem 'talon_one', '~> 1.4.0'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
|
|
140
140
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
141
141
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
142
142
|
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
|
143
|
+
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
|
143
144
|
*TalonOne::IntegrationApi* | [**get_reserved_coupons**](docs/IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
|
144
145
|
*TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
145
146
|
*TalonOne::IntegrationApi* | [**track_event**](docs/IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
@@ -147,6 +148,7 @@ Class | Method | HTTP request | Description
|
|
147
148
|
*TalonOne::IntegrationApi* | [**update_customer_session**](docs/IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
|
148
149
|
*TalonOne::ManagementApi* | [**add_loyalty_points**](docs/ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
|
149
150
|
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
|
151
|
+
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
150
152
|
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
151
153
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
152
154
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
@@ -161,7 +163,6 @@ Class | Method | HTTP request | Description
|
|
161
163
|
*TalonOne::ManagementApi* | [**get_access_logs_without_total_count**](docs/ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
162
164
|
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
163
165
|
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
164
|
-
*TalonOne::ManagementApi* | [**get_account_limits**](docs/ManagementApi.md#get_account_limits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
|
165
166
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
166
167
|
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
167
168
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
@@ -176,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
176
177
|
*TalonOne::ManagementApi* | [**get_application_sessions**](docs/ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
177
178
|
*TalonOne::ManagementApi* | [**get_applications**](docs/ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
178
179
|
*TalonOne::ManagementApi* | [**get_attribute**](docs/ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
180
|
+
*TalonOne::ManagementApi* | [**get_attributes**](docs/ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
179
181
|
*TalonOne::ManagementApi* | [**get_campaign**](docs/ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
180
182
|
*TalonOne::ManagementApi* | [**get_campaign_analytics**](docs/ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
181
183
|
*TalonOne::ManagementApi* | [**get_campaign_by_attributes**](docs/ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
@@ -217,7 +219,7 @@ Class | Method | HTTP request | Description
|
|
217
219
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide**](docs/ManagementApi.md#search_coupons_advanced_application_wide) | **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
|
218
220
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **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
|
219
221
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
|
220
|
-
*TalonOne::ManagementApi* | [**
|
222
|
+
*TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
221
223
|
*TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
222
224
|
*TalonOne::ManagementApi* | [**update_campaign_set**](docs/ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
|
223
225
|
*TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
@@ -245,6 +247,9 @@ Class | Method | HTTP request | Description
|
|
245
247
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
246
248
|
- [TalonOne::Attribute](docs/Attribute.md)
|
247
249
|
- [TalonOne::AttributeQuery](docs/AttributeQuery.md)
|
250
|
+
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
251
|
+
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
252
|
+
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
248
253
|
- [TalonOne::Binding](docs/Binding.md)
|
249
254
|
- [TalonOne::Campaign](docs/Campaign.md)
|
250
255
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
@@ -268,6 +273,7 @@ Class | Method | HTTP request | Description
|
|
268
273
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
269
274
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
270
275
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
276
|
+
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
271
277
|
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
|
272
278
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
273
279
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
@@ -308,6 +314,7 @@ Class | Method | HTTP request | Description
|
|
308
314
|
- [TalonOne::InlineResponse20026](docs/InlineResponse20026.md)
|
309
315
|
- [TalonOne::InlineResponse20027](docs/InlineResponse20027.md)
|
310
316
|
- [TalonOne::InlineResponse20028](docs/InlineResponse20028.md)
|
317
|
+
- [TalonOne::InlineResponse20029](docs/InlineResponse20029.md)
|
311
318
|
- [TalonOne::InlineResponse2003](docs/InlineResponse2003.md)
|
312
319
|
- [TalonOne::InlineResponse2004](docs/InlineResponse2004.md)
|
313
320
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
@@ -373,6 +380,7 @@ Class | Method | HTTP request | Description
|
|
373
380
|
- [TalonOne::Rule](docs/Rule.md)
|
374
381
|
- [TalonOne::Ruleset](docs/Ruleset.md)
|
375
382
|
- [TalonOne::SamlConnection](docs/SamlConnection.md)
|
383
|
+
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
376
384
|
- [TalonOne::Session](docs/Session.md)
|
377
385
|
- [TalonOne::SlotDef](docs/SlotDef.md)
|
378
386
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
data/docs/AccountAnalytics.md
CHANGED
@@ -17,5 +17,6 @@ Name | Type | Description | Notes
|
|
17
17
|
**roles** | **Integer** | Total Number of roles inside the account |
|
18
18
|
**webhooks** | **Integer** | Total Number of webhooks inside the account |
|
19
19
|
**loyalty_programs** | **Integer** | Total Number of loyalty programs inside the account |
|
20
|
+
**active_rules** | **Integer** | Total Number of active rules in the account |
|
20
21
|
|
21
22
|
|
data/docs/AccountLimits.md
CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**webhooks** | **Integer** | Total Number of allowed webhooks in the account |
|
14
14
|
**users** | **Integer** | Total Number of allowed users in the account |
|
15
15
|
**api_volume** | **Integer** | Total allowed api volume |
|
16
|
+
**active_rules** | **Integer** | Total allowed active rulesets | [optional]
|
16
17
|
**promotion_types** | **Array<String>** | array of rulesets where webhook is used |
|
17
18
|
|
18
19
|
|
data/docs/Application.md
CHANGED
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional]
|
15
15
|
**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional]
|
16
16
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
17
|
+
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
17
18
|
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) |
|
18
19
|
**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed |
|
19
20
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# TalonOne::AttributesMandatory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**campaigns** | **Array<String>** | List of mandatory attributes for campaigns. | [optional]
|
7
|
+
**coupons** | **Array<String>** | List of mandatory attributes for campaigns. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# TalonOne::BaseSamlConnection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
7
|
+
**name** | **String** | ID of the SAML service. |
|
8
|
+
**enabled** | **BOOLEAN** | Determines if this SAML connection active. |
|
9
|
+
**issuer** | **String** | Identity Provider Entity ID. |
|
10
|
+
**sign_on_url** | **String** | Single Sign-On URL. |
|
11
|
+
**sign_out_url** | **String** | Single Sign-Out URL. | [optional]
|
12
|
+
**metadata_url** | **String** | Metadata URL. | [optional]
|
13
|
+
**audience_uri** | **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]
|
14
|
+
|
15
|
+
|
data/docs/CampaignAnalytics.md
CHANGED
@@ -4,14 +4,20 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**date** | **DateTime** | |
|
7
|
-
**campaign_revenue** | **Float** | Amount of revenue in this campaign. |
|
8
|
-
**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began. |
|
7
|
+
**campaign_revenue** | **Float** | Amount of revenue in this campaign (for coupon or discount sessions). |
|
8
|
+
**total_campaign_revenue** | **Float** | Amount of revenue in this campaign since it began (for coupon or discount sessions). |
|
9
|
+
**campaign_refund** | **Float** | Amount of refunds in this campaign (for coupon or discount sessions). |
|
10
|
+
**total_campaign_refund** | **Float** | Amount of refunds in this campaign since it began (for coupon or discount sessions). |
|
9
11
|
**campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign. |
|
10
12
|
**total_campaign_discount_costs** | **Float** | Amount of cost caused by discounts given in the campaign since it began. |
|
13
|
+
**campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign. |
|
14
|
+
**total_campaign_refunded_discounts** | **Float** | Amount of discounts rolledback due to refund in the campaign since it began. |
|
11
15
|
**campaign_free_items** | **Integer** | Amount of free items given in the campaign. |
|
12
16
|
**total_campaign_free_items** | **Integer** | Amount of free items given in the campaign since it began. |
|
13
|
-
**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign
|
17
|
+
**coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign. |
|
14
18
|
**total_coupon_redemptions** | **Integer** | Number of coupon redemptions in the campaign since it began. |
|
19
|
+
**coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign. |
|
20
|
+
**total_coupon_rolledback_redemptions** | **Integer** | Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began. |
|
15
21
|
**referral_redemptions** | **Integer** | Number of referral redemptions in the campaign. |
|
16
22
|
**total_referral_redemptions** | **Integer** | Number of referral redemptions in the campaign since it began. |
|
17
23
|
**coupons_created** | **Integer** | Number of coupons created in the campaign by the rule engine. |
|
data/docs/CampaignCopy.md
CHANGED
@@ -5,5 +5,9 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional]
|
7
7
|
**application_ids** | **Array<String>** | Application IDs of the applications to which a campaign should be copied to |
|
8
|
+
**description** | **String** | A detailed description of the campaign. | [optional]
|
9
|
+
**start_time** | **DateTime** | Datetime when the campaign will become active. | [optional]
|
10
|
+
**end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional]
|
11
|
+
**tags** | **Array<String>** | A list of tags for the campaign. | [optional]
|
8
12
|
|
9
13
|
|
data/docs/Change.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**created** | **DateTime** | The exact moment this entity was created. |
|
8
8
|
**user_id** | **Integer** | The ID of the account that owns this entity. |
|
9
9
|
**entity** | **String** | API endpoint on which the change was initiated. |
|
10
|
-
**old** | **Object** | Resource before the change
|
11
|
-
**new** | **Object** | Resource after the change
|
10
|
+
**old** | **Object** | Resource before the change occurred. | [optional]
|
11
|
+
**new** | **Object** | Resource after the change occurred. | [optional]
|
12
12
|
|
13
13
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# TalonOne::CustomerInventory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
|
7
|
+
**referrals** | [**Array<Referral>**](Referral.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/InlineResponse20020.md
CHANGED
data/docs/InlineResponse20021.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<Webhook>**](Webhook.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20022.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20023.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
7
|
+
**data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20024.md
CHANGED
data/docs/InlineResponse20025.md
CHANGED
@@ -3,8 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**total_result_size** | **Integer** | |
|
7
|
-
**
|
8
|
-
**data** | [**Array<Change>**](Change.md) | |
|
6
|
+
**total_result_size** | **Integer** | |
|
7
|
+
**data** | [**Array<User>**](User.md) | |
|
9
8
|
|
10
9
|
|
data/docs/InlineResponse20026.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**total_result_size** | **Integer** | |
|
7
|
-
**
|
6
|
+
**total_result_size** | **Integer** | | [optional]
|
7
|
+
**has_more** | **BOOLEAN** | | [optional]
|
8
|
+
**data** | [**Array<Change>**](Change.md) | |
|
8
9
|
|
9
10
|
|
data/docs/InlineResponse20027.md
CHANGED
data/docs/InlineResponse20028.md
CHANGED
data/docs/IntegrationApi.md
CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
9
9
|
[**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
10
10
|
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
|
11
|
+
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
|
11
12
|
[**get_reserved_coupons**](IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
|
12
13
|
[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
13
14
|
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
@@ -255,6 +256,71 @@ nil (empty response body)
|
|
255
256
|
|
256
257
|
|
257
258
|
|
259
|
+
# **get_customer_inventory**
|
260
|
+
> CustomerInventory get_customer_inventory(integration_id, opts)
|
261
|
+
|
262
|
+
Get an inventory of all data associated with a specific customer profile.
|
263
|
+
|
264
|
+
Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and referral codes. In the future, this will be expanded with coupon codes and loyalty points.
|
265
|
+
|
266
|
+
### Example
|
267
|
+
```ruby
|
268
|
+
# load the gem
|
269
|
+
require 'talon_one'
|
270
|
+
# setup authorization
|
271
|
+
TalonOne.configure do |config|
|
272
|
+
# Configure API key authorization: api_key_v1
|
273
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
275
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
276
|
+
|
277
|
+
# Configure API key authorization: integration_auth
|
278
|
+
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
279
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
280
|
+
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
281
|
+
end
|
282
|
+
|
283
|
+
api_instance = TalonOne::IntegrationApi.new
|
284
|
+
|
285
|
+
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
286
|
+
|
287
|
+
opts = {
|
288
|
+
profile: nil, # Object | optional flag to decide if you would like customer profile information in the response
|
289
|
+
referrals: nil # Object | optional flag to decide if you would like referral information in the response
|
290
|
+
}
|
291
|
+
|
292
|
+
begin
|
293
|
+
#Get an inventory of all data associated with a specific customer profile.
|
294
|
+
result = api_instance.get_customer_inventory(integration_id, opts)
|
295
|
+
p result
|
296
|
+
rescue TalonOne::ApiError => e
|
297
|
+
puts "Exception when calling IntegrationApi->get_customer_inventory: #{e}"
|
298
|
+
end
|
299
|
+
```
|
300
|
+
|
301
|
+
### Parameters
|
302
|
+
|
303
|
+
Name | Type | Description | Notes
|
304
|
+
------------- | ------------- | ------------- | -------------
|
305
|
+
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
306
|
+
**profile** | [**Object**](.md)| optional flag to decide if you would like customer profile information in the response | [optional]
|
307
|
+
**referrals** | [**Object**](.md)| optional flag to decide if you would like referral information in the response | [optional]
|
308
|
+
|
309
|
+
### Return type
|
310
|
+
|
311
|
+
[**CustomerInventory**](CustomerInventory.md)
|
312
|
+
|
313
|
+
### Authorization
|
314
|
+
|
315
|
+
[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
|
316
|
+
|
317
|
+
### HTTP request headers
|
318
|
+
|
319
|
+
- **Content-Type**: application/json
|
320
|
+
- **Accept**: application/json
|
321
|
+
|
322
|
+
|
323
|
+
|
258
324
|
# **get_reserved_coupons**
|
259
325
|
> InlineResponse2001 get_reserved_coupons(integration_id)
|
260
326
|
|
data/docs/ManagementApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
|
8
8
|
[**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
|
9
|
+
[**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
9
10
|
[**create_campaign**](ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
10
11
|
[**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
11
12
|
[**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
@@ -20,7 +21,6 @@ Method | HTTP request | Description
|
|
20
21
|
[**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
21
22
|
[**get_account**](ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
22
23
|
[**get_account_analytics**](ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
23
|
-
[**get_account_limits**](ManagementApi.md#get_account_limits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
|
24
24
|
[**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
25
25
|
[**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
26
26
|
[**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
@@ -35,6 +35,7 @@ Method | HTTP request | Description
|
|
35
35
|
[**get_application_sessions**](ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
36
36
|
[**get_applications**](ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
37
37
|
[**get_attribute**](ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
38
|
+
[**get_attributes**](ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
38
39
|
[**get_campaign**](ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
39
40
|
[**get_campaign_analytics**](ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
40
41
|
[**get_campaign_by_attributes**](ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
@@ -76,7 +77,7 @@ Method | HTTP request | Description
|
|
76
77
|
[**search_coupons_advanced_application_wide**](ManagementApi.md#search_coupons_advanced_application_wide) | **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
|
77
78
|
[**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **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
|
78
79
|
[**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
|
79
|
-
[**
|
80
|
+
[**update_attribute**](ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
80
81
|
[**update_campaign**](ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
81
82
|
[**update_campaign_set**](ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
|
82
83
|
[**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
@@ -203,6 +204,60 @@ Name | Type | Description | Notes
|
|
203
204
|
|
204
205
|
|
205
206
|
|
207
|
+
# **create_attribute**
|
208
|
+
> Attribute create_attribute(body)
|
209
|
+
|
210
|
+
Define a new custom attribute
|
211
|
+
|
212
|
+
Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
|
213
|
+
|
214
|
+
### Example
|
215
|
+
```ruby
|
216
|
+
# load the gem
|
217
|
+
require 'talon_one'
|
218
|
+
# setup authorization
|
219
|
+
TalonOne.configure do |config|
|
220
|
+
# Configure API key authorization: manager_auth
|
221
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
222
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
223
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
224
|
+
end
|
225
|
+
|
226
|
+
api_instance = TalonOne::ManagementApi.new
|
227
|
+
|
228
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
229
|
+
|
230
|
+
|
231
|
+
begin
|
232
|
+
#Define a new custom attribute
|
233
|
+
result = api_instance.create_attribute(body)
|
234
|
+
p result
|
235
|
+
rescue TalonOne::ApiError => e
|
236
|
+
puts "Exception when calling ManagementApi->create_attribute: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
### Parameters
|
241
|
+
|
242
|
+
Name | Type | Description | Notes
|
243
|
+
------------- | ------------- | ------------- | -------------
|
244
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
[**Attribute**](Attribute.md)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[manager_auth](../README.md#manager_auth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: application/json
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
260
|
+
|
206
261
|
# **create_campaign**
|
207
262
|
> Campaign create_campaign(application_id, body)
|
208
263
|
|
@@ -265,7 +320,7 @@ Name | Type | Description | Notes
|
|
265
320
|
|
266
321
|
Create Coupons
|
267
322
|
|
268
|
-
Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000
|
323
|
+
Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
269
324
|
|
270
325
|
### Example
|
271
326
|
```ruby
|
@@ -837,8 +892,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
|
|
837
892
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
838
893
|
|
839
894
|
opts = {
|
840
|
-
path: 'path_example', # String | Only return results where the request path matches the given regular
|
841
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular
|
895
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
896
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
842
897
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
843
898
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
844
899
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
@@ -861,8 +916,8 @@ Name | Type | Description | Notes
|
|
861
916
|
**application_id** | **Integer**| |
|
862
917
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
863
918
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
864
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
865
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
919
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
920
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
866
921
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
867
922
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
868
923
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
@@ -911,8 +966,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
|
|
911
966
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
912
967
|
|
913
968
|
opts = {
|
914
|
-
path: 'path_example', # String | Only return results where the request path matches the given regular
|
915
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular
|
969
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
970
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
916
971
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
917
972
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
918
973
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
@@ -935,8 +990,8 @@ Name | Type | Description | Notes
|
|
935
990
|
**application_id** | **Integer**| |
|
936
991
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
937
992
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
938
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
939
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
993
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
994
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
940
995
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
941
996
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
942
997
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
@@ -1065,60 +1120,6 @@ Name | Type | Description | Notes
|
|
1065
1120
|
|
1066
1121
|
|
1067
1122
|
|
1068
|
-
# **get_account_limits**
|
1069
|
-
> AccountLimits get_account_limits(account_id)
|
1070
|
-
|
1071
|
-
Get Account Limits
|
1072
|
-
|
1073
|
-
Returns a list of all account limits set
|
1074
|
-
|
1075
|
-
### Example
|
1076
|
-
```ruby
|
1077
|
-
# load the gem
|
1078
|
-
require 'talon_one'
|
1079
|
-
# setup authorization
|
1080
|
-
TalonOne.configure do |config|
|
1081
|
-
# Configure API key authorization: manager_auth
|
1082
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1083
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1084
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1085
|
-
end
|
1086
|
-
|
1087
|
-
api_instance = TalonOne::ManagementApi.new
|
1088
|
-
|
1089
|
-
account_id = 56 # Integer |
|
1090
|
-
|
1091
|
-
|
1092
|
-
begin
|
1093
|
-
#Get Account Limits
|
1094
|
-
result = api_instance.get_account_limits(account_id)
|
1095
|
-
p result
|
1096
|
-
rescue TalonOne::ApiError => e
|
1097
|
-
puts "Exception when calling ManagementApi->get_account_limits: #{e}"
|
1098
|
-
end
|
1099
|
-
```
|
1100
|
-
|
1101
|
-
### Parameters
|
1102
|
-
|
1103
|
-
Name | Type | Description | Notes
|
1104
|
-
------------- | ------------- | ------------- | -------------
|
1105
|
-
**account_id** | **Integer**| |
|
1106
|
-
|
1107
|
-
### Return type
|
1108
|
-
|
1109
|
-
[**AccountLimits**](AccountLimits.md)
|
1110
|
-
|
1111
|
-
### Authorization
|
1112
|
-
|
1113
|
-
[manager_auth](../README.md#manager_auth)
|
1114
|
-
|
1115
|
-
### HTTP request headers
|
1116
|
-
|
1117
|
-
- **Content-Type**: application/json
|
1118
|
-
- **Accept**: application/json
|
1119
|
-
|
1120
|
-
|
1121
|
-
|
1122
1123
|
# **get_all_access_logs**
|
1123
1124
|
> InlineResponse2009 get_all_access_logs(range_start, range_end, opts)
|
1124
1125
|
|
@@ -1145,8 +1146,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
|
|
1145
1146
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
1146
1147
|
|
1147
1148
|
opts = {
|
1148
|
-
path: 'path_example', # String | Only return results where the request path matches the given regular
|
1149
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular
|
1149
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
1150
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
1150
1151
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
1151
1152
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1152
1153
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
@@ -1168,8 +1169,8 @@ Name | Type | Description | Notes
|
|
1168
1169
|
------------- | ------------- | ------------- | -------------
|
1169
1170
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
1170
1171
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
1171
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
1172
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
1172
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
1173
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
1173
1174
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
1174
1175
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
1175
1176
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
@@ -1191,7 +1192,7 @@ Name | Type | Description | Notes
|
|
1191
1192
|
|
1192
1193
|
|
1193
1194
|
# **get_all_roles**
|
1194
|
-
>
|
1195
|
+
> InlineResponse20029 get_all_roles
|
1195
1196
|
|
1196
1197
|
Get all roles.
|
1197
1198
|
|
@@ -1223,7 +1224,7 @@ This endpoint does not need any parameter.
|
|
1223
1224
|
|
1224
1225
|
### Return type
|
1225
1226
|
|
1226
|
-
[**
|
1227
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
1227
1228
|
|
1228
1229
|
### Authorization
|
1229
1230
|
|
@@ -1460,7 +1461,7 @@ Name | Type | Description | Notes
|
|
1460
1461
|
|
1461
1462
|
Get a list of the customer profiles that match the given attributes
|
1462
1463
|
|
1463
|
-
Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
1464
|
+
Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
1464
1465
|
|
1465
1466
|
### Example
|
1466
1467
|
```ruby
|
@@ -1977,6 +1978,65 @@ Name | Type | Description | Notes
|
|
1977
1978
|
|
1978
1979
|
|
1979
1980
|
|
1981
|
+
# **get_attributes**
|
1982
|
+
> InlineResponse20020 get_attributes(opts)
|
1983
|
+
|
1984
|
+
List custom attributes
|
1985
|
+
|
1986
|
+
Returns all the defined custom attributes for the account.
|
1987
|
+
|
1988
|
+
### Example
|
1989
|
+
```ruby
|
1990
|
+
# load the gem
|
1991
|
+
require 'talon_one'
|
1992
|
+
# setup authorization
|
1993
|
+
TalonOne.configure do |config|
|
1994
|
+
# Configure API key authorization: manager_auth
|
1995
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1996
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1997
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1998
|
+
end
|
1999
|
+
|
2000
|
+
api_instance = TalonOne::ManagementApi.new
|
2001
|
+
|
2002
|
+
opts = {
|
2003
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
2004
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
2005
|
+
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
2006
|
+
}
|
2007
|
+
|
2008
|
+
begin
|
2009
|
+
#List custom attributes
|
2010
|
+
result = api_instance.get_attributes(opts)
|
2011
|
+
p result
|
2012
|
+
rescue TalonOne::ApiError => e
|
2013
|
+
puts "Exception when calling ManagementApi->get_attributes: #{e}"
|
2014
|
+
end
|
2015
|
+
```
|
2016
|
+
|
2017
|
+
### Parameters
|
2018
|
+
|
2019
|
+
Name | Type | Description | Notes
|
2020
|
+
------------- | ------------- | ------------- | -------------
|
2021
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
2022
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
2023
|
+
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
2024
|
+
|
2025
|
+
### Return type
|
2026
|
+
|
2027
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
2028
|
+
|
2029
|
+
### Authorization
|
2030
|
+
|
2031
|
+
[manager_auth](../README.md#manager_auth)
|
2032
|
+
|
2033
|
+
### HTTP request headers
|
2034
|
+
|
2035
|
+
- **Content-Type**: application/json
|
2036
|
+
- **Accept**: application/json
|
2037
|
+
|
2038
|
+
|
2039
|
+
|
1980
2040
|
# **get_campaign**
|
1981
2041
|
> Campaign get_campaign(application_id, campaign_id)
|
1982
2042
|
|
@@ -2295,7 +2355,7 @@ Name | Type | Description | Notes
|
|
2295
2355
|
|
2296
2356
|
|
2297
2357
|
# **get_changes**
|
2298
|
-
>
|
2358
|
+
> InlineResponse20026 get_changes(opts)
|
2299
2359
|
|
2300
2360
|
Get audit log for an account
|
2301
2361
|
|
@@ -2350,7 +2410,7 @@ Name | Type | Description | Notes
|
|
2350
2410
|
|
2351
2411
|
### Return type
|
2352
2412
|
|
2353
|
-
[**
|
2413
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
2354
2414
|
|
2355
2415
|
### Authorization
|
2356
2416
|
|
@@ -3113,7 +3173,7 @@ Name | Type | Description | Notes
|
|
3113
3173
|
|
3114
3174
|
Get a list of the customer profiles that match the given attributes
|
3115
3175
|
|
3116
|
-
Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
3176
|
+
Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
3117
3177
|
|
3118
3178
|
### Example
|
3119
3179
|
```ruby
|
@@ -3169,7 +3229,7 @@ Name | Type | Description | Notes
|
|
3169
3229
|
|
3170
3230
|
|
3171
3231
|
# **get_event_types**
|
3172
|
-
>
|
3232
|
+
> InlineResponse20024 get_event_types(opts)
|
3173
3233
|
|
3174
3234
|
List Event Types
|
3175
3235
|
|
@@ -3220,7 +3280,7 @@ Name | Type | Description | Notes
|
|
3220
3280
|
|
3221
3281
|
### Return type
|
3222
3282
|
|
3223
|
-
[**
|
3283
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
3224
3284
|
|
3225
3285
|
### Authorization
|
3226
3286
|
|
@@ -3234,7 +3294,7 @@ Name | Type | Description | Notes
|
|
3234
3294
|
|
3235
3295
|
|
3236
3296
|
# **get_exports**
|
3237
|
-
>
|
3297
|
+
> InlineResponse20027 get_exports(opts)
|
3238
3298
|
|
3239
3299
|
Get Exports
|
3240
3300
|
|
@@ -3283,7 +3343,7 @@ Name | Type | Description | Notes
|
|
3283
3343
|
|
3284
3344
|
### Return type
|
3285
3345
|
|
3286
|
-
[**
|
3346
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
3287
3347
|
|
3288
3348
|
### Authorization
|
3289
3349
|
|
@@ -3297,7 +3357,7 @@ Name | Type | Description | Notes
|
|
3297
3357
|
|
3298
3358
|
|
3299
3359
|
# **get_imports**
|
3300
|
-
>
|
3360
|
+
> InlineResponse20028 get_imports(opts)
|
3301
3361
|
|
3302
3362
|
Get Imports
|
3303
3363
|
|
@@ -3340,7 +3400,7 @@ Name | Type | Description | Notes
|
|
3340
3400
|
|
3341
3401
|
### Return type
|
3342
3402
|
|
3343
|
-
[**
|
3403
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
3344
3404
|
|
3345
3405
|
### Authorization
|
3346
3406
|
|
@@ -3898,7 +3958,7 @@ Name | Type | Description | Notes
|
|
3898
3958
|
|
3899
3959
|
|
3900
3960
|
# **get_users**
|
3901
|
-
>
|
3961
|
+
> InlineResponse20025 get_users(opts)
|
3902
3962
|
|
3903
3963
|
List Users in your account
|
3904
3964
|
|
@@ -3943,7 +4003,7 @@ Name | Type | Description | Notes
|
|
3943
4003
|
|
3944
4004
|
### Return type
|
3945
4005
|
|
3946
|
-
[**
|
4006
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
3947
4007
|
|
3948
4008
|
### Authorization
|
3949
4009
|
|
@@ -4011,7 +4071,7 @@ Name | Type | Description | Notes
|
|
4011
4071
|
|
4012
4072
|
|
4013
4073
|
# **get_webhook_activation_logs**
|
4014
|
-
>
|
4074
|
+
> InlineResponse20022 get_webhook_activation_logs(opts)
|
4015
4075
|
|
4016
4076
|
List Webhook activation Log Entries
|
4017
4077
|
|
@@ -4068,7 +4128,7 @@ Name | Type | Description | Notes
|
|
4068
4128
|
|
4069
4129
|
### Return type
|
4070
4130
|
|
4071
|
-
[**
|
4131
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
4072
4132
|
|
4073
4133
|
### Authorization
|
4074
4134
|
|
@@ -4082,7 +4142,7 @@ Name | Type | Description | Notes
|
|
4082
4142
|
|
4083
4143
|
|
4084
4144
|
# **get_webhook_logs**
|
4085
|
-
>
|
4145
|
+
> InlineResponse20023 get_webhook_logs(opts)
|
4086
4146
|
|
4087
4147
|
List Webhook Log Entries
|
4088
4148
|
|
@@ -4141,7 +4201,7 @@ Name | Type | Description | Notes
|
|
4141
4201
|
|
4142
4202
|
### Return type
|
4143
4203
|
|
4144
|
-
[**
|
4204
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
4145
4205
|
|
4146
4206
|
### Authorization
|
4147
4207
|
|
@@ -4155,7 +4215,7 @@ Name | Type | Description | Notes
|
|
4155
4215
|
|
4156
4216
|
|
4157
4217
|
# **get_webhooks**
|
4158
|
-
>
|
4218
|
+
> InlineResponse20021 get_webhooks(opts)
|
4159
4219
|
|
4160
4220
|
List Webhooks
|
4161
4221
|
|
@@ -4202,7 +4262,7 @@ Name | Type | Description | Notes
|
|
4202
4262
|
|
4203
4263
|
### Return type
|
4204
4264
|
|
4205
|
-
[**
|
4265
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
4206
4266
|
|
4207
4267
|
### Authorization
|
4208
4268
|
|
@@ -4717,12 +4777,12 @@ Name | Type | Description | Notes
|
|
4717
4777
|
|
4718
4778
|
|
4719
4779
|
|
4720
|
-
# **
|
4721
|
-
>
|
4780
|
+
# **update_attribute**
|
4781
|
+
> Attribute update_attribute(attribute_id, body)
|
4722
4782
|
|
4723
|
-
|
4783
|
+
Update a custom attribute
|
4724
4784
|
|
4725
|
-
|
4785
|
+
Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
|
4726
4786
|
|
4727
4787
|
### Example
|
4728
4788
|
```ruby
|
@@ -4738,16 +4798,17 @@ end
|
|
4738
4798
|
|
4739
4799
|
api_instance = TalonOne::ManagementApi.new
|
4740
4800
|
|
4741
|
-
|
4801
|
+
attribute_id = 56 # Integer |
|
4742
4802
|
|
4743
|
-
body = TalonOne::
|
4803
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
4744
4804
|
|
4745
4805
|
|
4746
4806
|
begin
|
4747
|
-
#
|
4748
|
-
api_instance.
|
4807
|
+
#Update a custom attribute
|
4808
|
+
result = api_instance.update_attribute(attribute_id, body)
|
4809
|
+
p result
|
4749
4810
|
rescue TalonOne::ApiError => e
|
4750
|
-
puts "Exception when calling ManagementApi->
|
4811
|
+
puts "Exception when calling ManagementApi->update_attribute: #{e}"
|
4751
4812
|
end
|
4752
4813
|
```
|
4753
4814
|
|
@@ -4755,12 +4816,12 @@ end
|
|
4755
4816
|
|
4756
4817
|
Name | Type | Description | Notes
|
4757
4818
|
------------- | ------------- | ------------- | -------------
|
4758
|
-
**
|
4759
|
-
**body** | [**
|
4819
|
+
**attribute_id** | **Integer**| |
|
4820
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
4760
4821
|
|
4761
4822
|
### Return type
|
4762
4823
|
|
4763
|
-
|
4824
|
+
[**Attribute**](Attribute.md)
|
4764
4825
|
|
4765
4826
|
### Authorization
|
4766
4827
|
|