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
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Talon.One API
|
|
3
|
+
|
|
4
|
+
#Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document:
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 4.3.1
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
|
|
15
|
+
module TalonOne
|
|
16
|
+
class TierWillDowngradeData
|
|
17
|
+
# The integration ID of the customer profile whose tier was downgraded.
|
|
18
|
+
attr_accessor :customer_profile_id
|
|
19
|
+
|
|
20
|
+
# The ID of the loyalty program.
|
|
21
|
+
attr_accessor :loyalty_program_id
|
|
22
|
+
|
|
23
|
+
# The ID of the subledger, when applicable. If this field is empty, the main ledger is used.
|
|
24
|
+
attr_accessor :subledger_id
|
|
25
|
+
|
|
26
|
+
# The name of the customer's current tier.
|
|
27
|
+
attr_accessor :current_tier
|
|
28
|
+
|
|
29
|
+
# The number of points the customer will have after the tier downgrade.
|
|
30
|
+
attr_accessor :current_points
|
|
31
|
+
|
|
32
|
+
# The number of points needed for a customer to remain on the same tier.
|
|
33
|
+
attr_accessor :points_required_to_remain
|
|
34
|
+
|
|
35
|
+
# The name of the customer's next tier.
|
|
36
|
+
attr_accessor :next_tier
|
|
37
|
+
|
|
38
|
+
# The date and time the tier expires.
|
|
39
|
+
attr_accessor :tier_expiration_date
|
|
40
|
+
|
|
41
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
42
|
+
def self.attribute_map
|
|
43
|
+
{
|
|
44
|
+
:'customer_profile_id' => :'CustomerProfileID',
|
|
45
|
+
:'loyalty_program_id' => :'LoyaltyProgramID',
|
|
46
|
+
:'subledger_id' => :'SubledgerID',
|
|
47
|
+
:'current_tier' => :'CurrentTier',
|
|
48
|
+
:'current_points' => :'CurrentPoints',
|
|
49
|
+
:'points_required_to_remain' => :'PointsRequiredToRemain',
|
|
50
|
+
:'next_tier' => :'NextTier',
|
|
51
|
+
:'tier_expiration_date' => :'TierExpirationDate'
|
|
52
|
+
}
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Attribute type mapping.
|
|
56
|
+
def self.openapi_types
|
|
57
|
+
{
|
|
58
|
+
:'customer_profile_id' => :'String',
|
|
59
|
+
:'loyalty_program_id' => :'Integer',
|
|
60
|
+
:'subledger_id' => :'String',
|
|
61
|
+
:'current_tier' => :'String',
|
|
62
|
+
:'current_points' => :'Float',
|
|
63
|
+
:'points_required_to_remain' => :'Float',
|
|
64
|
+
:'next_tier' => :'String',
|
|
65
|
+
:'tier_expiration_date' => :'DateTime'
|
|
66
|
+
}
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# List of attributes with nullable: true
|
|
70
|
+
def self.openapi_nullable
|
|
71
|
+
Set.new([
|
|
72
|
+
])
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Initializes the object
|
|
76
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
77
|
+
def initialize(attributes = {})
|
|
78
|
+
if (!attributes.is_a?(Hash))
|
|
79
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::TierWillDowngradeData` initialize method"
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
83
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
84
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
85
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::TierWillDowngradeData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
86
|
+
end
|
|
87
|
+
h[k.to_sym] = v
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
if attributes.key?(:'customer_profile_id')
|
|
91
|
+
self.customer_profile_id = attributes[:'customer_profile_id']
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
if attributes.key?(:'loyalty_program_id')
|
|
95
|
+
self.loyalty_program_id = attributes[:'loyalty_program_id']
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
if attributes.key?(:'subledger_id')
|
|
99
|
+
self.subledger_id = attributes[:'subledger_id']
|
|
100
|
+
else
|
|
101
|
+
self.subledger_id = ''
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
if attributes.key?(:'current_tier')
|
|
105
|
+
self.current_tier = attributes[:'current_tier']
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
if attributes.key?(:'current_points')
|
|
109
|
+
self.current_points = attributes[:'current_points']
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.key?(:'points_required_to_remain')
|
|
113
|
+
self.points_required_to_remain = attributes[:'points_required_to_remain']
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
if attributes.key?(:'next_tier')
|
|
117
|
+
self.next_tier = attributes[:'next_tier']
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
if attributes.key?(:'tier_expiration_date')
|
|
121
|
+
self.tier_expiration_date = attributes[:'tier_expiration_date']
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
126
|
+
# @return Array for valid properties with the reasons
|
|
127
|
+
def list_invalid_properties
|
|
128
|
+
invalid_properties = Array.new
|
|
129
|
+
if @customer_profile_id.nil?
|
|
130
|
+
invalid_properties.push('invalid value for "customer_profile_id", customer_profile_id cannot be nil.')
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
if @loyalty_program_id.nil?
|
|
134
|
+
invalid_properties.push('invalid value for "loyalty_program_id", loyalty_program_id cannot be nil.')
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
if @loyalty_program_id < 1
|
|
138
|
+
invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
if @subledger_id.nil?
|
|
142
|
+
invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
if @current_tier.nil?
|
|
146
|
+
invalid_properties.push('invalid value for "current_tier", current_tier cannot be nil.')
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
if @current_points.nil?
|
|
150
|
+
invalid_properties.push('invalid value for "current_points", current_points cannot be nil.')
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
if @points_required_to_remain.nil?
|
|
154
|
+
invalid_properties.push('invalid value for "points_required_to_remain", points_required_to_remain cannot be nil.')
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
invalid_properties
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Check to see if the all the properties in the model are valid
|
|
161
|
+
# @return true if the model is valid
|
|
162
|
+
def valid?
|
|
163
|
+
return false if @customer_profile_id.nil?
|
|
164
|
+
return false if @loyalty_program_id.nil?
|
|
165
|
+
return false if @loyalty_program_id < 1
|
|
166
|
+
return false if @subledger_id.nil?
|
|
167
|
+
return false if @current_tier.nil?
|
|
168
|
+
return false if @current_points.nil?
|
|
169
|
+
return false if @points_required_to_remain.nil?
|
|
170
|
+
true
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Custom attribute writer method with validation
|
|
174
|
+
# @param [Object] loyalty_program_id Value to be assigned
|
|
175
|
+
def loyalty_program_id=(loyalty_program_id)
|
|
176
|
+
if loyalty_program_id.nil?
|
|
177
|
+
fail ArgumentError, 'loyalty_program_id cannot be nil'
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
if loyalty_program_id < 1
|
|
181
|
+
fail ArgumentError, 'invalid value for "loyalty_program_id", must be greater than or equal to 1.'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
@loyalty_program_id = loyalty_program_id
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# Checks equality by comparing each attribute.
|
|
188
|
+
# @param [Object] Object to be compared
|
|
189
|
+
def ==(o)
|
|
190
|
+
return true if self.equal?(o)
|
|
191
|
+
self.class == o.class &&
|
|
192
|
+
customer_profile_id == o.customer_profile_id &&
|
|
193
|
+
loyalty_program_id == o.loyalty_program_id &&
|
|
194
|
+
subledger_id == o.subledger_id &&
|
|
195
|
+
current_tier == o.current_tier &&
|
|
196
|
+
current_points == o.current_points &&
|
|
197
|
+
points_required_to_remain == o.points_required_to_remain &&
|
|
198
|
+
next_tier == o.next_tier &&
|
|
199
|
+
tier_expiration_date == o.tier_expiration_date
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
# @see the `==` method
|
|
203
|
+
# @param [Object] Object to be compared
|
|
204
|
+
def eql?(o)
|
|
205
|
+
self == o
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# Calculates hash code according to all attributes.
|
|
209
|
+
# @return [Integer] Hash code
|
|
210
|
+
def hash
|
|
211
|
+
[customer_profile_id, loyalty_program_id, subledger_id, current_tier, current_points, points_required_to_remain, next_tier, tier_expiration_date].hash
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
# Builds the object from hash
|
|
215
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
216
|
+
# @return [Object] Returns the model itself
|
|
217
|
+
def self.build_from_hash(attributes)
|
|
218
|
+
new.build_from_hash(attributes)
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# Builds the object from hash
|
|
222
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
223
|
+
# @return [Object] Returns the model itself
|
|
224
|
+
def build_from_hash(attributes)
|
|
225
|
+
return nil unless attributes.is_a?(Hash)
|
|
226
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
227
|
+
if type =~ /\AArray<(.*)>/i
|
|
228
|
+
# check to ensure the input is an array given that the attribute
|
|
229
|
+
# is documented as an array but the input is not
|
|
230
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
231
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
232
|
+
end
|
|
233
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
234
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
235
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
self
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Deserializes the data based on type
|
|
242
|
+
# @param string type Data type
|
|
243
|
+
# @param string value Value to be deserialized
|
|
244
|
+
# @return [Object] Deserialized data
|
|
245
|
+
def _deserialize(type, value)
|
|
246
|
+
case type.to_sym
|
|
247
|
+
when :DateTime
|
|
248
|
+
DateTime.parse(value)
|
|
249
|
+
when :Date
|
|
250
|
+
Date.parse(value)
|
|
251
|
+
when :String
|
|
252
|
+
value.to_s
|
|
253
|
+
when :Integer
|
|
254
|
+
value.to_i
|
|
255
|
+
when :Float
|
|
256
|
+
value.to_f
|
|
257
|
+
when :Boolean
|
|
258
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
259
|
+
true
|
|
260
|
+
else
|
|
261
|
+
false
|
|
262
|
+
end
|
|
263
|
+
when :Object
|
|
264
|
+
# generic object (usually a Hash), return directly
|
|
265
|
+
value
|
|
266
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
267
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
268
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
269
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
270
|
+
k_type = Regexp.last_match[:k_type]
|
|
271
|
+
v_type = Regexp.last_match[:v_type]
|
|
272
|
+
{}.tap do |hash|
|
|
273
|
+
value.each do |k, v|
|
|
274
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
275
|
+
end
|
|
276
|
+
end
|
|
277
|
+
else # model
|
|
278
|
+
TalonOne.const_get(type).build_from_hash(value)
|
|
279
|
+
end
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# Returns the string representation of the object
|
|
283
|
+
# @return [String] String presentation of the object
|
|
284
|
+
def to_s
|
|
285
|
+
to_hash.to_s
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
289
|
+
# @return [Hash] Returns the object in the form of hash
|
|
290
|
+
def to_body
|
|
291
|
+
to_hash
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Returns the object in the form of hash
|
|
295
|
+
# @return [Hash] Returns the object in the form of hash
|
|
296
|
+
def to_hash
|
|
297
|
+
hash = {}
|
|
298
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
299
|
+
value = self.send(attr)
|
|
300
|
+
if value.nil?
|
|
301
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
302
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
hash[param] = _to_hash(value)
|
|
306
|
+
end
|
|
307
|
+
hash
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# Outputs non-array value in the form of hash
|
|
311
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
312
|
+
# @param [Object] value Any valid value
|
|
313
|
+
# @return [Hash] Returns the value in the form of hash
|
|
314
|
+
def _to_hash(value)
|
|
315
|
+
if value.is_a?(Array)
|
|
316
|
+
value.compact.map { |v| _to_hash(v) }
|
|
317
|
+
elsif value.is_a?(Hash)
|
|
318
|
+
{}.tap do |hash|
|
|
319
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
320
|
+
end
|
|
321
|
+
elsif value.respond_to? :to_hash
|
|
322
|
+
value.to_hash
|
|
323
|
+
else
|
|
324
|
+
value
|
|
325
|
+
end
|
|
326
|
+
end
|
|
327
|
+
end
|
|
328
|
+
end
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Talon.One API
|
|
3
|
+
|
|
4
|
+
#Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document:
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 4.3.1
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
|
|
15
|
+
module TalonOne
|
|
16
|
+
class TierWillDowngradeNotification
|
|
17
|
+
attr_accessor :total_result_size
|
|
18
|
+
|
|
19
|
+
# The array of upcoming tier downgrade notifications.
|
|
20
|
+
attr_accessor :data
|
|
21
|
+
|
|
22
|
+
# The type of notification.
|
|
23
|
+
attr_accessor :notification_type
|
|
24
|
+
|
|
25
|
+
class EnumAttributeValidator
|
|
26
|
+
attr_reader :datatype
|
|
27
|
+
attr_reader :allowable_values
|
|
28
|
+
|
|
29
|
+
def initialize(datatype, allowable_values)
|
|
30
|
+
@allowable_values = allowable_values.map do |value|
|
|
31
|
+
case datatype.to_s
|
|
32
|
+
when /Integer/i
|
|
33
|
+
value.to_i
|
|
34
|
+
when /Float/i
|
|
35
|
+
value.to_f
|
|
36
|
+
else
|
|
37
|
+
value
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def valid?(value)
|
|
43
|
+
!value || allowable_values.include?(value)
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
48
|
+
def self.attribute_map
|
|
49
|
+
{
|
|
50
|
+
:'total_result_size' => :'TotalResultSize',
|
|
51
|
+
:'data' => :'Data',
|
|
52
|
+
:'notification_type' => :'NotificationType'
|
|
53
|
+
}
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Attribute type mapping.
|
|
57
|
+
def self.openapi_types
|
|
58
|
+
{
|
|
59
|
+
:'total_result_size' => :'Integer',
|
|
60
|
+
:'data' => :'Array<TierWillDowngradeData>',
|
|
61
|
+
:'notification_type' => :'String'
|
|
62
|
+
}
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# List of attributes with nullable: true
|
|
66
|
+
def self.openapi_nullable
|
|
67
|
+
Set.new([
|
|
68
|
+
])
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# Initializes the object
|
|
72
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
73
|
+
def initialize(attributes = {})
|
|
74
|
+
if (!attributes.is_a?(Hash))
|
|
75
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::TierWillDowngradeNotification` initialize method"
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
79
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
80
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
81
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::TierWillDowngradeNotification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
82
|
+
end
|
|
83
|
+
h[k.to_sym] = v
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
if attributes.key?(:'total_result_size')
|
|
87
|
+
self.total_result_size = attributes[:'total_result_size']
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
if attributes.key?(:'data')
|
|
91
|
+
if (value = attributes[:'data']).is_a?(Array)
|
|
92
|
+
self.data = value
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
if attributes.key?(:'notification_type')
|
|
97
|
+
self.notification_type = attributes[:'notification_type']
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
102
|
+
# @return Array for valid properties with the reasons
|
|
103
|
+
def list_invalid_properties
|
|
104
|
+
invalid_properties = Array.new
|
|
105
|
+
if @total_result_size.nil?
|
|
106
|
+
invalid_properties.push('invalid value for "total_result_size", total_result_size cannot be nil.')
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
if @data.nil?
|
|
110
|
+
invalid_properties.push('invalid value for "data", data cannot be nil.')
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
if @notification_type.nil?
|
|
114
|
+
invalid_properties.push('invalid value for "notification_type", notification_type cannot be nil.')
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
invalid_properties
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# Check to see if the all the properties in the model are valid
|
|
121
|
+
# @return true if the model is valid
|
|
122
|
+
def valid?
|
|
123
|
+
return false if @total_result_size.nil?
|
|
124
|
+
return false if @data.nil?
|
|
125
|
+
return false if @notification_type.nil?
|
|
126
|
+
notification_type_validator = EnumAttributeValidator.new('String', ["TierWillDowngrade"])
|
|
127
|
+
return false unless notification_type_validator.valid?(@notification_type)
|
|
128
|
+
true
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
132
|
+
# @param [Object] notification_type Object to be assigned
|
|
133
|
+
def notification_type=(notification_type)
|
|
134
|
+
validator = EnumAttributeValidator.new('String', ["TierWillDowngrade"])
|
|
135
|
+
unless validator.valid?(notification_type)
|
|
136
|
+
fail ArgumentError, "invalid value for \"notification_type\", must be one of #{validator.allowable_values}."
|
|
137
|
+
end
|
|
138
|
+
@notification_type = notification_type
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Checks equality by comparing each attribute.
|
|
142
|
+
# @param [Object] Object to be compared
|
|
143
|
+
def ==(o)
|
|
144
|
+
return true if self.equal?(o)
|
|
145
|
+
self.class == o.class &&
|
|
146
|
+
total_result_size == o.total_result_size &&
|
|
147
|
+
data == o.data &&
|
|
148
|
+
notification_type == o.notification_type
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# @see the `==` method
|
|
152
|
+
# @param [Object] Object to be compared
|
|
153
|
+
def eql?(o)
|
|
154
|
+
self == o
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# Calculates hash code according to all attributes.
|
|
158
|
+
# @return [Integer] Hash code
|
|
159
|
+
def hash
|
|
160
|
+
[total_result_size, data, notification_type].hash
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
# Builds the object from hash
|
|
164
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
165
|
+
# @return [Object] Returns the model itself
|
|
166
|
+
def self.build_from_hash(attributes)
|
|
167
|
+
new.build_from_hash(attributes)
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Builds the object from hash
|
|
171
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
172
|
+
# @return [Object] Returns the model itself
|
|
173
|
+
def build_from_hash(attributes)
|
|
174
|
+
return nil unless attributes.is_a?(Hash)
|
|
175
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
176
|
+
if type =~ /\AArray<(.*)>/i
|
|
177
|
+
# check to ensure the input is an array given that the attribute
|
|
178
|
+
# is documented as an array but the input is not
|
|
179
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
180
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
181
|
+
end
|
|
182
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
183
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
184
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
self
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
# Deserializes the data based on type
|
|
191
|
+
# @param string type Data type
|
|
192
|
+
# @param string value Value to be deserialized
|
|
193
|
+
# @return [Object] Deserialized data
|
|
194
|
+
def _deserialize(type, value)
|
|
195
|
+
case type.to_sym
|
|
196
|
+
when :DateTime
|
|
197
|
+
DateTime.parse(value)
|
|
198
|
+
when :Date
|
|
199
|
+
Date.parse(value)
|
|
200
|
+
when :String
|
|
201
|
+
value.to_s
|
|
202
|
+
when :Integer
|
|
203
|
+
value.to_i
|
|
204
|
+
when :Float
|
|
205
|
+
value.to_f
|
|
206
|
+
when :Boolean
|
|
207
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
208
|
+
true
|
|
209
|
+
else
|
|
210
|
+
false
|
|
211
|
+
end
|
|
212
|
+
when :Object
|
|
213
|
+
# generic object (usually a Hash), return directly
|
|
214
|
+
value
|
|
215
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
216
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
217
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
218
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
219
|
+
k_type = Regexp.last_match[:k_type]
|
|
220
|
+
v_type = Regexp.last_match[:v_type]
|
|
221
|
+
{}.tap do |hash|
|
|
222
|
+
value.each do |k, v|
|
|
223
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
else # model
|
|
227
|
+
TalonOne.const_get(type).build_from_hash(value)
|
|
228
|
+
end
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
# Returns the string representation of the object
|
|
232
|
+
# @return [String] String presentation of the object
|
|
233
|
+
def to_s
|
|
234
|
+
to_hash.to_s
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
238
|
+
# @return [Hash] Returns the object in the form of hash
|
|
239
|
+
def to_body
|
|
240
|
+
to_hash
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
# Returns the object in the form of hash
|
|
244
|
+
# @return [Hash] Returns the object in the form of hash
|
|
245
|
+
def to_hash
|
|
246
|
+
hash = {}
|
|
247
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
248
|
+
value = self.send(attr)
|
|
249
|
+
if value.nil?
|
|
250
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
251
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
hash[param] = _to_hash(value)
|
|
255
|
+
end
|
|
256
|
+
hash
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Outputs non-array value in the form of hash
|
|
260
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
261
|
+
# @param [Object] value Any valid value
|
|
262
|
+
# @return [Hash] Returns the value in the form of hash
|
|
263
|
+
def _to_hash(value)
|
|
264
|
+
if value.is_a?(Array)
|
|
265
|
+
value.compact.map { |v| _to_hash(v) }
|
|
266
|
+
elsif value.is_a?(Hash)
|
|
267
|
+
{}.tap do |hash|
|
|
268
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
269
|
+
end
|
|
270
|
+
elsif value.respond_to? :to_hash
|
|
271
|
+
value.to_hash
|
|
272
|
+
else
|
|
273
|
+
value
|
|
274
|
+
end
|
|
275
|
+
end
|
|
276
|
+
end
|
|
277
|
+
end
|
|
@@ -31,7 +31,7 @@ module TalonOne
|
|
|
31
31
|
|
|
32
32
|
attr_accessor :period_end_override
|
|
33
33
|
|
|
34
|
-
# 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.
|
|
34
|
+
# 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.
|
|
35
35
|
attr_accessor :recurrence_policy
|
|
36
36
|
|
|
37
37
|
# 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.
|
|
@@ -43,6 +43,9 @@ module TalonOne
|
|
|
43
43
|
# The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string.
|
|
44
44
|
attr_accessor :end_date
|
|
45
45
|
|
|
46
|
+
# When `true`, customer progress can be rolled back in completed achievements.
|
|
47
|
+
attr_accessor :allow_rollback_after_completion
|
|
48
|
+
|
|
46
49
|
class EnumAttributeValidator
|
|
47
50
|
attr_reader :datatype
|
|
48
51
|
attr_reader :allowable_values
|
|
@@ -77,7 +80,8 @@ module TalonOne
|
|
|
77
80
|
:'recurrence_policy' => :'recurrencePolicy',
|
|
78
81
|
:'activation_policy' => :'activationPolicy',
|
|
79
82
|
:'fixed_start_date' => :'fixedStartDate',
|
|
80
|
-
:'end_date' => :'endDate'
|
|
83
|
+
:'end_date' => :'endDate',
|
|
84
|
+
:'allow_rollback_after_completion' => :'allowRollbackAfterCompletion'
|
|
81
85
|
}
|
|
82
86
|
end
|
|
83
87
|
|
|
@@ -93,7 +97,8 @@ module TalonOne
|
|
|
93
97
|
:'recurrence_policy' => :'String',
|
|
94
98
|
:'activation_policy' => :'String',
|
|
95
99
|
:'fixed_start_date' => :'DateTime',
|
|
96
|
-
:'end_date' => :'DateTime'
|
|
100
|
+
:'end_date' => :'DateTime',
|
|
101
|
+
:'allow_rollback_after_completion' => :'Boolean'
|
|
97
102
|
}
|
|
98
103
|
end
|
|
99
104
|
|
|
@@ -157,6 +162,10 @@ module TalonOne
|
|
|
157
162
|
if attributes.key?(:'end_date')
|
|
158
163
|
self.end_date = attributes[:'end_date']
|
|
159
164
|
end
|
|
165
|
+
|
|
166
|
+
if attributes.key?(:'allow_rollback_after_completion')
|
|
167
|
+
self.allow_rollback_after_completion = attributes[:'allow_rollback_after_completion']
|
|
168
|
+
end
|
|
160
169
|
end
|
|
161
170
|
|
|
162
171
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -185,7 +194,7 @@ module TalonOne
|
|
|
185
194
|
return false if !@name.nil? && @name.to_s.length > 1000
|
|
186
195
|
return false if !@name.nil? && @name.to_s.length < 1
|
|
187
196
|
return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
|
|
188
|
-
recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
|
|
197
|
+
recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
|
|
189
198
|
return false unless recurrence_policy_validator.valid?(@recurrence_policy)
|
|
190
199
|
activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
|
|
191
200
|
return false unless activation_policy_validator.valid?(@activation_policy)
|
|
@@ -214,7 +223,7 @@ module TalonOne
|
|
|
214
223
|
# Custom attribute writer method checking allowed values (enum).
|
|
215
224
|
# @param [Object] recurrence_policy Object to be assigned
|
|
216
225
|
def recurrence_policy=(recurrence_policy)
|
|
217
|
-
validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
|
|
226
|
+
validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
|
|
218
227
|
unless validator.valid?(recurrence_policy)
|
|
219
228
|
fail ArgumentError, "invalid value for \"recurrence_policy\", must be one of #{validator.allowable_values}."
|
|
220
229
|
end
|
|
@@ -245,7 +254,8 @@ module TalonOne
|
|
|
245
254
|
recurrence_policy == o.recurrence_policy &&
|
|
246
255
|
activation_policy == o.activation_policy &&
|
|
247
256
|
fixed_start_date == o.fixed_start_date &&
|
|
248
|
-
end_date == o.end_date
|
|
257
|
+
end_date == o.end_date &&
|
|
258
|
+
allow_rollback_after_completion == o.allow_rollback_after_completion
|
|
249
259
|
end
|
|
250
260
|
|
|
251
261
|
# @see the `==` method
|
|
@@ -257,7 +267,7 @@ module TalonOne
|
|
|
257
267
|
# Calculates hash code according to all attributes.
|
|
258
268
|
# @return [Integer] Hash code
|
|
259
269
|
def hash
|
|
260
|
-
[name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date].hash
|
|
270
|
+
[name, title, description, target, period, period_end_override, recurrence_policy, activation_policy, fixed_start_date, end_date, allow_rollback_after_completion].hash
|
|
261
271
|
end
|
|
262
272
|
|
|
263
273
|
# Builds the object from hash
|