talon_one 9.0.0 → 11.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/.github/workflows/autorelease.yml +123 -0
- data/README.md +89 -9
- data/docker-compose.yml +2 -2
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +4 -2
- data/docs/AchievementBase.md +4 -2
- data/docs/AchievementProgressWithDefinition.md +4 -2
- data/docs/AchievementStatusEntry.md +4 -2
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCustomer.md +3 -3
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +3 -3
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/BestPriorPrice.md +27 -0
- data/docs/BestPriorPriceMetadata.md +19 -0
- data/docs/BestPriorPriceRequest.md +25 -0
- data/docs/BestPriorPriceRequestTarget.md +19 -0
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDeletedNotification.md +6 -4
- data/docs/CampaignDeletedNotificationItem.md +21 -0
- data/docs/CampaignEditedNotification.md +6 -6
- data/docs/CampaignEditedNotificationItem.md +23 -0
- data/docs/CampaignEvaluationTreeChangedMessage.md +21 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignNotificationBase.md +19 -0
- data/docs/CampaignNotificationGeneric.md +21 -0
- data/docs/CampaignNotificationItemBase.md +17 -0
- data/docs/CampaignNotificationPolicy.md +1 -1
- data/docs/CampaignRulesetChangedNotification.md +6 -6
- data/docs/CampaignRulesetChangedNotificationItem.md +23 -0
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CardAddedDeductedPointsNotification.md +45 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +1 -1
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/CardLedgerTransactionLogEntry.md +3 -1
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -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/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +4 -2
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +3 -3
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +7 -1
- 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/ExpiringCardPointsData.md +29 -0
- data/docs/ExpiringCardPointsNotification.md +21 -0
- data/docs/ExpiringCouponsData.md +35 -0
- data/docs/ExpiringCouponsNotification.md +21 -0
- data/docs/ExpiringCouponsNotificationPolicy.md +1 -1
- data/docs/ExpiringPointsData.md +25 -0
- data/docs/ExpiringPointsNotification.md +21 -0
- data/docs/ExpiringPointsNotificationPolicy.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/ExtendedCoupon.md +61 -0
- data/docs/GenerateAuditLogSummary.md +17 -0
- data/docs/GenerateCampaignDescription.md +3 -1
- data/docs/GenerateCouponFailureDetailedSummary.md +25 -0
- data/docs/GenerateCouponFailureSummary.md +19 -0
- data/docs/GenerateUserSessionSummary.md +19 -0
- data/docs/GetIntegrationCouponRequest.md +1 -1
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +4 -2
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +2 -4
- data/docs/InlineResponse20045.md +5 -3
- data/docs/InlineResponse20046.md +2 -4
- data/docs/InlineResponse20047.md +2 -6
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +91 -6
- 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/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +1819 -339
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +29 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +5 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +25 -0
- data/docs/PriceType.md +33 -0
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -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/RoleV2RolesGroup.md +3 -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/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeData.md +31 -0
- data/docs/TierDowngradeNotification.md +21 -0
- data/docs/TierDowngradeNotificationPolicy.md +1 -1
- data/docs/TierUpgradeData.md +35 -0
- data/docs/TierUpgradeNotification.md +21 -0
- data/docs/TierUpgradeNotificationPolicy.md +1 -1
- data/docs/TierWillDowngradeData.md +31 -0
- data/docs/TierWillDowngradeNotification.md +21 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +1 -1
- data/docs/UpdateAchievement.md +4 -2
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/User.md +1 -1
- data/docs/Webhook.md +6 -2
- 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 +5 -1
- data/lib/talon_one/api/integration_api.rb +110 -8
- data/lib/talon_one/api/management_api.rb +1123 -429
- 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/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +15 -5
- data/lib/talon_one/models/achievement_base.rb +17 -7
- data/lib/talon_one/models/achievement_progress_with_definition.rb +17 -7
- data/lib/talon_one/models/achievement_status_entry.rb +15 -5
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- 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/added_deducted_points_notification.rb +478 -0
- data/lib/talon_one/models/analytics_sku.rb +23 -3
- 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_customer.rb +3 -3
- 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/async_coupons_data.rb +272 -0
- 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 +3 -3
- data/lib/talon_one/models/audience_reference.rb +256 -0
- data/lib/talon_one/models/base_loyalty_program.rb +1 -1
- 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/best_prior_price.rb +285 -0
- data/lib/talon_one/models/best_prior_price_metadata.rb +219 -0
- data/lib/talon_one/models/best_prior_price_request.rb +268 -0
- data/lib/talon_one/models/best_prior_price_request_target.rb +257 -0
- 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_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_collection_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_created_notification.rb +30 -26
- data/lib/talon_one/models/campaign_created_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +33 -21
- data/lib/talon_one/models/campaign_deleted_notification_item.rb +242 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +239 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_notification_base.rb +227 -0
- data/lib/talon_one/models/campaign_notification_generic.rb +244 -0
- data/lib/talon_one/models/campaign_notification_item_base.rb +212 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +2 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +32 -23
- data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb +245 -0
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_state_changed_notification.rb +30 -42
- data/lib/talon_one/models/campaign_state_changed_notification_item.rb +266 -0
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_template.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +510 -0
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +16 -1
- 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/catalogs_strikethrough_notification_policy.rb +16 -4
- 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/coupons_notification_data.rb +278 -0
- data/lib/talon_one/models/coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/create_achievement.rb +17 -7
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +3 -3
- 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/deduct_loyalty_points.rb +0 -9
- data/lib/talon_one/models/delete_coupons_data.rb +310 -0
- data/lib/talon_one/models/effect.rb +31 -2
- 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/expiring_card_points_data.rb +342 -0
- data/lib/talon_one/models/expiring_card_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_data.rb +369 -0
- data/lib/talon_one/models/expiring_coupons_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/expiring_points_data.rb +291 -0
- data/lib/talon_one/models/expiring_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/extended_coupon.rb +578 -0
- data/lib/talon_one/models/generate_audit_log_summary.rb +212 -0
- data/lib/talon_one/models/generate_campaign_description.rb +16 -1
- data/lib/talon_one/models/generate_coupon_failure_detailed_summary.rb +286 -0
- data/lib/talon_one/models/generate_coupon_failure_summary.rb +222 -0
- data/lib/talon_one/models/generate_user_session_summary.rb +227 -0
- data/lib/talon_one/models/get_integration_coupon_request.rb +2 -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/import.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +11 -7
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +7 -11
- data/lib/talon_one/models/inline_response20045.rb +11 -7
- data/lib/talon_one/models/inline_response20046.rb +2 -21
- data/lib/talon_one/models/inline_response20047.rb +2 -25
- 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/jwt.rb +228 -0
- data/lib/talon_one/models/label_target_audience.rb +260 -0
- data/lib/talon_one/models/label_target_none.rb +246 -0
- 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_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +17 -2
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_dashboard_data.rb +16 -1
- data/lib/talon_one/models/loyalty_ledger_entry_expiry_date_change.rb +238 -0
- data/lib/talon_one/models/loyalty_program.rb +1 -1
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- 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_loyalty_program.rb +1 -1
- data/lib/talon_one/models/new_message_test.rb +28 -43
- data/lib/talon_one/models/new_price_adjustment.rb +297 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +29 -4
- data/lib/talon_one/models/pending_active_points_data.rb +308 -0
- data/lib/talon_one/models/pending_active_points_notification.rb +277 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +247 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/price_type_reference_detail.rb +286 -0
- data/lib/talon_one/models/price_type_references.rb +224 -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/role_v2_roles_group.rb +14 -4
- 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/secondary_deployment.rb +367 -0
- data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_changed_item.rb +13 -1
- data/lib/talon_one/models/strikethrough_effect.rb +46 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +19 -4
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/tier_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_upgrade_data.rb +353 -0
- data/lib/talon_one/models/tier_upgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_will_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_will_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/update_achievement.rb +17 -7
- 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/update_coupons_data.rb +296 -0
- data/lib/talon_one/models/update_loyalty_program.rb +1 -1
- data/lib/talon_one/models/update_price_type.rb +239 -0
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +30 -5
- 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 +27 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +73 -4
- data/spec/api/integration_api_spec.rb +26 -4
- data/spec/api/management_api_spec.rb +179 -51
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +7 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +7 -1
- data/spec/models/achievement_spec.rb +7 -1
- data/spec/models/achievement_status_entry_spec.rb +7 -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/added_deducted_points_notification_spec.rb +125 -0
- data/spec/models/analytics_sku_spec.rb +12 -0
- data/spec/models/async_coupons_data_spec.rb +65 -0
- data/spec/models/audience_reference_spec.rb +53 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/best_prior_price_metadata_spec.rb +47 -0
- data/spec/models/best_prior_price_request_spec.rb +65 -0
- data/spec/models/best_prior_price_request_target_spec.rb +51 -0
- data/spec/models/best_prior_price_spec.rb +71 -0
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_collection_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_collection_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_created_notification_item_spec.rb +59 -0
- data/spec/models/campaign_created_notification_spec.rb +3 -3
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_item_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +53 -0
- data/spec/models/campaign_notification_base_spec.rb +47 -0
- data/spec/models/campaign_notification_generic_spec.rb +53 -0
- data/spec/models/campaign_notification_item_base_spec.rb +41 -0
- data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +59 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_state_changed_notification_item_spec.rb +65 -0
- data/spec/models/campaign_state_changed_notification_spec.rb +3 -9
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/card_added_deducted_points_notification_spec.rb +137 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +6 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +7 -1
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -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/expiring_card_points_data_spec.rb +77 -0
- data/spec/models/expiring_card_points_notification_spec.rb +57 -0
- data/spec/models/expiring_coupons_data_spec.rb +95 -0
- data/spec/models/expiring_coupons_notification_spec.rb +57 -0
- data/spec/models/expiring_points_data_spec.rb +65 -0
- data/spec/models/expiring_points_notification_spec.rb +57 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/extended_coupon_spec.rb +173 -0
- data/spec/models/generate_audit_log_summary_spec.rb +41 -0
- data/spec/models/generate_campaign_description_spec.rb +6 -0
- data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +65 -0
- data/spec/models/generate_coupon_failure_summary_spec.rb +47 -0
- data/spec/models/generate_user_session_summary_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +6 -0
- data/spec/models/inline_response20044_spec.rb +0 -6
- data/spec/models/inline_response20045_spec.rb +6 -0
- data/spec/models/inline_response20046_spec.rb +0 -6
- data/spec/models/inline_response20047_spec.rb +0 -12
- 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/jwt_spec.rb +47 -0
- data/spec/models/label_target_audience_spec.rb +51 -0
- data/spec/models/label_target_none_spec.rb +45 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +53 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +10 -14
- data/spec/models/new_price_adjustment_spec.rb +77 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +12 -0
- data/spec/models/pending_active_points_data_spec.rb +77 -0
- data/spec/models/pending_active_points_notification_spec.rb +57 -0
- data/spec/models/price_detail_spec.rb +65 -0
- data/spec/models/price_type_reference_detail_spec.rb +63 -0
- data/spec/models/price_type_references_spec.rb +47 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -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/secondary_deployment_spec.rb +87 -0
- data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/strikethrough_changed_item_spec.rb +6 -0
- data/spec/models/strikethrough_effect_spec.rb +24 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/tier_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_downgrade_notification_spec.rb +57 -0
- data/spec/models/tier_upgrade_data_spec.rb +95 -0
- data/spec/models/tier_upgrade_notification_spec.rb +57 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_will_downgrade_notification_spec.rb +57 -0
- data/spec/models/update_achievement_spec.rb +7 -1
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- 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 +12 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +12 -0
- metadata +305 -3
- data/.github/dependabot.yml +0 -10
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
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::CouponsNotificationData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type_of_change** | **String** | The type of change that occurred. |
|
|
8
|
+
**operation** | **String** | The operation performed. |
|
|
9
|
+
**employee_name** | **String** | The name of the employee associated with the operation. |
|
|
10
|
+
**data** | [**Array<ExtendedCoupon>**](ExtendedCoupon.md) | A list of extended coupon data. | [optional]
|
|
11
|
+
**total_result_size** | **Integer** | | [optional]
|
|
12
|
+
**notification_type** | **String** | The type of the notification |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::CouponsNotificationData.new(type_of_change: campaign_manager,
|
|
20
|
+
operation: CouponUpdated,
|
|
21
|
+
employee_name: Franziska Schneider,
|
|
22
|
+
data: null,
|
|
23
|
+
total_result_size: 1,
|
|
24
|
+
notification_type: CouponUpdated)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**scopes** | **Array<String>** | |
|
|
9
9
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
10
10
|
**include_data** | **Boolean** | Indicates whether to include all generated coupons. If `false`, only the `batchId` of the generated coupons is included. | [optional]
|
|
11
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
11
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
data/docs/CreateAchievement.md
CHANGED
|
@@ -10,10 +10,11 @@ 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]
|
|
17
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = TalonOne::CreateAchievement.new(name: Order50Discount,
|
|
|
29
30
|
recurrence_policy: no_recurrence,
|
|
30
31
|
activation_policy: fixed_schedule,
|
|
31
32
|
fixed_start_date: null,
|
|
32
|
-
end_date: null
|
|
33
|
+
end_date: null,
|
|
34
|
+
allow_rollback_after_completion: false)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TalonOne::CreateCouponData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**Array<ExtendedCoupon>**](ExtendedCoupon.md) | The array of coupons codes. If 1000 or fewer coupons are requested, all coupon data is sent. If 1001 or more coupons are requested, only `BatchID` is sent. | [optional]
|
|
8
|
+
**total_result_size** | **Integer** | | [optional]
|
|
9
|
+
**batch_id** | **String** | The ID of the batch to which the coupon belongs. **Note:** The Batch ID is generated when coupons are created. | [optional]
|
|
10
|
+
**type_of_change** | **String** | |
|
|
11
|
+
**operation** | **String** | |
|
|
12
|
+
**employee_name** | **String** | |
|
|
13
|
+
**notification_type** | **String** | The type of the not |
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'TalonOne'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::CreateCouponData.new(data: [{id=1, created=2023-01-31T15:19:25.18417+01:00, campaignId=1, value=73KXKKFP, usageLimit=1, reservationLimit=0, usageCounter=0, attributes={}, reservation=true, batchId=nqylhnni}, {id=2, created=2023-01-31T15:19:25.18417+01:00, campaignId=1, value=BH3CXXLW, usageLimit=1, reservationLimit=0, usageCounter=0, attributes={}, reservation=true, batchId=nqylhnni}],
|
|
21
|
+
total_result_size: 1,
|
|
22
|
+
batch_id: haanlypn,
|
|
23
|
+
type_of_change: campaign_manager,
|
|
24
|
+
operation: AsyncCouponsCreated,
|
|
25
|
+
employee_name: Franziska Schneider,
|
|
26
|
+
notification_type: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
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,14 +4,14 @@
|
|
|
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
|
-
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED
|
|
14
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** 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]
|
|
16
16
|
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
|
|
17
17
|
**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [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. |
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::DeleteCouponsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type_of_change** | **String** | |
|
|
8
|
+
**operation** | **String** | |
|
|
9
|
+
**employee_name** | **String** | |
|
|
10
|
+
**batch_id** | **String** | |
|
|
11
|
+
**application_id** | **Integer** | |
|
|
12
|
+
**campaign_id** | **Integer** | |
|
|
13
|
+
**total_result_size** | **Integer** | |
|
|
14
|
+
**notification_type** | **String** | The type of the notification |
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::DeleteCouponsData.new(type_of_change: null,
|
|
22
|
+
operation: null,
|
|
23
|
+
employee_name: null,
|
|
24
|
+
batch_id: null,
|
|
25
|
+
application_id: null,
|
|
26
|
+
campaign_id: null,
|
|
27
|
+
total_result_size: null,
|
|
28
|
+
notification_type: null)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
data/docs/Effect.md
CHANGED
|
@@ -16,7 +16,10 @@ 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
|
-
**
|
|
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]
|
|
22
|
+
**props** | [**Object**](.md) | |
|
|
20
23
|
|
|
21
24
|
## Code Sample
|
|
22
25
|
|
|
@@ -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. |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TalonOne::ExpiringCardPointsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**expiry_date** | **Date** | The expiration date of loyalty points. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**amount_of_expiring_points** | **Float** | The amount of loyalty points that will be expired soon. |
|
|
10
|
+
**subledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added. |
|
|
11
|
+
**card_identifier** | **String** | The alphanumeric identifier of the loyalty card. |
|
|
12
|
+
**users_per_card_limit** | **Integer** | The maximum number of customer profiles with which a card can be shared. This can be set to `0` for no limit. |
|
|
13
|
+
**profiles** | **Array<String>** | The integration IDs of the customer profiles linked to the card. |
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'TalonOne'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::ExpiringCardPointsData.new(expiry_date: null,
|
|
21
|
+
loyalty_program_id: 5,
|
|
22
|
+
amount_of_expiring_points: 10.99,
|
|
23
|
+
subledger_id: sub-123,
|
|
24
|
+
card_identifier: summer-loyalty-card-0543,
|
|
25
|
+
users_per_card_limit: 5,
|
|
26
|
+
profiles: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::ExpiringCardPointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<ExpiringCardPointsData>**](ExpiringCardPointsData.md) | The array of expiring points. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::ExpiringCardPointsNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# TalonOne::ExpiringCouponsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**coupon_value** | **String** | The coupon code. |
|
|
8
|
+
**created_date** | **DateTime** | Timestamp at which point the coupon was created. | [optional]
|
|
9
|
+
**valid_from** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
+
**valid_until** | **DateTime** | Timestamp at which point the coupon expires. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
11
|
+
**campaign_id** | **Integer** | The ID of the campaign to which the coupon belongs. |
|
|
12
|
+
**customer_profile_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
|
|
13
|
+
**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. |
|
|
14
|
+
**usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. |
|
|
15
|
+
**batch_id** | **String** | The ID of the batch the coupon belongs to. | [optional]
|
|
16
|
+
**attributes** | [**Object**](.md) | Custom attributes associated with this coupon. |
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'TalonOne'
|
|
22
|
+
|
|
23
|
+
instance = TalonOne::ExpiringCouponsData.new(coupon_value: XMAS-20-2021,
|
|
24
|
+
created_date: 2024-07-24T14:15:22Z,
|
|
25
|
+
valid_from: 2024-10-24T14:15:22Z,
|
|
26
|
+
valid_until: 2024-12-24T14:15:22Z,
|
|
27
|
+
campaign_id: 3,
|
|
28
|
+
customer_profile_id: URNGV8294NV,
|
|
29
|
+
usage_limit: 100,
|
|
30
|
+
usage_counter: 10,
|
|
31
|
+
batch_id: 32535-43255,
|
|
32
|
+
attributes: null)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::ExpiringCouponsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<ExpiringCouponsData>**](ExpiringCouponsData.md) | The array of expiring coupon notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::ExpiringCouponsNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**triggers** | [**Array<ExpiringCouponsNotificationTrigger>**](ExpiringCouponsNotificationTrigger.md) | |
|
|
9
9
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
10
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
10
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::ExpiringPointsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**expiry_date** | **Date** | The expiration date of loyalty points. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile that has expiring points. |
|
|
10
|
+
**amount_of_expiring_points** | **Float** | The amount of loyalty points that will be expired soon. |
|
|
11
|
+
**subledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added. |
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::ExpiringPointsData.new(expiry_date: null,
|
|
19
|
+
loyalty_program_id: 5,
|
|
20
|
+
customer_profile_id: URNGV8294NV,
|
|
21
|
+
amount_of_expiring_points: 10.99,
|
|
22
|
+
subledger_id: sub-123)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::ExpiringPointsNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<ExpiringPointsData>**](ExpiringPointsData.md) | The array of expiring points. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::ExpiringPointsNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**triggers** | [**Array<ExpiringPointsNotificationTrigger>**](ExpiringPointsNotificationTrigger.md) | |
|
|
9
9
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
10
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
10
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
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,23 @@
|
|
|
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
|
+
**affected_transactions** | [**Array<LoyaltyLedgerEntryExpiryDateChange>**](LoyaltyLedgerEntryExpiryDateChange.md) | List of transactions affected by the expiry date update. | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps.new(program_id: null,
|
|
18
|
+
sub_ledger_id: null,
|
|
19
|
+
extension_duration: 12h,
|
|
20
|
+
affected_transactions: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# TalonOne::ExtendedCoupon
|
|
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
|
+
**campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
|
|
10
|
+
**value** | **String** | The coupon code. |
|
|
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. |
|
|
12
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
13
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
14
|
+
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
15
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
|
|
16
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
|
17
|
+
**usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. |
|
|
18
|
+
**discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional]
|
|
19
|
+
**discount_remainder** | **Float** | The remaining discount this coupon can give. | [optional]
|
|
20
|
+
**reservation_counter** | **Float** | The number of times this coupon has been reserved. | [optional]
|
|
21
|
+
**attributes** | [**Object**](.md) | Custom attributes associated with this coupon. | [optional]
|
|
22
|
+
**referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
|
|
23
|
+
**recipient_integration_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
|
|
24
|
+
**import_id** | **Integer** | The ID of the Import which created this coupon. | [optional]
|
|
25
|
+
**reservation** | **Boolean** | Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code. | [optional] [default to true]
|
|
26
|
+
**batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
|
|
27
|
+
**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
|
|
28
|
+
**implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
|
|
29
|
+
**application_id** | **Integer** | The ID of the application. |
|
|
30
|
+
|
|
31
|
+
## Code Sample
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
require 'TalonOne'
|
|
35
|
+
|
|
36
|
+
instance = TalonOne::ExtendedCoupon.new(id: 6,
|
|
37
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
38
|
+
campaign_id: 211,
|
|
39
|
+
value: XMAS-20-2021,
|
|
40
|
+
usage_limit: 100,
|
|
41
|
+
discount_limit: 30.0,
|
|
42
|
+
reservation_limit: 45,
|
|
43
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
44
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
45
|
+
limits: null,
|
|
46
|
+
usage_counter: 10,
|
|
47
|
+
discount_counter: 10.0,
|
|
48
|
+
discount_remainder: 5.0,
|
|
49
|
+
reservation_counter: 1.0,
|
|
50
|
+
attributes: null,
|
|
51
|
+
referral_id: 326632952,
|
|
52
|
+
recipient_integration_id: URNGV8294NV,
|
|
53
|
+
import_id: 4,
|
|
54
|
+
reservation: false,
|
|
55
|
+
batch_id: 32535-43255,
|
|
56
|
+
is_reservation_mandatory: false,
|
|
57
|
+
implicitly_reserved: false,
|
|
58
|
+
application_id: null)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::GenerateAuditLogSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**log_id** | **Integer** | The ID of the audit log. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::GenerateAuditLogSummary.new(log_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**campaign_id** | **Integer** | ID of a campaign. |
|
|
7
8
|
**ruleset_id** | **Integer** | ID of a ruleset. |
|
|
8
9
|
**currency** | **String** | Currency for the campaign. |
|
|
9
10
|
|
|
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
|
|
|
12
13
|
```ruby
|
|
13
14
|
require 'TalonOne'
|
|
14
15
|
|
|
15
|
-
instance = TalonOne::GenerateCampaignDescription.new(
|
|
16
|
+
instance = TalonOne::GenerateCampaignDescription.new(campaign_id: null,
|
|
17
|
+
ruleset_id: null,
|
|
16
18
|
currency: null)
|
|
17
19
|
```
|
|
18
20
|
|