talon_one 1.1.2 → 2.1.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 +5 -5
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +178 -26
- 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 +24 -0
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +21 -0
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +27 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +25 -2
- data/docs/ApplicationAPIKey.md +15 -0
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +18 -1
- 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 -2
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -4
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +38 -3
- data/docs/CampaignCopy.md +18 -0
- data/docs/CampaignEntity.md +9 -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 +10 -0
- data/docs/CustomerActivityReport.md +21 -0
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +21 -0
- data/docs/CustomerProfile.md +17 -1
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerProfileUpdate.md +17 -0
- data/docs/CustomerSession.md +23 -2
- 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/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +13 -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/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 +10 -0
- 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 +11 -1
- 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 +198 -64
- data/docs/IntegrationEntity.md +10 -0
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +14 -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 +20 -0
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +12 -0
- data/docs/LoyaltyProgram.md +17 -1
- data/docs/LoyaltyProgramBalance.md +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltySubLedger.md +11 -0
- data/docs/ManagementApi.md +834 -815
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +17 -3
- data/docs/MiscUpdateUserLatestFeature.md +9 -0
- data/docs/MultiApplicationEntity.md +9 -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 +22 -2
- data/docs/NewApplicationAPIKey.md +16 -0
- data/docs/NewAttribute.md +20 -2
- data/docs/NewCampaign.md +21 -1
- 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 +15 -1
- 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 +33 -0
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +21 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +21 -0
- data/docs/RejectCouponEffectProps.md +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +15 -1
- 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 +37 -0
- data/docs/SamlConnectionMetadata.md +23 -0
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +19 -0
- data/docs/SetDiscountPerItemEffectProps.md +21 -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 +33 -0
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateCampaign.md +21 -1
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +14 -1
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +17 -4
- data/docs/User.md +26 -2
- data/docs/UserEntity.md +9 -0
- data/docs/Webhook.md +20 -2
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +75 -33
- data/lib/talon_one/api/integration_api.rb +372 -130
- data/lib/talon_one/api/management_api.rb +2238 -1444
- data/lib/talon_one/api_client.rb +39 -42
- 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 +78 -40
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +67 -34
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +288 -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 +87 -85
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +47 -24
- data/lib/talon_one/models/application_customer.rb +52 -29
- 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 +82 -34
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +67 -66
- 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/base_saml_connection.rb +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +97 -54
- data/lib/talon_one/models/campaign_analytics.rb +160 -47
- 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_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 +39 -16
- data/lib/talon_one/models/customer_activity_report.rb +61 -38
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +228 -0
- data/lib/talon_one/models/customer_profile.rb +51 -28
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_profile_update.rb +211 -0
- data/lib/talon_one/models/customer_session.rb +59 -36
- 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/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 +54 -21
- 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/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_response_200_12.rb → inline_response20012.rb} +40 -17
- 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_response20020.rb +227 -0
- 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} +51 -24
- 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 +40 -17
- 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 +54 -22
- 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 +70 -37
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +43 -20
- data/lib/talon_one/models/loyalty_program.rb +50 -27
- 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_sub_ledger.rb +41 -18
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +52 -20
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +39 -16
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- 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 +111 -81
- data/lib/talon_one/models/new_application_api_key.rb +48 -25
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_campaign.rb +57 -34
- 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 +47 -24
- 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 +394 -0
- 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 +242 -0
- 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 +274 -0
- 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 +45 -22
- 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 +410 -0
- 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 +228 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +243 -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 +406 -0
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_campaign.rb +57 -34
- 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 +46 -23
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +62 -66
- data/lib/talon_one/models/user.rb +81 -39
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/webhook.rb +56 -50
- 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 +44 -11
- data/spec/api/management_api_spec.rb +141 -140
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/accept_coupon_effect_props_spec.rb +41 -0
- 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 +10 -4
- 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 +71 -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 +4 -4
- 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 +4 -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 +16 -4
- data/spec/models/application_spec.rb +20 -10
- data/spec/models/attribute_spec.rb +5 -11
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +40 -4
- data/spec/models/campaign_copy_spec.rb +28 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- 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 +16 -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 +4 -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 +53 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +4 -4
- data/spec/models/customer_profile_update_spec.rb +41 -0
- 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/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 +10 -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/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} +4 -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 -4
- 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 +10 -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 +5 -5
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +11 -5
- 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 +4 -4
- 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 +4 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_sub_ledger_spec.rb +4 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +10 -4
- data/spec/models/misc_update_user_latest_feature_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- 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 +4 -4
- data/spec/models/new_application_spec.rb +26 -10
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +4 -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 +4 -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 +89 -0
- 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 +53 -0
- 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 +57 -0
- 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 +4 -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 +101 -0
- 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 +47 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +53 -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 +97 -0
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_campaign_spec.rb +4 -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 +4 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_spec.rb +10 -22
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_spec.rb +16 -4
- 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 -10
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +271 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.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/spec/models/attribute_query_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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: b6644f80268196bcf1df9640877fe2225e4199e787a4b11efcd26008a282153b
|
|
4
|
+
data.tar.gz: eaeacca070e707b6bbb70ecfe656d4c774cce5d7cdf47cb4882f97a5d168a128
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3a6eb4a5e13fb61853a76fca15690396d484dcd4fbbfd92168af9bc6022686f8d974636ca39b16173d487ceedd06684bebab27c5c4d7f177b6343a1616f69886
|
|
7
|
+
data.tar.gz: c0aebea1243366954cd9ff58fb868085e4173cdff19b41f557160c75339ba430643f7e463bd4c47e3551a41a1c5da9d3968b6cef9e7215604233a3c871109e53
|
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.1.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.1.0.gem
|
|
27
37
|
```
|
|
28
|
-
|
|
38
|
+
|
|
39
|
+
(for development, run `gem install --dev ./talon_one-2.1.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.1.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,17 @@ 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
249
|
*TalonOne::IntegrationApi* | [**update_customer_profile**](docs/IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
|
|
250
|
+
*TalonOne::IntegrationApi* | [**update_customer_profile_v2**](docs/IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile
|
|
147
251
|
*TalonOne::IntegrationApi* | [**update_customer_session**](docs/IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
|
|
252
|
+
*TalonOne::IntegrationApi* | [**update_customer_session_v2**](docs/IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
|
|
148
253
|
*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
254
|
*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
|
|
255
|
+
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Define a new additional cost
|
|
256
|
+
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
|
150
257
|
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
|
151
258
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
|
152
259
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
|
@@ -157,37 +264,38 @@ Class | Method | HTTP request | Description
|
|
|
157
264
|
*TalonOne::ManagementApi* | [**delete_coupons**](docs/ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
|
|
158
265
|
*TalonOne::ManagementApi* | [**delete_referral**](docs/ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
|
|
159
266
|
*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
|
|
267
|
+
*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
268
|
*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
269
|
*TalonOne::ManagementApi* | [**get_account**](docs/ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
|
163
270
|
*TalonOne::ManagementApi* | [**get_account_analytics**](docs/ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
|
164
|
-
*TalonOne::ManagementApi* | [**
|
|
271
|
+
*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
|
|
272
|
+
*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
|
165
273
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
|
166
274
|
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
|
167
275
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
|
168
276
|
*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
277
|
*TalonOne::ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
|
|
170
278
|
*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
|
|
279
|
+
*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
280
|
*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
|
|
281
|
+
*TalonOne::ManagementApi* | [**get_application_events**](docs/ManagementApi.md#get_application_events) | **GET** /v1/applications/{applicationId}/events | List Applications Events (with total count)
|
|
174
282
|
*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
283
|
*TalonOne::ManagementApi* | [**get_application_session**](docs/ManagementApi.md#get_application_session) | **GET** /v1/applications/{applicationId}/sessions/{sessionId} | Get Application Session
|
|
176
284
|
*TalonOne::ManagementApi* | [**get_application_sessions**](docs/ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
|
177
285
|
*TalonOne::ManagementApi* | [**get_applications**](docs/ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
|
178
286
|
*TalonOne::ManagementApi* | [**get_attribute**](docs/ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
|
287
|
+
*TalonOne::ManagementApi* | [**get_attributes**](docs/ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
|
179
288
|
*TalonOne::ManagementApi* | [**get_campaign**](docs/ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
|
180
289
|
*TalonOne::ManagementApi* | [**get_campaign_analytics**](docs/ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
|
181
290
|
*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
291
|
*TalonOne::ManagementApi* | [**get_campaigns**](docs/ManagementApi.md#get_campaigns) | **GET** /v1/applications/{applicationId}/campaigns | List your Campaigns
|
|
184
292
|
*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
|
|
293
|
+
*TalonOne::ManagementApi* | [**get_coupons**](docs/ManagementApi.md#get_coupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons (with total count)
|
|
186
294
|
*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
|
|
295
|
+
*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
296
|
*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
297
|
*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
|
|
298
|
+
*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
299
|
*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
300
|
*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
301
|
*TalonOne::ManagementApi* | [**get_customer_profile**](docs/ManagementApi.md#get_customer_profile) | **GET** /v1/customers/{customerId} | Get Customer Profile
|
|
@@ -199,7 +307,7 @@ Class | Method | HTTP request | Description
|
|
|
199
307
|
*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
308
|
*TalonOne::ManagementApi* | [**get_loyalty_program**](docs/ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
|
|
201
309
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
|
|
202
|
-
*TalonOne::ManagementApi* | [**get_referrals**](docs/ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals
|
|
310
|
+
*TalonOne::ManagementApi* | [**get_referrals**](docs/ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
|
|
203
311
|
*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
312
|
*TalonOne::ManagementApi* | [**get_role**](docs/ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
|
|
205
313
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
|
|
@@ -210,16 +318,15 @@ Class | Method | HTTP request | Description
|
|
|
210
318
|
*TalonOne::ManagementApi* | [**get_webhook_activation_logs**](docs/ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
|
|
211
319
|
*TalonOne::ManagementApi* | [**get_webhook_logs**](docs/ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
|
|
212
320
|
*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
321
|
*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
322
|
*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
|
|
323
|
+
*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)
|
|
324
|
+
*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
325
|
*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
326
|
*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* | [**
|
|
327
|
+
*TalonOne::ManagementApi* | [**update_additional_cost**](docs/ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost
|
|
328
|
+
*TalonOne::ManagementApi* | [**update_attribute**](docs/ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
|
221
329
|
*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
330
|
*TalonOne::ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
|
224
331
|
*TalonOne::ManagementApi* | [**update_coupon_batch**](docs/ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
|
|
225
332
|
*TalonOne::ManagementApi* | [**update_ruleset**](docs/ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
|
|
@@ -228,11 +335,17 @@ Class | Method | HTTP request | Description
|
|
|
228
335
|
## Documentation for Models
|
|
229
336
|
|
|
230
337
|
- [TalonOne::APIError](docs/APIError.md)
|
|
338
|
+
- [TalonOne::AcceptCouponEffectProps](docs/AcceptCouponEffectProps.md)
|
|
339
|
+
- [TalonOne::AcceptReferralEffectProps](docs/AcceptReferralEffectProps.md)
|
|
231
340
|
- [TalonOne::AccessLogEntry](docs/AccessLogEntry.md)
|
|
232
341
|
- [TalonOne::Account](docs/Account.md)
|
|
342
|
+
- [TalonOne::AccountAdditionalCost](docs/AccountAdditionalCost.md)
|
|
233
343
|
- [TalonOne::AccountAnalytics](docs/AccountAnalytics.md)
|
|
234
344
|
- [TalonOne::AccountEntity](docs/AccountEntity.md)
|
|
235
345
|
- [TalonOne::AccountLimits](docs/AccountLimits.md)
|
|
346
|
+
- [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
|
|
347
|
+
- [TalonOne::AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md)
|
|
348
|
+
- [TalonOne::AdditionalCost](docs/AdditionalCost.md)
|
|
236
349
|
- [TalonOne::Application](docs/Application.md)
|
|
237
350
|
- [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
|
|
238
351
|
- [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
|
|
@@ -244,7 +357,9 @@ Class | Method | HTTP request | Description
|
|
|
244
357
|
- [TalonOne::ApplicationSession](docs/ApplicationSession.md)
|
|
245
358
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
|
246
359
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
247
|
-
- [TalonOne::
|
|
360
|
+
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
361
|
+
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
362
|
+
- [TalonOne::BaseSamlConnection](docs/BaseSamlConnection.md)
|
|
248
363
|
- [TalonOne::Binding](docs/Binding.md)
|
|
249
364
|
- [TalonOne::Campaign](docs/Campaign.md)
|
|
250
365
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
|
@@ -258,9 +373,11 @@ Class | Method | HTTP request | Description
|
|
|
258
373
|
- [TalonOne::CartItem](docs/CartItem.md)
|
|
259
374
|
- [TalonOne::CartItemAdjustment](docs/CartItemAdjustment.md)
|
|
260
375
|
- [TalonOne::Change](docs/Change.md)
|
|
376
|
+
- [TalonOne::ChangeProfilePassword](docs/ChangeProfilePassword.md)
|
|
261
377
|
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
|
|
262
378
|
- [TalonOne::Coupon](docs/Coupon.md)
|
|
263
379
|
- [TalonOne::CouponConstraints](docs/CouponConstraints.md)
|
|
380
|
+
- [TalonOne::CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
|
|
264
381
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
|
265
382
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
266
383
|
- [TalonOne::CouponSearch](docs/CouponSearch.md)
|
|
@@ -268,12 +385,19 @@ Class | Method | HTTP request | Description
|
|
|
268
385
|
- [TalonOne::CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md)
|
|
269
386
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
|
270
387
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
|
388
|
+
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
|
271
389
|
- [TalonOne::CustomerProfile](docs/CustomerProfile.md)
|
|
272
390
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
|
391
|
+
- [TalonOne::CustomerProfileUpdate](docs/CustomerProfileUpdate.md)
|
|
273
392
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
|
393
|
+
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
|
394
|
+
- [TalonOne::DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
|
|
395
|
+
- [TalonOne::Effect](docs/Effect.md)
|
|
396
|
+
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
|
274
397
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
|
275
398
|
- [TalonOne::Entity](docs/Entity.md)
|
|
276
399
|
- [TalonOne::Environment](docs/Environment.md)
|
|
400
|
+
- [TalonOne::ErrorEffectProps](docs/ErrorEffectProps.md)
|
|
277
401
|
- [TalonOne::ErrorResponse](docs/ErrorResponse.md)
|
|
278
402
|
- [TalonOne::ErrorSource](docs/ErrorSource.md)
|
|
279
403
|
- [TalonOne::Event](docs/Event.md)
|
|
@@ -308,7 +432,9 @@ Class | Method | HTTP request | Description
|
|
|
308
432
|
- [TalonOne::InlineResponse20026](docs/InlineResponse20026.md)
|
|
309
433
|
- [TalonOne::InlineResponse20027](docs/InlineResponse20027.md)
|
|
310
434
|
- [TalonOne::InlineResponse20028](docs/InlineResponse20028.md)
|
|
435
|
+
- [TalonOne::InlineResponse20029](docs/InlineResponse20029.md)
|
|
311
436
|
- [TalonOne::InlineResponse2003](docs/InlineResponse2003.md)
|
|
437
|
+
- [TalonOne::InlineResponse20030](docs/InlineResponse20030.md)
|
|
312
438
|
- [TalonOne::InlineResponse2004](docs/InlineResponse2004.md)
|
|
313
439
|
- [TalonOne::InlineResponse2005](docs/InlineResponse2005.md)
|
|
314
440
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
|
@@ -318,7 +444,9 @@ Class | Method | HTTP request | Description
|
|
|
318
444
|
- [TalonOne::IntegrationEntity](docs/IntegrationEntity.md)
|
|
319
445
|
- [TalonOne::IntegrationEvent](docs/IntegrationEvent.md)
|
|
320
446
|
- [TalonOne::IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
|
|
447
|
+
- [TalonOne::IntegrationRequest](docs/IntegrationRequest.md)
|
|
321
448
|
- [TalonOne::IntegrationState](docs/IntegrationState.md)
|
|
449
|
+
- [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md)
|
|
322
450
|
- [TalonOne::LedgerEntry](docs/LedgerEntry.md)
|
|
323
451
|
- [TalonOne::LibraryAttribute](docs/LibraryAttribute.md)
|
|
324
452
|
- [TalonOne::LimitConfig](docs/LimitConfig.md)
|
|
@@ -339,6 +467,7 @@ Class | Method | HTTP request | Description
|
|
|
339
467
|
- [TalonOne::MutableEntity](docs/MutableEntity.md)
|
|
340
468
|
- [TalonOne::NewAccount](docs/NewAccount.md)
|
|
341
469
|
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
|
|
470
|
+
- [TalonOne::NewAdditionalCost](docs/NewAdditionalCost.md)
|
|
342
471
|
- [TalonOne::NewApplication](docs/NewApplication.md)
|
|
343
472
|
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
|
|
344
473
|
- [TalonOne::NewAttribute](docs/NewAttribute.md)
|
|
@@ -347,6 +476,7 @@ Class | Method | HTTP request | Description
|
|
|
347
476
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
|
348
477
|
- [TalonOne::NewCustomerProfile](docs/NewCustomerProfile.md)
|
|
349
478
|
- [TalonOne::NewCustomerSession](docs/NewCustomerSession.md)
|
|
479
|
+
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
|
350
480
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
|
351
481
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
|
352
482
|
- [TalonOne::NewFeatureFlags](docs/NewFeatureFlags.md)
|
|
@@ -359,20 +489,39 @@ Class | Method | HTTP request | Description
|
|
|
359
489
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
|
360
490
|
- [TalonOne::NewRole](docs/NewRole.md)
|
|
361
491
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
|
492
|
+
- [TalonOne::NewSamlConnection](docs/NewSamlConnection.md)
|
|
362
493
|
- [TalonOne::NewTemplateDef](docs/NewTemplateDef.md)
|
|
363
494
|
- [TalonOne::NewUser](docs/NewUser.md)
|
|
364
495
|
- [TalonOne::NewWebhook](docs/NewWebhook.md)
|
|
496
|
+
- [TalonOne::Notification](docs/Notification.md)
|
|
497
|
+
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
|
365
498
|
- [TalonOne::Referral](docs/Referral.md)
|
|
499
|
+
- [TalonOne::ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md)
|
|
500
|
+
- [TalonOne::ReferralRejectionReason](docs/ReferralRejectionReason.md)
|
|
501
|
+
- [TalonOne::RejectCouponEffectProps](docs/RejectCouponEffectProps.md)
|
|
502
|
+
- [TalonOne::RejectReferralEffectProps](docs/RejectReferralEffectProps.md)
|
|
366
503
|
- [TalonOne::Role](docs/Role.md)
|
|
367
504
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
|
368
505
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
|
506
|
+
- [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
|
|
507
|
+
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
369
508
|
- [TalonOne::Rule](docs/Rule.md)
|
|
370
509
|
- [TalonOne::Ruleset](docs/Ruleset.md)
|
|
510
|
+
- [TalonOne::SamlConnection](docs/SamlConnection.md)
|
|
511
|
+
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
|
512
|
+
- [TalonOne::SamlLoginEndpoint](docs/SamlLoginEndpoint.md)
|
|
371
513
|
- [TalonOne::Session](docs/Session.md)
|
|
514
|
+
- [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
|
|
515
|
+
- [TalonOne::SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md)
|
|
516
|
+
- [TalonOne::ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md)
|
|
517
|
+
- [TalonOne::ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md)
|
|
372
518
|
- [TalonOne::SlotDef](docs/SlotDef.md)
|
|
373
519
|
- [TalonOne::TemplateArgDef](docs/TemplateArgDef.md)
|
|
374
520
|
- [TalonOne::TemplateDef](docs/TemplateDef.md)
|
|
521
|
+
- [TalonOne::TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md)
|
|
375
522
|
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
|
|
523
|
+
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
|
524
|
+
- [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
|
|
376
525
|
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
|
|
377
526
|
- [TalonOne::UpdateCoupon](docs/UpdateCoupon.md)
|
|
378
527
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
|
@@ -391,18 +540,21 @@ Class | Method | HTTP request | Description
|
|
|
391
540
|
|
|
392
541
|
### api_key_v1
|
|
393
542
|
|
|
543
|
+
|
|
394
544
|
- **Type**: API key
|
|
395
545
|
- **API key parameter name**: Authorization
|
|
396
546
|
- **Location**: HTTP header
|
|
397
547
|
|
|
398
548
|
### integration_auth
|
|
399
549
|
|
|
550
|
+
|
|
400
551
|
- **Type**: API key
|
|
401
552
|
- **API key parameter name**: Content-Signature
|
|
402
553
|
- **Location**: HTTP header
|
|
403
554
|
|
|
404
555
|
### manager_auth
|
|
405
556
|
|
|
557
|
+
|
|
406
558
|
- **Type**: API key
|
|
407
559
|
- **API key parameter name**: Authorization
|
|
408
560
|
- **Location**: HTTP header
|
data/Rakefile
CHANGED
data/docs/APIError.md
CHANGED
|
@@ -1,10 +1,21 @@
|
|
|
1
1
|
# TalonOne::APIError
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
+
|
|
4
5
|
Name | Type | Description | Notes
|
|
5
6
|
------------ | ------------- | ------------- | -------------
|
|
6
7
|
**title** | **String** | Short description of the problem. |
|
|
7
8
|
**details** | **String** | Longer description of this specific instance of the problem. | [optional]
|
|
8
9
|
**source** | [**ErrorSource**](ErrorSource.md) | |
|
|
9
10
|
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::APIError.new(title: null,
|
|
17
|
+
details: null,
|
|
18
|
+
source: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
10
21
|
|