talon_one 1.3.0 → 2.2.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/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +196 -30
- data/Rakefile +2 -0
- data/docs/APIError.md +11 -0
- data/docs/AcceptCouponEffectProps.md +17 -0
- data/docs/AcceptReferralEffectProps.md +17 -0
- data/docs/AccessLogEntry.md +15 -0
- data/docs/Account.md +28 -2
- data/docs/AccountAdditionalCost.md +29 -0
- data/docs/AccountAnalytics.md +44 -14
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -11
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +29 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +33 -2
- data/docs/ApplicationAPIKey.md +19 -2
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +21 -2
- data/docs/ApplicationCustomerEntity.md +9 -0
- data/docs/ApplicationCustomerSearch.md +12 -1
- data/docs/ApplicationEntity.md +9 -0
- data/docs/ApplicationEvent.md +17 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +46 -3
- data/docs/CampaignCopy.md +19 -1
- data/docs/CampaignEntity.md +9 -0
- data/docs/CampaignGroup.md +31 -0
- data/docs/CampaignGroupEntity.md +17 -0
- data/docs/CampaignSearch.md +10 -1
- data/docs/CampaignSet.md +14 -0
- data/docs/CampaignSetBranchNode.md +12 -0
- data/docs/CampaignSetLeafNode.md +10 -0
- data/docs/CampaignSetNode.md +9 -0
- data/docs/CartItem.md +21 -1
- data/docs/CartItemAdjustment.md +11 -0
- data/docs/Change.md +16 -2
- data/docs/ChangeProfilePassword.md +19 -0
- data/docs/CodeGeneratorSettings.md +10 -0
- data/docs/Coupon.md +31 -3
- data/docs/CouponConstraints.md +13 -0
- data/docs/CouponCreatedEffectProps.md +19 -0
- data/docs/CouponRejectionReason.md +11 -0
- data/docs/CouponReservations.md +9 -0
- data/docs/CouponSearch.md +10 -1
- data/docs/CouponValue.md +9 -0
- data/docs/CreateApplicationAPIKey.md +12 -0
- data/docs/CustomerActivityReport.md +22 -1
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +23 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +19 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +23 -0
- data/docs/Effect.md +27 -0
- data/docs/EffectEntity.md +25 -0
- data/docs/EmailEntity.md +9 -0
- data/docs/Entity.md +10 -0
- data/docs/EntityWithTalangVisibleID.md +19 -0
- data/docs/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +12 -0
- data/docs/Event.md +19 -1
- data/docs/EventType.md +21 -1
- data/docs/Export.md +15 -1
- data/docs/FeatureFlag.md +12 -0
- data/docs/FeatureFlags.md +15 -3
- data/docs/FeaturesFeed.md +10 -0
- data/docs/FeedNotification.md +27 -0
- data/docs/FuncArgDef.md +10 -0
- data/docs/FunctionDef.md +13 -0
- data/docs/Import.md +14 -0
- data/docs/ImportCoupons.md +9 -0
- data/docs/InlineResponse200.md +10 -0
- data/docs/InlineResponse2001.md +11 -1
- data/docs/InlineResponse20010.md +11 -1
- data/docs/InlineResponse20011.md +10 -0
- data/docs/InlineResponse20012.md +13 -1
- data/docs/InlineResponse20013.md +11 -1
- data/docs/InlineResponse20014.md +10 -0
- data/docs/InlineResponse20015.md +11 -1
- data/docs/InlineResponse20016.md +11 -1
- data/docs/InlineResponse20017.md +10 -0
- data/docs/InlineResponse20018.md +11 -1
- data/docs/InlineResponse20019.md +10 -0
- data/docs/InlineResponse2002.md +11 -1
- data/docs/InlineResponse20020.md +11 -1
- data/docs/InlineResponse20021.md +11 -1
- data/docs/InlineResponse20022.md +11 -1
- data/docs/InlineResponse20023.md +11 -1
- data/docs/InlineResponse20024.md +11 -1
- data/docs/InlineResponse20025.md +12 -3
- data/docs/InlineResponse20026.md +11 -1
- data/docs/InlineResponse20027.md +14 -2
- data/docs/InlineResponse20028.md +11 -1
- data/docs/InlineResponse20029.md +19 -0
- data/docs/InlineResponse2003.md +11 -1
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse2004.md +11 -1
- data/docs/InlineResponse2005.md +11 -1
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +11 -1
- data/docs/InlineResponse2008.md +10 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/IntegrationApi.md +327 -72
- data/docs/IntegrationEntity.md +11 -1
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +13 -0
- data/docs/IntegrationStateV2.md +35 -0
- data/docs/LedgerEntry.md +18 -0
- data/docs/LibraryAttribute.md +15 -0
- data/docs/LimitConfig.md +11 -0
- data/docs/LoginParams.md +10 -0
- data/docs/Loyalty.md +9 -0
- data/docs/LoyaltyLedger.md +11 -1
- data/docs/LoyaltyLedgerEntry.md +23 -1
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +15 -1
- data/docs/LoyaltyProgram.md +20 -2
- data/docs/LoyaltyProgramBalance.md +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +927 -853
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +16 -3
- data/docs/MultiApplicationEntity.md +9 -0
- data/docs/MultipleCustomerProfileIntegrationRequest.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +19 -0
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +17 -0
- data/docs/MutableEntity.md +9 -0
- data/docs/NewAccount.md +9 -0
- data/docs/NewAccountSignUp.md +11 -0
- data/docs/NewAdditionalCost.md +23 -0
- data/docs/NewApplication.md +29 -1
- data/docs/NewApplicationAPIKey.md +20 -2
- data/docs/NewAttribute.md +20 -2
- data/docs/NewAudience.md +21 -0
- data/docs/NewCampaign.md +23 -1
- data/docs/NewCampaignGroup.md +23 -0
- data/docs/NewCampaignSet.md +12 -0
- data/docs/NewCoupons.md +20 -1
- data/docs/NewCustomerProfile.md +10 -1
- data/docs/NewCustomerSession.md +17 -1
- data/docs/NewCustomerSessionV2.md +31 -0
- data/docs/NewEvent.md +13 -1
- data/docs/NewEventType.md +19 -1
- data/docs/NewFeatureFlags.md +14 -3
- data/docs/NewImport.md +9 -0
- data/docs/NewInvitation.md +12 -0
- data/docs/NewInviteEmail.md +10 -0
- data/docs/NewLoyaltyProgram.md +18 -2
- data/docs/NewPassword.md +10 -0
- data/docs/NewPasswordEmail.md +9 -0
- data/docs/NewReferral.md +13 -0
- data/docs/NewRole.md +12 -0
- data/docs/NewRuleset.md +13 -1
- data/docs/NewSamlConnection.md +21 -3
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +11 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +11 -0
- data/docs/RejectCouponEffectProps.md +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/Rule.md +13 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +24 -6
- data/docs/SamlConnectionMetadata.md +23 -0
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +21 -0
- data/docs/SetDiscountPerItemEffectProps.md +23 -0
- data/docs/ShowBundleMetadataEffectProps.md +21 -0
- data/docs/ShowNotificationEffectProps.md +21 -0
- data/docs/SlotDef.md +15 -1
- data/docs/TemplateArgDef.md +13 -1
- data/docs/TemplateDef.md +20 -1
- data/docs/TriggerWebhookEffectProps.md +19 -0
- data/docs/UpdateAccount.md +16 -1
- data/docs/UpdateApplication.md +28 -1
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateAudience.md +17 -0
- data/docs/UpdateCampaign.md +23 -1
- data/docs/UpdateCampaignGroup.md +23 -0
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +17 -2
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +14 -6
- data/docs/UpdateUserLatestFeedTimestamp.md +17 -0
- data/docs/User.md +25 -5
- data/docs/UserEntity.md +9 -0
- data/docs/UserFeedNotifications.md +19 -0
- data/docs/Webhook.md +20 -1
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +88 -35
- data/lib/talon_one/api/integration_api.rb +518 -138
- data/lib/talon_one/api/management_api.rb +2328 -1477
- data/lib/talon_one/api_client.rb +45 -46
- data/lib/talon_one/api_error.rb +22 -3
- data/lib/talon_one/configuration.rb +48 -9
- data/lib/talon_one/models/accept_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/accept_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/access_log_entry.rb +47 -24
- data/lib/talon_one/models/account.rb +72 -49
- data/lib/talon_one/models/account_additional_cost.rb +300 -0
- data/lib/talon_one/models/account_analytics.rb +151 -68
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -45
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +293 -0
- data/lib/talon_one/models/additional_cost.rb +211 -0
- data/lib/talon_one/models/api_error.rb +40 -17
- data/lib/talon_one/models/application.rb +131 -77
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +121 -53
- data/lib/talon_one/models/application_customer.rb +66 -31
- data/lib/talon_one/models/application_customer_entity.rb +39 -16
- data/lib/talon_one/models/application_customer_search.rb +42 -19
- data/lib/talon_one/models/application_entity.rb +39 -16
- data/lib/talon_one/models/application_event.rb +48 -25
- data/lib/talon_one/models/application_session.rb +73 -35
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +73 -38
- data/lib/talon_one/models/attributes_mandatory.rb +222 -0
- data/lib/talon_one/models/attributes_settings.rb +207 -0
- data/lib/talon_one/models/audience.rb +360 -0
- data/lib/talon_one/models/audience_membership.rb +227 -0
- data/lib/talon_one/models/base_saml_connection.rb +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +93 -58
- data/lib/talon_one/models/campaign_analytics.rb +223 -50
- data/lib/talon_one/models/campaign_copy.rb +86 -21
- data/lib/talon_one/models/campaign_entity.rb +39 -16
- data/lib/talon_one/models/campaign_group.rb +326 -0
- data/lib/talon_one/models/campaign_group_entity.rb +209 -0
- data/lib/talon_one/models/campaign_search.rb +38 -15
- data/lib/talon_one/models/campaign_set.rb +77 -20
- data/lib/talon_one/models/campaign_set_branch_node.rb +47 -24
- data/lib/talon_one/models/campaign_set_leaf_node.rb +43 -20
- data/lib/talon_one/models/campaign_set_node.rb +38 -15
- data/lib/talon_one/models/cart_item.rb +49 -26
- data/lib/talon_one/models/cart_item_adjustment.rb +43 -20
- data/lib/talon_one/models/change.rb +46 -23
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +41 -18
- data/lib/talon_one/models/coupon.rb +117 -40
- data/lib/talon_one/models/coupon_constraints.rb +78 -21
- data/lib/talon_one/models/coupon_created_effect_props.rb +228 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +45 -22
- data/lib/talon_one/models/coupon_reservations.rb +39 -16
- data/lib/talon_one/models/coupon_search.rb +38 -15
- data/lib/talon_one/models/coupon_value.rb +38 -15
- data/lib/talon_one/models/create_application_api_key.rb +87 -20
- data/lib/talon_one/models/customer_activity_report.rb +62 -39
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +237 -0
- data/lib/talon_one/models/customer_profile.rb +65 -30
- data/lib/talon_one/models/customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +273 -0
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +242 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +60 -37
- data/lib/talon_one/models/customer_session_v2.rb +447 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +258 -0
- data/lib/talon_one/models/effect.rb +287 -0
- data/lib/talon_one/models/effect_entity.rb +273 -0
- data/lib/talon_one/models/email_entity.rb +38 -15
- data/lib/talon_one/models/entity.rb +39 -16
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +227 -0
- data/lib/talon_one/models/environment.rb +45 -22
- data/lib/talon_one/models/error_effect_props.rb +213 -0
- data/lib/talon_one/models/error_response.rb +39 -16
- data/lib/talon_one/models/error_source.rb +41 -18
- data/lib/talon_one/models/event.rb +51 -28
- data/lib/talon_one/models/event_type.rb +59 -36
- data/lib/talon_one/models/export.rb +48 -25
- data/lib/talon_one/models/feature_flag.rb +41 -18
- data/lib/talon_one/models/feature_flags.rb +46 -23
- data/lib/talon_one/models/features_feed.rb +40 -17
- data/lib/talon_one/models/feed_notification.rb +322 -0
- data/lib/talon_one/models/func_arg_def.rb +42 -19
- data/lib/talon_one/models/function_def.rb +42 -19
- data/lib/talon_one/models/import.rb +48 -25
- data/lib/talon_one/models/import_coupons.rb +38 -15
- data/lib/talon_one/models/{inline_response_200.rb → inline_response200.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_2.rb → inline_response2001.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_10.rb → inline_response20010.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_11.rb → inline_response20011.rb} +40 -17
- data/lib/talon_one/models/inline_response20012.rb +231 -0
- data/lib/talon_one/models/{inline_response_200_13.rb → inline_response20013.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_14.rb → inline_response20014.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_15.rb → inline_response20015.rb} +41 -18
- data/lib/talon_one/models/inline_response20016.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_17.rb → inline_response20017.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_18.rb → inline_response20018.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_19.rb → inline_response20019.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_3.rb → inline_response2002.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_12.rb → inline_response20020.rb} +42 -19
- data/lib/talon_one/models/inline_response20021.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20022.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_21.rb → inline_response20023.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_22.rb → inline_response20024.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_23.rb → inline_response20025.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_24.rb → inline_response20026.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_25.rb → inline_response20027.rb} +44 -21
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_27.rb → inline_response20029.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_4.rb → inline_response2003.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_28.rb → inline_response20030.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_1.rb → inline_response2004.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_5.rb → inline_response2005.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_6.rb → inline_response2006.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_7.rb → inline_response2007.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_8.rb → inline_response2008.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_9.rb → inline_response2009.rb} +40 -17
- data/lib/talon_one/models/integration_entity.rb +41 -18
- data/lib/talon_one/models/integration_event.rb +41 -18
- data/lib/talon_one/models/integration_profile_entity.rb +39 -16
- data/lib/talon_one/models/integration_request.rb +246 -0
- data/lib/talon_one/models/integration_state.rb +42 -19
- data/lib/talon_one/models/integration_state_v2.rb +313 -0
- data/lib/talon_one/models/ledger_entry.rb +53 -30
- data/lib/talon_one/models/library_attribute.rb +50 -27
- data/lib/talon_one/models/limit_config.rb +43 -20
- data/lib/talon_one/models/login_params.rb +39 -16
- data/lib/talon_one/models/loyalty.rb +38 -15
- data/lib/talon_one/models/loyalty_ledger.rb +40 -18
- data/lib/talon_one/models/loyalty_ledger_entry.rb +76 -67
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +59 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +39 -16
- data/lib/talon_one/models/loyalty_program_ledgers.rb +43 -21
- data/lib/talon_one/models/loyalty_statistics.rb +258 -0
- data/lib/talon_one/models/loyalty_sub_ledger.rb +144 -24
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +45 -21
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +208 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +223 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +38 -15
- data/lib/talon_one/models/new_account.rb +39 -16
- data/lib/talon_one/models/new_account_sign_up.rb +41 -18
- data/lib/talon_one/models/new_additional_cost.rb +255 -0
- data/lib/talon_one/models/new_application.rb +138 -48
- data/lib/talon_one/models/new_application_api_key.rb +119 -52
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_audience.rb +314 -0
- data/lib/talon_one/models/new_campaign.rb +73 -38
- data/lib/talon_one/models/new_campaign_group.rb +265 -0
- data/lib/talon_one/models/new_campaign_set.rb +75 -18
- data/lib/talon_one/models/new_coupons.rb +89 -32
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +50 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +322 -0
- data/lib/talon_one/models/new_event.rb +43 -20
- data/lib/talon_one/models/new_event_type.rb +57 -34
- data/lib/talon_one/models/new_feature_flags.rb +44 -21
- data/lib/talon_one/models/new_import.rb +41 -18
- data/lib/talon_one/models/new_invitation.rb +41 -18
- data/lib/talon_one/models/new_invite_email.rb +39 -16
- data/lib/talon_one/models/new_loyalty_program.rb +64 -26
- data/lib/talon_one/models/new_password.rb +40 -17
- data/lib/talon_one/models/new_password_email.rb +38 -15
- data/lib/talon_one/models/new_referral.rb +47 -24
- data/lib/talon_one/models/new_role.rb +41 -18
- data/lib/talon_one/models/new_ruleset.rb +43 -20
- data/lib/talon_one/models/new_saml_connection.rb +105 -67
- data/lib/talon_one/models/new_template_def.rb +45 -22
- data/lib/talon_one/models/new_user.rb +42 -19
- data/lib/talon_one/models/new_webhook.rb +50 -27
- data/lib/talon_one/models/notification.rb +40 -17
- data/lib/talon_one/models/redeem_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/referral.rb +54 -31
- data/lib/talon_one/models/referral_created_effect_props.rb +213 -0
- data/lib/talon_one/models/referral_rejection_reason.rb +45 -22
- data/lib/talon_one/models/reject_coupon_effect_props.rb +228 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/role.rb +58 -25
- data/lib/talon_one/models/role_assign.rb +39 -16
- data/lib/talon_one/models/role_membership.rb +41 -18
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +93 -103
- data/lib/talon_one/models/saml_connection_metadata.rb +294 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +265 -0
- data/lib/talon_one/models/session.rb +41 -18
- data/lib/talon_one/models/set_discount_effect_props.rb +238 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +253 -0
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +247 -0
- data/lib/talon_one/models/show_notification_effect_props.rb +243 -0
- data/lib/talon_one/models/slot_def.rb +44 -21
- data/lib/talon_one/models/template_arg_def.rb +44 -21
- data/lib/talon_one/models/template_def.rb +50 -27
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +228 -0
- data/lib/talon_one/models/update_account.rb +100 -23
- data/lib/talon_one/models/update_application.rb +135 -29
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_audience.rb +231 -0
- data/lib/talon_one/models/update_campaign.rb +73 -38
- data/lib/talon_one/models/update_campaign_group.rb +266 -0
- data/lib/talon_one/models/update_coupon.rb +81 -24
- data/lib/talon_one/models/update_coupon_batch.rb +81 -24
- data/lib/talon_one/models/update_loyalty_program.rb +58 -25
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +47 -80
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +213 -0
- data/lib/talon_one/models/user.rb +67 -59
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/user_feed_notifications.rb +230 -0
- data/lib/talon_one/models/webhook.rb +53 -30
- data/lib/talon_one/models/webhook_activation_log_entry.rb +46 -23
- data/lib/talon_one/models/webhook_log_entry.rb +52 -29
- data/lib/talon_one/version.rb +4 -4
- data/spec/api/integration_api_spec.rb +76 -15
- data/spec/api/management_api_spec.rb +155 -143
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{misc_update_user_latest_feature_spec.rb → accept_coupon_effect_props_spec.rb} +11 -11
- data/spec/models/accept_referral_effect_props_spec.rb +41 -0
- data/spec/models/access_log_entry_spec.rb +4 -4
- data/spec/models/account_additional_cost_spec.rb +77 -0
- data/spec/models/account_analytics_spec.rb +33 -9
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -4
- data/spec/models/account_spec.rb +5 -5
- data/spec/models/add_free_item_effect_props_spec.rb +47 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +77 -0
- data/spec/models/additional_cost_spec.rb +41 -0
- data/spec/models/api_error_spec.rb +4 -4
- data/spec/models/application_api_health_spec.rb +4 -4
- data/spec/models/application_api_key_spec.rb +21 -11
- data/spec/models/application_customer_entity_spec.rb +4 -4
- data/spec/models/application_customer_search_spec.rb +4 -4
- data/spec/models/application_customer_spec.rb +10 -4
- data/spec/models/application_entity_spec.rb +4 -4
- data/spec/models/application_event_spec.rb +4 -4
- data/spec/models/application_session_entity_spec.rb +4 -4
- data/spec/models/application_session_spec.rb +10 -4
- data/spec/models/application_spec.rb +43 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +47 -0
- data/spec/models/audience_spec.rb +75 -0
- data/spec/models/base_saml_connection_spec.rb +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +64 -4
- data/spec/models/campaign_copy_spec.rb +28 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- data/spec/models/campaign_group_entity_spec.rb +41 -0
- data/spec/models/campaign_group_spec.rb +83 -0
- data/spec/models/campaign_search_spec.rb +4 -4
- data/spec/models/campaign_set_branch_node_spec.rb +4 -4
- data/spec/models/campaign_set_leaf_node_spec.rb +4 -4
- data/spec/models/campaign_set_node_spec.rb +4 -4
- data/spec/models/campaign_set_spec.rb +10 -4
- data/spec/models/campaign_spec.rb +10 -4
- data/spec/models/cart_item_adjustment_spec.rb +4 -4
- data/spec/models/cart_item_spec.rb +4 -4
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +4 -4
- data/spec/models/code_generator_settings_spec.rb +4 -4
- data/spec/models/coupon_constraints_spec.rb +10 -4
- data/spec/models/coupon_created_effect_props_spec.rb +47 -0
- data/spec/models/coupon_rejection_reason_spec.rb +5 -5
- data/spec/models/coupon_reservations_spec.rb +4 -4
- data/spec/models/coupon_search_spec.rb +4 -4
- data/spec/models/coupon_spec.rb +22 -4
- data/spec/models/coupon_value_spec.rb +4 -4
- data/spec/models/create_application_api_key_spec.rb +14 -4
- data/spec/models/customer_activity_report_spec.rb +4 -4
- data/spec/models/customer_analytics_spec.rb +4 -4
- data/spec/models/customer_inventory_spec.rb +59 -0
- data/spec/models/customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +51 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +10 -4
- data/spec/models/customer_session_spec.rb +4 -4
- data/spec/models/customer_session_v2_spec.rb +129 -0
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +65 -0
- data/spec/models/effect_spec.rb +71 -0
- data/spec/models/email_entity_spec.rb +4 -4
- data/spec/models/entity_spec.rb +4 -4
- data/spec/models/entity_with_talang_visible_id_spec.rb +47 -0
- data/spec/models/environment_spec.rb +4 -4
- data/spec/models/error_effect_props_spec.rb +41 -0
- data/spec/models/error_response_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/event_spec.rb +4 -4
- data/spec/models/event_type_spec.rb +4 -4
- data/spec/models/export_spec.rb +4 -4
- data/spec/models/feature_flag_spec.rb +4 -4
- data/spec/models/feature_flags_spec.rb +4 -4
- data/spec/models/features_feed_spec.rb +4 -4
- data/spec/models/feed_notification_spec.rb +75 -0
- data/spec/models/func_arg_def_spec.rb +4 -4
- data/spec/models/function_def_spec.rb +4 -4
- data/spec/models/import_coupons_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -4
- data/spec/models/{inline_response_200_10_spec.rb → inline_response20010_spec.rb} +4 -4
- data/spec/models/{inline_response_200_11_spec.rb → inline_response20011_spec.rb} +4 -4
- data/spec/models/{inline_response_200_12_spec.rb → inline_response20012_spec.rb} +10 -4
- data/spec/models/{inline_response_200_13_spec.rb → inline_response20013_spec.rb} +4 -4
- data/spec/models/{inline_response_200_14_spec.rb → inline_response20014_spec.rb} +4 -4
- data/spec/models/{inline_response_200_15_spec.rb → inline_response20015_spec.rb} +4 -4
- data/spec/models/{inline_response_200_16_spec.rb → inline_response20016_spec.rb} +5 -5
- data/spec/models/{inline_response_200_17_spec.rb → inline_response20017_spec.rb} +4 -4
- data/spec/models/{inline_response_200_18_spec.rb → inline_response20018_spec.rb} +4 -4
- data/spec/models/{inline_response_200_19_spec.rb → inline_response20019_spec.rb} +4 -4
- data/spec/models/{inline_response_200_1_spec.rb → inline_response2001_spec.rb} +4 -4
- data/spec/models/{inline_response_200_20_spec.rb → inline_response20020_spec.rb} +4 -4
- data/spec/models/{inline_response_200_21_spec.rb → inline_response20021_spec.rb} +4 -4
- data/spec/models/{inline_response_200_22_spec.rb → inline_response20022_spec.rb} +4 -4
- data/spec/models/{inline_response_200_23_spec.rb → inline_response20023_spec.rb} +4 -4
- data/spec/models/{inline_response_200_24_spec.rb → inline_response20024_spec.rb} +4 -4
- data/spec/models/{inline_response_200_25_spec.rb → inline_response20025_spec.rb} +4 -10
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -4
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +10 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +4 -4
- data/spec/models/inline_response20029_spec.rb +47 -0
- data/spec/models/{inline_response_200_2_spec.rb → inline_response2002_spec.rb} +4 -4
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/{inline_response_200_3_spec.rb → inline_response2003_spec.rb} +4 -4
- data/spec/models/{inline_response_200_4_spec.rb → inline_response2004_spec.rb} +4 -4
- data/spec/models/{inline_response_200_5_spec.rb → inline_response2005_spec.rb} +4 -4
- data/spec/models/{inline_response_200_6_spec.rb → inline_response2006_spec.rb} +4 -4
- data/spec/models/{inline_response_200_7_spec.rb → inline_response2007_spec.rb} +4 -4
- data/spec/models/{inline_response_200_8_spec.rb → inline_response2008_spec.rb} +4 -4
- data/spec/models/{inline_response_200_9_spec.rb → inline_response2009_spec.rb} +4 -4
- data/spec/models/{inline_response_200_spec.rb → inline_response200_spec.rb} +4 -4
- data/spec/models/integration_entity_spec.rb +4 -4
- data/spec/models/integration_event_spec.rb +4 -4
- data/spec/models/integration_profile_entity_spec.rb +4 -4
- data/spec/models/integration_request_spec.rb +51 -0
- data/spec/models/integration_state_spec.rb +4 -4
- data/spec/models/integration_state_v2_spec.rb +95 -0
- data/spec/models/ledger_entry_spec.rb +4 -4
- data/spec/models/library_attribute_spec.rb +4 -4
- data/spec/models/limit_config_spec.rb +4 -4
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +16 -8
- data/spec/models/loyalty_ledger_spec.rb +4 -4
- data/spec/models/loyalty_membership_spec.rb +4 -4
- data/spec/models/loyalty_points_spec.rb +11 -5
- data/spec/models/loyalty_program_balance_spec.rb +4 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +4 -4
- data/spec/models/loyalty_program_spec.rb +10 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_statistics_spec.rb +59 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +46 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +4 -4
- data/spec/models/new_account_sign_up_spec.rb +4 -4
- data/spec/models/new_account_spec.rb +4 -4
- data/spec/models/new_additional_cost_spec.rb +59 -0
- data/spec/models/new_application_api_key_spec.rb +21 -11
- data/spec/models/new_application_spec.rb +48 -4
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_audience_spec.rb +57 -0
- data/spec/models/new_campaign_group_spec.rb +59 -0
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +10 -4
- data/spec/models/new_coupons_spec.rb +10 -4
- data/spec/models/new_customer_profile_spec.rb +4 -4
- data/spec/models/new_customer_session_spec.rb +4 -4
- data/spec/models/new_customer_session_v2_spec.rb +87 -0
- data/spec/models/new_event_spec.rb +4 -4
- data/spec/models/new_event_type_spec.rb +4 -4
- data/spec/models/new_feature_flags_spec.rb +4 -4
- data/spec/models/new_import_spec.rb +4 -4
- data/spec/models/new_invitation_spec.rb +4 -4
- data/spec/models/new_invite_email_spec.rb +4 -4
- data/spec/models/new_loyalty_program_spec.rb +10 -4
- data/spec/models/new_password_email_spec.rb +4 -4
- data/spec/models/new_password_spec.rb +4 -4
- data/spec/models/new_referral_spec.rb +4 -4
- data/spec/models/new_role_spec.rb +4 -4
- data/spec/models/new_ruleset_spec.rb +4 -4
- data/spec/models/new_saml_connection_spec.rb +17 -11
- data/spec/models/new_template_def_spec.rb +4 -4
- data/spec/models/new_user_spec.rb +4 -4
- data/spec/models/new_webhook_spec.rb +4 -4
- data/spec/models/notification_spec.rb +4 -4
- data/spec/models/redeem_referral_effect_props_spec.rb +47 -0
- data/spec/models/referral_created_effect_props_spec.rb +41 -0
- data/spec/models/referral_rejection_reason_spec.rb +5 -5
- data/spec/models/referral_spec.rb +4 -4
- data/spec/models/reject_coupon_effect_props_spec.rb +47 -0
- data/spec/models/reject_referral_effect_props_spec.rb +47 -0
- data/spec/models/role_assign_spec.rb +4 -4
- data/spec/models/role_membership_spec.rb +4 -4
- data/spec/models/role_spec.rb +10 -4
- data/spec/models/rollback_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -0
- data/spec/models/rule_spec.rb +4 -4
- data/spec/models/ruleset_spec.rb +4 -4
- data/spec/models/saml_connection_metadata_spec.rb +59 -0
- data/spec/models/saml_connection_spec.rb +13 -19
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/set_discount_effect_props_spec.rb +53 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +59 -0
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +53 -0
- data/spec/models/show_notification_effect_props_spec.rb +53 -0
- data/spec/models/slot_def_spec.rb +4 -4
- data/spec/models/template_arg_def_spec.rb +4 -4
- data/spec/models/template_def_spec.rb +4 -4
- data/spec/models/trigger_webhook_effect_props_spec.rb +47 -0
- data/spec/models/update_account_spec.rb +20 -4
- data/spec/models/update_application_spec.rb +48 -4
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_audience_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +59 -0
- data/spec/models/update_campaign_spec.rb +10 -4
- data/spec/models/update_coupon_batch_spec.rb +10 -4
- data/spec/models/update_coupon_spec.rb +10 -4
- data/spec/models/update_loyalty_program_spec.rb +10 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +41 -0
- data/spec/models/update_user_spec.rb +4 -34
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_feed_notifications_spec.rb +47 -0
- data/spec/models/user_spec.rb +5 -11
- data/spec/models/webhook_activation_log_entry_spec.rb +4 -4
- data/spec/models/webhook_log_entry_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +314 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/MiscUpdateUserLatestFeature.md +0 -8
- data/docs/Notifications.md +0 -7
- data/git_push.sh +0 -55
- data/lib/talon_one/models/attribute_query.rb +0 -174
- data/lib/talon_one/models/inline_response_200_16.rb +0 -204
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +0 -183
- data/lib/talon_one/models/notifications.rb +0 -174
- data/spec/models/attribute_query_spec.rb +0 -35
- data/spec/models/notifications_spec.rb +0 -35
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fc8a2c6ef0d0fdbf9ab4cea3aabbd200e7ffcf58726e2a133f0a203fbb774f2d
|
|
4
|
+
data.tar.gz: a522e06144d1f7c61af0f3d0fa86001ba7af5a0e101e5208fa6421fb590d2865
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3fd75661ebafe84c59177d924cad4dd057443448a4d78cebf57388e3b41f94ccefeffaf312aa73a9a2be471cebc8172b40ff50760de6f452544ed77170a762bc
|
|
7
|
+
data.tar.gz: be44a5bc6b8867a8fa0a3651e0d54661ed284f76143c33275e9b206ce740f429f8a5253ff4b1459a63c8c554a1eb76730765bc7d78a49d188e77e05906281dfc
|
data/.rspec
ADDED
data/Gemfile
CHANGED
data/README.md
CHANGED
|
@@ -2,13 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
TalonOne - the Ruby gem for the Talon.One API
|
|
4
4
|
|
|
5
|
-
The Talon.One API is used to manage applications and campaigns, as well as to
|
|
5
|
+
The Talon.One API is used to manage applications and campaigns, as well as to
|
|
6
|
+
integrate with your application. The operations in the _Integration API_ section
|
|
7
|
+
are used to integrate with our platform, while the other operations are
|
|
8
|
+
used to manage applications and campaigns.
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
### Where is the API?
|
|
11
|
+
|
|
12
|
+
The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`
|
|
13
|
+
|
|
14
|
+
[updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
18
|
|
|
9
19
|
- API version: 1.0.0
|
|
10
|
-
- Package version:
|
|
11
|
-
- Build package:
|
|
20
|
+
- Package version: 2.2.0
|
|
21
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
22
|
|
|
13
23
|
## Installation
|
|
14
24
|
|
|
@@ -23,21 +33,22 @@ gem build talon_one.gemspec
|
|
|
23
33
|
Then either install the gem locally:
|
|
24
34
|
|
|
25
35
|
```shell
|
|
26
|
-
gem install ./talon_one-
|
|
36
|
+
gem install ./talon_one-2.2.0.gem
|
|
27
37
|
```
|
|
28
|
-
|
|
38
|
+
|
|
39
|
+
(for development, run `gem install --dev ./talon_one-2.2.0.gem` to install the development dependencies)
|
|
29
40
|
|
|
30
41
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
42
|
|
|
32
43
|
Finally add this to the Gemfile:
|
|
33
44
|
|
|
34
|
-
gem 'talon_one', '~>
|
|
45
|
+
gem 'talon_one', '~> 2.2.0'
|
|
35
46
|
|
|
36
47
|
### Install from Git
|
|
37
48
|
|
|
38
|
-
If the Ruby gem is hosted at a git repository: https://github.com/
|
|
49
|
+
If the Ruby gem is hosted at a git repository: https://github.com/talon-one/talon_one.rb, then add the following in the Gemfile:
|
|
39
50
|
|
|
40
|
-
gem 'talon_one', :git => 'https://github.com/
|
|
51
|
+
gem 'talon_one', :git => 'https://github.com/talon-one/talon_one.rb.git'
|
|
41
52
|
|
|
42
53
|
### Include the Ruby code directly
|
|
43
54
|
|
|
@@ -52,6 +63,98 @@ ruby -Ilib script.rb
|
|
|
52
63
|
Please follow the [installation](#installation) procedure and then run the following code:
|
|
53
64
|
|
|
54
65
|
### Integration API
|
|
66
|
+
|
|
67
|
+
### V2
|
|
68
|
+
```ruby
|
|
69
|
+
# Load the gem
|
|
70
|
+
require 'talon_one'
|
|
71
|
+
|
|
72
|
+
# Setup authorization
|
|
73
|
+
TalonOne.configure do |config|
|
|
74
|
+
# Configure the API host destination
|
|
75
|
+
config.host = 'mycompany.talon.one'
|
|
76
|
+
|
|
77
|
+
# Configure API key authorization: api_key_v1
|
|
78
|
+
config.api_key['Authorization'] = 'ca1890f0ec3bfa8ed4be04e2aec0c606c0df8ad464f17d3ea8b51df12ba60e5d'
|
|
79
|
+
config.api_key_prefix['Authorization'] = 'ApiKey-v1'
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Integration API example to send a session update
|
|
83
|
+
integration_api = TalonOne::IntegrationApi.new
|
|
84
|
+
|
|
85
|
+
session_integration_id = '8fb7129e-68e6-4464-9631-09b588391619' # String | The integration identifier of the session
|
|
86
|
+
|
|
87
|
+
# NewCustomerSessionV2 object
|
|
88
|
+
customer_session_v2 = TalonOne::NewCustomerSessionV2.new(
|
|
89
|
+
profile_id: 'Some_1',
|
|
90
|
+
state: 'open',
|
|
91
|
+
cart_items: [
|
|
92
|
+
TalonOne::CartItem.new(
|
|
93
|
+
name: 'Nigiri Sake',
|
|
94
|
+
sku: 'sush1',
|
|
95
|
+
quantity: 2,
|
|
96
|
+
price: 3.7,
|
|
97
|
+
category: 'Sushi'
|
|
98
|
+
),
|
|
99
|
+
TalonOne::CartItem.new(
|
|
100
|
+
name: 'Rainbow Roll I/O',
|
|
101
|
+
sku: 'sush2',
|
|
102
|
+
quantity: 1,
|
|
103
|
+
price: 6.5,
|
|
104
|
+
category: 'Sushi'
|
|
105
|
+
),
|
|
106
|
+
TalonOne::CartItem.new(
|
|
107
|
+
name: 'Kirin',
|
|
108
|
+
sku: 'k1r',
|
|
109
|
+
quantity: 2,
|
|
110
|
+
price: 2.2,
|
|
111
|
+
category: 'Beverages'
|
|
112
|
+
),
|
|
113
|
+
],
|
|
114
|
+
coupon_codes: [
|
|
115
|
+
'Cool-Stuff!'
|
|
116
|
+
]
|
|
117
|
+
)
|
|
118
|
+
|
|
119
|
+
# Instantiating a new IntegrationRequest object
|
|
120
|
+
integration_request = TalonOne::IntegrationRequest.new(
|
|
121
|
+
customer_session: customer_session_v2,
|
|
122
|
+
# Optional list of requested information to be present on the response.
|
|
123
|
+
# See docs/IntegrationRequest.md for full list
|
|
124
|
+
# response_content: [
|
|
125
|
+
# 'customerSession'
|
|
126
|
+
# ]
|
|
127
|
+
)
|
|
128
|
+
|
|
129
|
+
begin
|
|
130
|
+
# Create/update a customer session using `update_customer_session_v2` function
|
|
131
|
+
result = integration_api.update_customer_session_v2(session_integration_id, integration_request)
|
|
132
|
+
|
|
133
|
+
# Prints response to the console
|
|
134
|
+
puts result
|
|
135
|
+
|
|
136
|
+
# Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding properties
|
|
137
|
+
result.effects.each do |effect|
|
|
138
|
+
if effect.effect_type == 'setDiscount'
|
|
139
|
+
# Initiating right props instance according to the effect type
|
|
140
|
+
props = TalonOne::SetDiscountEffectProps.build_from_hash(effect.props)
|
|
141
|
+
|
|
142
|
+
# Access the specific effect's properties
|
|
143
|
+
puts "Set a discount '#{props.name}' of #{props.value}"
|
|
144
|
+
elsif effect.effect_type == 'rejectCoupon'
|
|
145
|
+
# Initiating right props instance according to the effect type
|
|
146
|
+
props = TalonOne::RejectCouponEffectProps.build_from_hash(effect.props)
|
|
147
|
+
|
|
148
|
+
# Work with AcceptCouponEffectProps' properties
|
|
149
|
+
# ...
|
|
150
|
+
end
|
|
151
|
+
end
|
|
152
|
+
rescue TalonOne::ApiError => e
|
|
153
|
+
puts "Exception when calling IntegrationApi->update_customer_session_v2: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### V1
|
|
55
158
|
```ruby
|
|
56
159
|
# Load the gem
|
|
57
160
|
require 'talon_one'
|
|
@@ -132,7 +235,7 @@ end
|
|
|
132
235
|
|
|
133
236
|
## Documentation for API Endpoints
|
|
134
237
|
|
|
135
|
-
All URIs are relative to *
|
|
238
|
+
All URIs are relative to *http://localhost*
|
|
136
239
|
|
|
137
240
|
Class | Method | HTTP request | Description
|
|
138
241
|
------------ | ------------- | ------------- | -------------
|
|
@@ -140,13 +243,19 @@ Class | Method | HTTP request | Description
|
|
|
140
243
|
*TalonOne::IntegrationApi* | [**create_referral**](docs/IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
|
141
244
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
|
142
245
|
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
|
|
143
|
-
*TalonOne::IntegrationApi* | [**
|
|
246
|
+
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
|
|
144
247
|
*TalonOne::IntegrationApi* | [**get_reserved_customers**](docs/IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
|
145
248
|
*TalonOne::IntegrationApi* | [**track_event**](docs/IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
|
146
|
-
*TalonOne::IntegrationApi* | [**update_customer_profile**](docs/IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
|
|
147
|
-
*TalonOne::IntegrationApi* | [**
|
|
249
|
+
*TalonOne::IntegrationApi* | [**update_customer_profile**](docs/IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
|
|
250
|
+
*TalonOne::IntegrationApi* | [**update_customer_profile_audiences**](docs/IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update a Customer Profile Audiences
|
|
251
|
+
*TalonOne::IntegrationApi* | [**update_customer_profile_v2**](docs/IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update a Customer Profile
|
|
252
|
+
*TalonOne::IntegrationApi* | [**update_customer_profiles_v2**](docs/IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple Customer Profiles
|
|
253
|
+
*TalonOne::IntegrationApi* | [**update_customer_session**](docs/IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1
|
|
254
|
+
*TalonOne::IntegrationApi* | [**update_customer_session_v2**](docs/IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
|
|
148
255
|
*TalonOne::ManagementApi* | [**add_loyalty_points**](docs/ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
|
|
149
256
|
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
|
|
257
|
+
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Define a new additional cost
|
|
258
|
+
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
|
150
259
|
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
|
151
260
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
|
152
261
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
|
@@ -157,37 +266,38 @@ Class | Method | HTTP request | Description
|
|
|
157
266
|
*TalonOne::ManagementApi* | [**delete_coupons**](docs/ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
|
|
158
267
|
*TalonOne::ManagementApi* | [**delete_referral**](docs/ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
|
|
159
268
|
*TalonOne::ManagementApi* | [**delete_ruleset**](docs/ManagementApi.md#delete_ruleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
|
|
160
|
-
*TalonOne::ManagementApi* | [**get_access_logs**](docs/ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application
|
|
269
|
+
*TalonOne::ManagementApi* | [**get_access_logs**](docs/ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
|
|
161
270
|
*TalonOne::ManagementApi* | [**get_access_logs_without_total_count**](docs/ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
|
162
271
|
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
|
163
272
|
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
|
164
|
-
*TalonOne::ManagementApi* | [**
|
|
273
|
+
*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
|
|
274
|
+
*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
|
165
275
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
|
166
276
|
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
|
167
277
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
|
168
278
|
*TalonOne::ManagementApi* | [**get_application_api_health**](docs/ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
|
|
169
279
|
*TalonOne::ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
|
|
170
280
|
*TalonOne::ManagementApi* | [**get_application_customers**](docs/ManagementApi.md#get_application_customers) | **GET** /v1/applications/{applicationId}/customers | List Application Customers
|
|
171
|
-
*TalonOne::ManagementApi* | [**get_application_customers_by_attributes**](docs/ManagementApi.md#get_application_customers_by_attributes) | **POST** /v1/application_customer_search | Get a list of the customer profiles that match the given attributes
|
|
281
|
+
*TalonOne::ManagementApi* | [**get_application_customers_by_attributes**](docs/ManagementApi.md#get_application_customers_by_attributes) | **POST** /v1/application_customer_search | Get a list of the customer profiles that match the given attributes (with total count)
|
|
172
282
|
*TalonOne::ManagementApi* | [**get_application_event_types**](docs/ManagementApi.md#get_application_event_types) | **GET** /v1/applications/{applicationId}/event_types | List Applications Event Types
|
|
173
|
-
*TalonOne::ManagementApi* | [**get_application_events**](docs/ManagementApi.md#get_application_events) | **GET** /v1/applications/{applicationId}/events | List Applications Events
|
|
283
|
+
*TalonOne::ManagementApi* | [**get_application_events**](docs/ManagementApi.md#get_application_events) | **GET** /v1/applications/{applicationId}/events | List Applications Events (with total count)
|
|
174
284
|
*TalonOne::ManagementApi* | [**get_application_events_without_total_count**](docs/ManagementApi.md#get_application_events_without_total_count) | **GET** /v1/applications/{applicationId}/events/no_total | List Applications Events
|
|
175
285
|
*TalonOne::ManagementApi* | [**get_application_session**](docs/ManagementApi.md#get_application_session) | **GET** /v1/applications/{applicationId}/sessions/{sessionId} | Get Application Session
|
|
176
286
|
*TalonOne::ManagementApi* | [**get_application_sessions**](docs/ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
|
177
287
|
*TalonOne::ManagementApi* | [**get_applications**](docs/ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
|
178
288
|
*TalonOne::ManagementApi* | [**get_attribute**](docs/ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
|
289
|
+
*TalonOne::ManagementApi* | [**get_attributes**](docs/ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
|
179
290
|
*TalonOne::ManagementApi* | [**get_campaign**](docs/ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
|
180
291
|
*TalonOne::ManagementApi* | [**get_campaign_analytics**](docs/ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
|
181
292
|
*TalonOne::ManagementApi* | [**get_campaign_by_attributes**](docs/ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
|
182
|
-
*TalonOne::ManagementApi* | [**get_campaign_set**](docs/ManagementApi.md#get_campaign_set) | **GET** /v1/applications/{applicationId}/campaign_set | List CampaignSet
|
|
183
293
|
*TalonOne::ManagementApi* | [**get_campaigns**](docs/ManagementApi.md#get_campaigns) | **GET** /v1/applications/{applicationId}/campaigns | List your Campaigns
|
|
184
294
|
*TalonOne::ManagementApi* | [**get_changes**](docs/ManagementApi.md#get_changes) | **GET** /v1/changes | Get audit log for an account
|
|
185
|
-
*TalonOne::ManagementApi* | [**get_coupons**](docs/ManagementApi.md#get_coupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons
|
|
295
|
+
*TalonOne::ManagementApi* | [**get_coupons**](docs/ManagementApi.md#get_coupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons (with total count)
|
|
186
296
|
*TalonOne::ManagementApi* | [**get_coupons_by_attributes**](docs/ManagementApi.md#get_coupons_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search | Get a list of the coupons that match the given attributes
|
|
187
|
-
*TalonOne::ManagementApi* | [**get_coupons_by_attributes_application_wide**](docs/ManagementApi.md#get_coupons_by_attributes_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
297
|
+
*TalonOne::ManagementApi* | [**get_coupons_by_attributes_application_wide**](docs/ManagementApi.md#get_coupons_by_attributes_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search | Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
188
298
|
*TalonOne::ManagementApi* | [**get_coupons_without_total_count**](docs/ManagementApi.md#get_coupons_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List Coupons
|
|
189
299
|
*TalonOne::ManagementApi* | [**get_customer_activity_report**](docs/ManagementApi.md#get_customer_activity_report) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get Activity Report for Single Customer
|
|
190
|
-
*TalonOne::ManagementApi* | [**get_customer_activity_reports**](docs/ManagementApi.md#get_customer_activity_reports) | **GET** /v1/applications/{applicationId}/customer_activity_reports | Get Activity Reports for Application Customers
|
|
300
|
+
*TalonOne::ManagementApi* | [**get_customer_activity_reports**](docs/ManagementApi.md#get_customer_activity_reports) | **GET** /v1/applications/{applicationId}/customer_activity_reports | Get Activity Reports for Application Customers (with total count)
|
|
191
301
|
*TalonOne::ManagementApi* | [**get_customer_activity_reports_without_total_count**](docs/ManagementApi.md#get_customer_activity_reports_without_total_count) | **GET** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers
|
|
192
302
|
*TalonOne::ManagementApi* | [**get_customer_analytics**](docs/ManagementApi.md#get_customer_analytics) | **GET** /v1/applications/{applicationId}/customers/{customerId}/analytics | Get Analytics Report for a Customer
|
|
193
303
|
*TalonOne::ManagementApi* | [**get_customer_profile**](docs/ManagementApi.md#get_customer_profile) | **GET** /v1/customers/{customerId} | Get Customer Profile
|
|
@@ -199,7 +309,8 @@ Class | Method | HTTP request | Description
|
|
|
199
309
|
*TalonOne::ManagementApi* | [**get_loyalty_points**](docs/ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
|
|
200
310
|
*TalonOne::ManagementApi* | [**get_loyalty_program**](docs/ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
|
|
201
311
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
|
|
202
|
-
*TalonOne::ManagementApi* | [**
|
|
312
|
+
*TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
|
|
313
|
+
*TalonOne::ManagementApi* | [**get_referrals**](docs/ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
|
|
203
314
|
*TalonOne::ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
|
|
204
315
|
*TalonOne::ManagementApi* | [**get_role**](docs/ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
|
|
205
316
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
|
|
@@ -210,16 +321,15 @@ Class | Method | HTTP request | Description
|
|
|
210
321
|
*TalonOne::ManagementApi* | [**get_webhook_activation_logs**](docs/ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
|
|
211
322
|
*TalonOne::ManagementApi* | [**get_webhook_logs**](docs/ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
|
|
212
323
|
*TalonOne::ManagementApi* | [**get_webhooks**](docs/ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List Webhooks
|
|
213
|
-
*TalonOne::ManagementApi* | [**refresh_analytics**](docs/ManagementApi.md#refresh_analytics) | **POST** /v1/refresh_analytics | Trigger refresh on stale analytics.
|
|
214
324
|
*TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer
|
|
215
325
|
*TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
|
216
|
-
*TalonOne::ManagementApi* | [**search_coupons_advanced**](docs/ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes
|
|
217
|
-
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide**](docs/ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
326
|
+
*TalonOne::ManagementApi* | [**search_coupons_advanced**](docs/ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count)
|
|
327
|
+
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide**](docs/ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
218
328
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
219
329
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
|
|
220
|
-
*TalonOne::ManagementApi* | [**
|
|
330
|
+
*TalonOne::ManagementApi* | [**update_additional_cost**](docs/ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost
|
|
331
|
+
*TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
|
221
332
|
*TalonOne::ManagementApi* | [**update_campaign**](docs/ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
|
222
|
-
*TalonOne::ManagementApi* | [**update_campaign_set**](docs/ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
|
|
223
333
|
*TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
|
224
334
|
*TalonOne::ManagementApi* | [**update_coupon_batch**](docs/ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
|
|
225
335
|
*TalonOne::ManagementApi* | [**update_ruleset**](docs/ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
|
|
@@ -228,11 +338,17 @@ Class | Method | HTTP request | Description
|
|
|
228
338
|
## Documentation for Models
|
|
229
339
|
|
|
230
340
|
- [TalonOne::APIError](docs/APIError.md)
|
|
341
|
+
- [TalonOne::AcceptCouponEffectProps](docs/AcceptCouponEffectProps.md)
|
|
342
|
+
- [TalonOne::AcceptReferralEffectProps](docs/AcceptReferralEffectProps.md)
|
|
231
343
|
- [TalonOne::AccessLogEntry](docs/AccessLogEntry.md)
|
|
232
344
|
- [TalonOne::Account](docs/Account.md)
|
|
345
|
+
- [TalonOne::AccountAdditionalCost](docs/AccountAdditionalCost.md)
|
|
233
346
|
- [TalonOne::AccountAnalytics](docs/AccountAnalytics.md)
|
|
234
347
|
- [TalonOne::AccountEntity](docs/AccountEntity.md)
|
|
235
348
|
- [TalonOne::AccountLimits](docs/AccountLimits.md)
|
|
349
|
+
- [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
|
|
350
|
+
- [TalonOne::AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md)
|
|
351
|
+
- [TalonOne::AdditionalCost](docs/AdditionalCost.md)
|
|
236
352
|
- [TalonOne::Application](docs/Application.md)
|
|
237
353
|
- [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
|
|
238
354
|
- [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
|
|
@@ -244,12 +360,18 @@ Class | Method | HTTP request | Description
|
|
|
244
360
|
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
|
|
245
361
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
|
246
362
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
247
|
-
- [TalonOne::
|
|
363
|
+
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
364
|
+
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
365
|
+
- [TalonOne::Audience](docs/Audience.md)
|
|
366
|
+
- [TalonOne::AudienceMembership](docs/AudienceMembership.md)
|
|
367
|
+
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
|
248
368
|
- [TalonOne::Binding](docs/Binding.md)
|
|
249
369
|
- [TalonOne::Campaign](docs/Campaign.md)
|
|
250
370
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
|
251
371
|
- [TalonOne::CampaignCopy](docs/CampaignCopy.md)
|
|
252
372
|
- [TalonOne::CampaignEntity](docs/CampaignEntity.md)
|
|
373
|
+
- [TalonOne::CampaignGroup](docs/CampaignGroup.md)
|
|
374
|
+
- [TalonOne::CampaignGroupEntity](docs/CampaignGroupEntity.md)
|
|
253
375
|
- [TalonOne::CampaignSearch](docs/CampaignSearch.md)
|
|
254
376
|
- [TalonOne::CampaignSet](docs/CampaignSet.md)
|
|
255
377
|
- [TalonOne::CampaignSetBranchNode](docs/CampaignSetBranchNode.md)
|
|
@@ -258,9 +380,11 @@ Class | Method | HTTP request | Description
|
|
|
258
380
|
- [TalonOne::CartItem](docs/CartItem.md)
|
|
259
381
|
- [TalonOne::CartItemAdjustment](docs/CartItemAdjustment.md)
|
|
260
382
|
- [TalonOne::Change](docs/Change.md)
|
|
383
|
+
- [TalonOne::ChangeProfilePassword](docs/ChangeProfilePassword.md)
|
|
261
384
|
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
|
|
262
385
|
- [TalonOne::Coupon](docs/Coupon.md)
|
|
263
386
|
- [TalonOne::CouponConstraints](docs/CouponConstraints.md)
|
|
387
|
+
- [TalonOne::CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
|
|
264
388
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
|
265
389
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
266
390
|
- [TalonOne::CouponSearch](docs/CouponSearch.md)
|
|
@@ -268,12 +392,22 @@ Class | Method | HTTP request | Description
|
|
|
268
392
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
|
269
393
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
|
270
394
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
|
395
|
+
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
|
271
396
|
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
|
|
397
|
+
- [TalonOne::CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md)
|
|
398
|
+
- [TalonOne::CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md)
|
|
399
|
+
- [TalonOne::CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md)
|
|
272
400
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
|
273
401
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
|
402
|
+
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
|
403
|
+
- [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
|
|
404
|
+
- [TalonOne::Effect](docs/Effect.md)
|
|
405
|
+
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
|
274
406
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
|
275
407
|
- [TalonOne::Entity](docs/Entity.md)
|
|
408
|
+
- [TalonOne::EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md)
|
|
276
409
|
- [TalonOne::Environment](docs/Environment.md)
|
|
410
|
+
- [TalonOne::ErrorEffectProps](docs/ErrorEffectProps.md)
|
|
277
411
|
- [TalonOne::ErrorResponse](docs/ErrorResponse.md)
|
|
278
412
|
- [TalonOne::ErrorSource](docs/ErrorSource.md)
|
|
279
413
|
- [TalonOne::Event](docs/Event.md)
|
|
@@ -282,6 +416,7 @@ Class | Method | HTTP request | Description
|
|
|
282
416
|
- [TalonOne::FeatureFlag](docs/FeatureFlag.md)
|
|
283
417
|
- [TalonOne::FeatureFlags](docs/FeatureFlags.md)
|
|
284
418
|
- [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
|
|
419
|
+
- [TalonOne::FeedNotification](docs/FeedNotification.md)
|
|
285
420
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
|
286
421
|
- [TalonOne::FunctionDef](docs/FunctionDef.md)
|
|
287
422
|
- [TalonOne::Import](docs/Import.md)
|
|
@@ -308,7 +443,9 @@ Class | Method | HTTP request | Description
|
|
|
308
443
|
- [TalonOne::InlineResponse20026](docs/InlineResponse20026.md)
|
|
309
444
|
- [TalonOne::InlineResponse20027](docs/InlineResponse20027.md)
|
|
310
445
|
- [TalonOne::InlineResponse20028](docs/InlineResponse20028.md)
|
|
446
|
+
- [TalonOne::InlineResponse20029](docs/InlineResponse20029.md)
|
|
311
447
|
- [TalonOne::InlineResponse2003](docs/InlineResponse2003.md)
|
|
448
|
+
- [TalonOne::InlineResponse20030](docs/InlineResponse20030.md)
|
|
312
449
|
- [TalonOne::InlineResponse2004](docs/InlineResponse2004.md)
|
|
313
450
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
|
314
451
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
|
@@ -318,7 +455,9 @@ Class | Method | HTTP request | Description
|
|
|
318
455
|
- [TalonOne::IntegrationEntity](docs/IntegrationEntity.md)
|
|
319
456
|
- [TalonOne::IntegrationEvent](docs/IntegrationEvent.md)
|
|
320
457
|
- [TalonOne::IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
|
|
458
|
+
- [TalonOne::IntegrationRequest](docs/IntegrationRequest.md)
|
|
321
459
|
- [TalonOne::IntegrationState](docs/IntegrationState.md)
|
|
460
|
+
- [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md)
|
|
322
461
|
- [TalonOne::LedgerEntry](docs/LedgerEntry.md)
|
|
323
462
|
- [TalonOne::LibraryAttribute](docs/LibraryAttribute.md)
|
|
324
463
|
- [TalonOne::LimitConfig](docs/LimitConfig.md)
|
|
@@ -331,22 +470,29 @@ Class | Method | HTTP request | Description
|
|
|
331
470
|
- [TalonOne::LoyaltyProgram](docs/LoyaltyProgram.md)
|
|
332
471
|
- [TalonOne::LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md)
|
|
333
472
|
- [TalonOne::LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md)
|
|
473
|
+
- [TalonOne::LoyaltyStatistics](docs/LoyaltyStatistics.md)
|
|
334
474
|
- [TalonOne::LoyaltySubLedger](docs/LoyaltySubLedger.md)
|
|
335
475
|
- [TalonOne::ManagerConfig](docs/ManagerConfig.md)
|
|
336
476
|
- [TalonOne::Meta](docs/Meta.md)
|
|
337
|
-
- [TalonOne::MiscUpdateUserLatestFeature](docs/MiscUpdateUserLatestFeature.md)
|
|
338
477
|
- [TalonOne::MultiApplicationEntity](docs/MultiApplicationEntity.md)
|
|
478
|
+
- [TalonOne::MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md)
|
|
479
|
+
- [TalonOne::MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md)
|
|
480
|
+
- [TalonOne::MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md)
|
|
339
481
|
- [TalonOne::MutableEntity](docs/MutableEntity.md)
|
|
340
482
|
- [TalonOne::NewAccount](docs/NewAccount.md)
|
|
341
483
|
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
|
|
484
|
+
- [TalonOne::NewAdditionalCost](docs/NewAdditionalCost.md)
|
|
342
485
|
- [TalonOne::NewApplication](docs/NewApplication.md)
|
|
343
486
|
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
|
|
344
487
|
- [TalonOne::NewAttribute](docs/NewAttribute.md)
|
|
488
|
+
- [TalonOne::NewAudience](docs/NewAudience.md)
|
|
345
489
|
- [TalonOne::NewCampaign](docs/NewCampaign.md)
|
|
490
|
+
- [TalonOne::NewCampaignGroup](docs/NewCampaignGroup.md)
|
|
346
491
|
- [TalonOne::NewCampaignSet](docs/NewCampaignSet.md)
|
|
347
492
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
|
348
493
|
- [TalonOne::NewCustomerProfile](docs/NewCustomerProfile.md)
|
|
349
494
|
- [TalonOne::NewCustomerSession](docs/NewCustomerSession.md)
|
|
495
|
+
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
|
350
496
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
|
351
497
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
|
352
498
|
- [TalonOne::NewFeatureFlags](docs/NewFeatureFlags.md)
|
|
@@ -364,29 +510,46 @@ Class | Method | HTTP request | Description
|
|
|
364
510
|
- [TalonOne::NewUser](docs/NewUser.md)
|
|
365
511
|
- [TalonOne::NewWebhook](docs/NewWebhook.md)
|
|
366
512
|
- [TalonOne::Notification](docs/Notification.md)
|
|
367
|
-
- [TalonOne::
|
|
513
|
+
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
|
368
514
|
- [TalonOne::Referral](docs/Referral.md)
|
|
515
|
+
- [TalonOne::ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md)
|
|
369
516
|
- [TalonOne::ReferralRejectionReason](docs/ReferralRejectionReason.md)
|
|
517
|
+
- [TalonOne::RejectCouponEffectProps](docs/RejectCouponEffectProps.md)
|
|
518
|
+
- [TalonOne::RejectReferralEffectProps](docs/RejectReferralEffectProps.md)
|
|
370
519
|
- [TalonOne::Role](docs/Role.md)
|
|
371
520
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
|
372
521
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
|
522
|
+
- [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
|
|
523
|
+
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
373
524
|
- [TalonOne::Rule](docs/Rule.md)
|
|
374
525
|
- [TalonOne::Ruleset](docs/Ruleset.md)
|
|
375
526
|
- [TalonOne::SamlConnection](docs/SamlConnection.md)
|
|
527
|
+
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
|
528
|
+
- [TalonOne::SamlLoginEndpoint](docs/SamlLoginEndpoint.md)
|
|
376
529
|
- [TalonOne::Session](docs/Session.md)
|
|
530
|
+
- [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
|
|
531
|
+
- [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
|
|
532
|
+
- [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
|
|
533
|
+
- [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
|
|
377
534
|
- [TalonOne::SlotDef](docs/SlotDef.md)
|
|
378
535
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
|
379
536
|
- [TalonOne::TemplateDef](docs/TemplateDef.md)
|
|
537
|
+
- [TalonOne::TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md)
|
|
380
538
|
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
|
|
381
539
|
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
|
540
|
+
- [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
|
|
541
|
+
- [TalonOne::UpdateAudience](docs/UpdateAudience.md)
|
|
382
542
|
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
|
|
543
|
+
- [TalonOne::UpdateCampaignGroup](docs/UpdateCampaignGroup.md)
|
|
383
544
|
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
|
|
384
545
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
|
385
546
|
- [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
|
|
386
547
|
- [TalonOne::UpdateRole](docs/UpdateRole.md)
|
|
387
548
|
- [TalonOne::UpdateUser](docs/UpdateUser.md)
|
|
549
|
+
- [TalonOne::UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md)
|
|
388
550
|
- [TalonOne::User](docs/User.md)
|
|
389
551
|
- [TalonOne::UserEntity](docs/UserEntity.md)
|
|
552
|
+
- [TalonOne::UserFeedNotifications](docs/UserFeedNotifications.md)
|
|
390
553
|
- [TalonOne::Webhook](docs/Webhook.md)
|
|
391
554
|
- [TalonOne::WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md)
|
|
392
555
|
- [TalonOne::WebhookLogEntry](docs/WebhookLogEntry.md)
|
|
@@ -397,18 +560,21 @@ Class | Method | HTTP request | Description
|
|
|
397
560
|
|
|
398
561
|
### api_key_v1
|
|
399
562
|
|
|
563
|
+
|
|
400
564
|
- **Type**: API key
|
|
401
565
|
- **API key parameter name**: Authorization
|
|
402
566
|
- **Location**: HTTP header
|
|
403
567
|
|
|
404
568
|
### integration_auth
|
|
405
569
|
|
|
570
|
+
|
|
406
571
|
- **Type**: API key
|
|
407
572
|
- **API key parameter name**: Content-Signature
|
|
408
573
|
- **Location**: HTTP header
|
|
409
574
|
|
|
410
575
|
### manager_auth
|
|
411
576
|
|
|
577
|
+
|
|
412
578
|
- **Type**: API key
|
|
413
579
|
- **API key parameter name**: Authorization
|
|
414
580
|
- **Location**: HTTP header
|