talon_one 8.0.0 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -8
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/Achievement.md +2 -2
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +4 -2
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CreateAchievement.md +1 -1
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/Effect.md +6 -0
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20048.md +17 -0
- data/docs/InlineResponse20049.md +17 -0
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +6 -4
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +824 -220
- data/docs/MessageTest.md +27 -0
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewMessageTest.md +29 -0
- data/docs/NewPriceAdjustment.md +27 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewWebhook.md +2 -0
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +23 -0
- data/docs/PriceType.md +33 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/docs/TemplateDef.md +1 -1
- data/docs/UpdateAchievement.md +1 -1
- data/docs/User.md +1 -1
- data/docs/Webhook.md +3 -1
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
- data/lib/talon_one/api/integration_api.rb +9 -6
- data/lib/talon_one/api/management_api.rb +1009 -304
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/achievement.rb +4 -4
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_cif_references.rb +219 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +2 -2
- data/lib/talon_one/models/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.rb +1 -1
- data/lib/talon_one/models/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +17 -5
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- data/lib/talon_one/models/create_achievement.rb +3 -3
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +2 -2
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.rb +1 -1
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/effect.rb +31 -1
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -0
- data/lib/talon_one/models/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +208 -0
- data/lib/talon_one/models/inline_response20049.rb +208 -0
- data/lib/talon_one/models/inline_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/message_test.rb +227 -0
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/new_price_adjustment.rb +268 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_webhook.rb +16 -1
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +237 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/update_achievement.rb +3 -3
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +17 -2
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +17 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +26 -1
- data/spec/api/integration_api_spec.rb +4 -3
- data/spec/api/management_api_spec.rb +227 -90
- data/spec/models/achievement_base_spec.rb +1 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
- data/spec/models/achievement_spec.rb +1 -1
- data/spec/models/achievement_status_entry_spec.rb +1 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/create_achievement_spec.rb +1 -1
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
- data/spec/models/inline_response20048_spec.rb +0 -6
- data/spec/models/inline_response20049_spec.rb +0 -6
- data/spec/models/inline_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +1 -1
- data/spec/models/new_price_adjustment_spec.rb +71 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/price_detail_spec.rb +59 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +1 -1
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +661 -527
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
10
10
|
**url** | **String** | API URL for the given webhook-based notification. |
|
data/docs/Binding.md
CHANGED
@@ -8,6 +8,10 @@ Name | Type | Description | Notes
|
|
8
8
|
**type** | **String** | The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` | [optional]
|
9
9
|
**expression** | **Array<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. |
|
10
10
|
**value_type** | **String** | Can be one of the following: - `string` - `number` - `boolean` | [optional]
|
11
|
+
**min_value** | **Float** | The minimum value allowed for this placeholder. | [optional]
|
12
|
+
**max_value** | **Float** | The maximum value allowed for this placeholder. | [optional]
|
13
|
+
**attribute_id** | **Integer** | Id of the attribute attached to the placeholder. | [optional]
|
14
|
+
**description** | **String** | Describes the placeholder field and value in the template. This description can be used when creating campaigns from this template. | [optional]
|
11
15
|
|
12
16
|
## Code Sample
|
13
17
|
|
@@ -17,7 +21,11 @@ require 'TalonOne'
|
|
17
21
|
instance = TalonOne::Binding.new(name: my property,
|
18
22
|
type: templateParameter,
|
19
23
|
expression: [string1, string2],
|
20
|
-
value_type: string
|
24
|
+
value_type: string,
|
25
|
+
min_value: 0.0,
|
26
|
+
max_value: 19.9,
|
27
|
+
attribute_id: 100,
|
28
|
+
description: This is a template parameter of type `number`.)
|
21
29
|
```
|
22
30
|
|
23
31
|
|
data/docs/CampaignCollection.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::CampaignDeactivationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**user_ids** | **Array<Integer>** | The list of IDs of the users receiving the deactivation request emails. |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::CampaignDeactivationRequest.new(user_ids: [1, 2, 3])
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CampaignDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**campaign_id** | **Integer** | The ID of the campaign that references the application cart item filter. | [optional]
|
8
|
+
**campaign_name** | **String** | A user-facing name for this campaign. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CampaignDetail.new(campaign_id: 1,
|
16
|
+
campaign_name: Summer promotions)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CampaignGroup.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
data/docs/CampaignSet.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
8
|
-
**id** | **Integer** |
|
8
|
+
**id** | **Integer** | The internal ID of this entity. |
|
9
9
|
**version** | **Integer** | Version of the campaign set. |
|
10
10
|
**set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | |
|
11
11
|
**updated_by** | **String** | Name of the user who last updated this campaign set, if available. | [optional]
|
data/docs/CampaignStoreBudget.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
|
10
10
|
**store_id** | **Integer** | The ID of the store. |
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# TalonOne::CampaignStoreBudgetLimitConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` |
|
8
|
+
**limit** | **Float** | The value to set for the limit. |
|
9
|
+
**period** | **String** | The period on which the budget limit recurs. | [optional]
|
10
|
+
**entities** | **Array<String>** | The entity that this limit applies to. |
|
11
|
+
**imported** | **Boolean** | Indicates whether this limit configuration is managed via a CSV file. |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'TalonOne'
|
17
|
+
|
18
|
+
instance = TalonOne::CampaignStoreBudgetLimitConfig.new(action: createCoupon,
|
19
|
+
limit: 1000.0,
|
20
|
+
period: yearly,
|
21
|
+
entities: [Coupon],
|
22
|
+
imported: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/CampaignTemplate.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
|
29
29
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign template or any of its elements. | [optional]
|
30
30
|
**updated_by** | **String** | Name of the user who last updated this campaign template, if available. | [optional]
|
31
31
|
**valid_application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. |
|
32
|
+
**is_user_favorite** | **Boolean** | A flag indicating whether the user marked the template as a favorite. | [optional] [default to false]
|
32
33
|
|
33
34
|
## Code Sample
|
34
35
|
|
@@ -59,7 +60,8 @@ instance = TalonOne::CampaignTemplate.new(id: 6,
|
|
59
60
|
campaign_type: advanced,
|
60
61
|
updated: 2022-08-24T14:15:22Z,
|
61
62
|
updated_by: Jane Doe,
|
62
|
-
valid_application_ids: [1, 2, 3]
|
63
|
+
valid_application_ids: [1, 2, 3],
|
64
|
+
is_user_favorite: false)
|
63
65
|
```
|
64
66
|
|
65
67
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Notification name. |
|
8
|
+
**scopes** | **Array<String>** | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CardAddedDeductedPointsBalancesNotificationPolicy.new(name: Christmas Sale,
|
16
|
+
scopes: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CartItem.md
CHANGED
@@ -19,7 +19,12 @@ Name | Type | Description | Notes
|
|
19
19
|
**position** | **Float** | Position of the Cart Item in the Cart (calculated internally). | [optional]
|
20
20
|
**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. | [optional]
|
21
21
|
**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
|
22
|
-
**catalog_item_id** | **Integer** | The
|
22
|
+
**catalog_item_id** | **Integer** | The catalog item ID. | [optional]
|
23
|
+
**selected_price_type** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional]
|
24
|
+
**adjustment_reference_id** | **String** | The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. | [optional]
|
25
|
+
**adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional]
|
26
|
+
**adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional]
|
27
|
+
**prices** | [**Hash<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names. | [optional]
|
23
28
|
|
24
29
|
## Code Sample
|
25
30
|
|
@@ -41,7 +46,12 @@ instance = TalonOne::CartItem.new(name: Air Glide,
|
|
41
46
|
position: null,
|
42
47
|
attributes: {"image":"11.jpeg","material":"leather"},
|
43
48
|
additional_costs: {"shipping":{"price":9}},
|
44
|
-
catalog_item_id: null
|
49
|
+
catalog_item_id: null,
|
50
|
+
selected_price_type: member,
|
51
|
+
adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
|
52
|
+
adjustment_effective_from: 2021-09-12T10:12:42Z,
|
53
|
+
adjustment_effective_until: 2021-09-12T10:12:42Z,
|
54
|
+
prices: {"member":{"price":90,"adjustmentReferenceId":"68851723-e6fa-488f-ace9-112581e6c19b","effectiveFrom":"2025-05-25T00:00:00Z","effectiveUntil":"2025-05-30T00:00:00Z"},"base":{"price":100}})
|
45
55
|
```
|
46
56
|
|
47
57
|
|
data/docs/Catalog.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
data/docs/CatalogItem.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**sku** | **String** | The stock keeping unit of the item. |
|
10
10
|
**price** | **Float** | Price of the item. | [optional]
|
data/docs/Change.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
10
10
|
**application_id** | **Integer** | ID of application associated with change. | [optional]
|
data/docs/Collection.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
data/docs/Coupon.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
8
|
-
**created** | **DateTime** | The time
|
7
|
+
**id** | **Integer** | The internal ID of the coupon. |
|
8
|
+
**created** | **DateTime** | The time the coupon was created. |
|
9
9
|
**campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
|
10
10
|
**value** | **String** | The coupon code. |
|
11
11
|
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
|
data/docs/CouponCreationJob.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
|
10
10
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
data/docs/CouponDeletionJob.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CouponEntity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | The internal ID of the coupon. |
|
8
|
+
**created** | **DateTime** | The time the coupon was created. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CouponEntity.new(id: 6,
|
16
|
+
created: 2020-06-10T09:05:27.993483Z)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CreateAchievement.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
|
11
11
|
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
12
12
|
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
13
|
-
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
|
13
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
14
14
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
15
15
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
16
16
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
data/docs/CustomEffect.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**modified** | **DateTime** | The time this entity was last modified. |
|
data/docs/CustomerProfile.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
10
10
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
11
11
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
12
|
-
**closed_sessions** | **Integer** | The total
|
12
|
+
**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
|
13
13
|
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
14
14
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
15
15
|
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CustomerProfileEntity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
8
|
+
**created** | **DateTime** | The time the customer profile was created. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CustomerProfileEntity.new(id: 6,
|
16
|
+
created: 2020-06-10T09:05:27.993483Z)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CustomerSessionV2.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**integration_id** | **String** | The integration ID set by your integration layer. |
|
10
10
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
data/docs/Effect.md
CHANGED
@@ -16,6 +16,9 @@ Name | Type | Description | Notes
|
|
16
16
|
**evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
|
17
17
|
**campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional]
|
18
18
|
**campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
|
19
|
+
**selected_price_type** | **String** | The selected price type for the SKU targeted by this effect. | [optional]
|
20
|
+
**selected_price** | **Float** | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional]
|
21
|
+
**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional]
|
19
22
|
**props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
20
23
|
|
21
24
|
## Code Sample
|
@@ -35,6 +38,9 @@ instance = TalonOne::Effect.new(campaign_id: 244,
|
|
35
38
|
evaluation_group_mode: stackable,
|
36
39
|
campaign_revision_id: 1,
|
37
40
|
campaign_revision_version_id: 5,
|
41
|
+
selected_price_type: member,
|
42
|
+
selected_price: 100.0,
|
43
|
+
adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
|
38
44
|
props: null)
|
39
45
|
```
|
40
46
|
|
data/docs/EffectEntity.md
CHANGED
@@ -16,6 +16,9 @@ Name | Type | Description | Notes
|
|
16
16
|
**evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
|
17
17
|
**campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional]
|
18
18
|
**campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional]
|
19
|
+
**selected_price_type** | **String** | The selected price type for the SKU targeted by this effect. | [optional]
|
20
|
+
**selected_price** | **Float** | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional]
|
21
|
+
**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional]
|
19
22
|
|
20
23
|
## Code Sample
|
21
24
|
|
@@ -33,7 +36,10 @@ instance = TalonOne::EffectEntity.new(campaign_id: 244,
|
|
33
36
|
evaluation_group_id: 3,
|
34
37
|
evaluation_group_mode: stackable,
|
35
38
|
campaign_revision_id: 1,
|
36
|
-
campaign_revision_version_id: 5
|
39
|
+
campaign_revision_version_id: 5,
|
40
|
+
selected_price_type: member,
|
41
|
+
selected_price: 100.0,
|
42
|
+
adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b)
|
37
43
|
```
|
38
44
|
|
39
45
|
|
data/docs/Entity.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
|
10
10
|
## Code Sample
|
data/docs/Environment.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
10
10
|
**slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. |
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
19
19
|
**audiences** | [**Array<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional]
|
20
20
|
**collections** | [**Array<Collection>**](Collection.md) | The account-level collections that the application is subscribed to. | [optional]
|
21
21
|
**application_cart_item_filters** | [**Array<ApplicationCIF>**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional]
|
22
|
+
**price_types** | [**Array<PriceType>**](PriceType.md) | The price types that this Application can use. | [optional]
|
22
23
|
|
23
24
|
## Code Sample
|
24
25
|
|
@@ -39,7 +40,8 @@ instance = TalonOne::Environment.new(id: 6,
|
|
39
40
|
additional_costs: null,
|
40
41
|
audiences: null,
|
41
42
|
collections: null,
|
42
|
-
application_cart_item_filters: null
|
43
|
+
application_cart_item_filters: null,
|
44
|
+
price_types: null)
|
43
45
|
```
|
44
46
|
|
45
47
|
|
data/docs/Event.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
10
10
|
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
data/docs/EventType.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**title** | **String** | The human-friendly name for this event type. |
|
10
10
|
**name** | **String** | The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created. |
|
data/docs/Export.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**program_id** | **Integer** | ID of the loyalty program that contains these points. |
|
8
|
+
**sub_ledger_id** | **String** | API name of the loyalty program subledger that contains these points. added. |
|
9
|
+
**extension_duration** | **String** | Time frame by which the expiry date extends. The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. |
|
10
|
+
**transaction_uui_ds** | **Array<String>** | The list of identifiers of transactions affected affected by the extension. | [optional]
|
11
|
+
**previous_expiration_date** | **DateTime** | Expiry date before applying the extension. |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'TalonOne'
|
17
|
+
|
18
|
+
instance = TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps.new(program_id: null,
|
19
|
+
sub_ledger_id: null,
|
20
|
+
extension_duration: 12h,
|
21
|
+
transaction_uui_ds: null,
|
22
|
+
previous_expiration_date: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
data/docs/Giveaway.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**code** | **String** | The code value of this giveaway. |
|
10
10
|
**pool_id** | **Integer** | The ID of the pool to return giveaway codes from. |
|
data/docs/GiveawaysPool.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**name** | **String** | The name of this giveaways pool. |
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::HiddenConditionsEffects
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**built_in_effects** | **Array<String>** | List of hidden built-in effects. | [optional]
|
8
|
+
**conditions** | **Array<String>** | List of hidden conditions. | [optional]
|
9
|
+
**custom_effects** | **Array<Integer>** | List of the IDs of hidden custom effects. | [optional]
|
10
|
+
**webhooks** | **Array<Integer>** | List of the IDs of hidden webhooks. | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::HiddenConditionsEffects.new(built_in_effects: [addFreeItem, createNotification],
|
18
|
+
conditions: [checkAttributeValue, couponCodeIsValid],
|
19
|
+
custom_effects: [1, 2],
|
20
|
+
webhooks: [3, 4])
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/Import.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**id** | **Integer** |
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
10
10
|
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::InlineResponse20048
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | [**Array<ListCampaignStoreBudgets>**](ListCampaignStoreBudgets.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::InlineResponse20048.new(data: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|