talon_one 1.1.2 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? 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` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -42,7 +42,7 @@ module TalonOne
|
|
42
42
|
end
|
43
43
|
|
44
44
|
# Attribute type mapping.
|
45
|
-
def self.
|
45
|
+
def self.openapi_types
|
46
46
|
{
|
47
47
|
:'integration_request_uuid' => :'String',
|
48
48
|
:'webhook_id' => :'Integer',
|
@@ -52,31 +52,44 @@ module TalonOne
|
|
52
52
|
}
|
53
53
|
end
|
54
54
|
|
55
|
+
# List of attributes with nullable: true
|
56
|
+
def self.openapi_nullable
|
57
|
+
Set.new([
|
58
|
+
])
|
59
|
+
end
|
60
|
+
|
55
61
|
# Initializes the object
|
56
62
|
# @param [Hash] attributes Model attributes in the form of hash
|
57
63
|
def initialize(attributes = {})
|
58
|
-
|
64
|
+
if (!attributes.is_a?(Hash))
|
65
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::WebhookActivationLogEntry` initialize method"
|
66
|
+
end
|
59
67
|
|
60
|
-
# convert string to symbol for hash key
|
61
|
-
attributes = attributes.each_with_object({}) { |(k, v), h|
|
68
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
69
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
70
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
71
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::WebhookActivationLogEntry`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
72
|
+
end
|
73
|
+
h[k.to_sym] = v
|
74
|
+
}
|
62
75
|
|
63
|
-
if attributes.
|
64
|
-
self.integration_request_uuid = attributes[:'
|
76
|
+
if attributes.key?(:'integration_request_uuid')
|
77
|
+
self.integration_request_uuid = attributes[:'integration_request_uuid']
|
65
78
|
end
|
66
79
|
|
67
|
-
if attributes.
|
68
|
-
self.webhook_id = attributes[:'
|
80
|
+
if attributes.key?(:'webhook_id')
|
81
|
+
self.webhook_id = attributes[:'webhook_id']
|
69
82
|
end
|
70
83
|
|
71
|
-
if attributes.
|
72
|
-
self.application_id = attributes[:'
|
84
|
+
if attributes.key?(:'application_id')
|
85
|
+
self.application_id = attributes[:'application_id']
|
73
86
|
end
|
74
87
|
|
75
|
-
if attributes.
|
76
|
-
self.campaign_id = attributes[:'
|
88
|
+
if attributes.key?(:'campaign_id')
|
89
|
+
self.campaign_id = attributes[:'campaign_id']
|
77
90
|
end
|
78
91
|
|
79
|
-
if attributes.
|
92
|
+
if attributes.key?(:'created')
|
80
93
|
self.created = attributes[:'created']
|
81
94
|
end
|
82
95
|
end
|
@@ -138,19 +151,26 @@ module TalonOne
|
|
138
151
|
end
|
139
152
|
|
140
153
|
# Calculates hash code according to all attributes.
|
141
|
-
# @return [
|
154
|
+
# @return [Integer] Hash code
|
142
155
|
def hash
|
143
156
|
[integration_request_uuid, webhook_id, application_id, campaign_id, created].hash
|
144
157
|
end
|
145
158
|
|
159
|
+
# Builds the object from hash
|
160
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
161
|
+
# @return [Object] Returns the model itself
|
162
|
+
def self.build_from_hash(attributes)
|
163
|
+
new.build_from_hash(attributes)
|
164
|
+
end
|
165
|
+
|
146
166
|
# Builds the object from hash
|
147
167
|
# @param [Hash] attributes Model attributes in the form of hash
|
148
168
|
# @return [Object] Returns the model itself
|
149
169
|
def build_from_hash(attributes)
|
150
170
|
return nil unless attributes.is_a?(Hash)
|
151
|
-
self.class.
|
171
|
+
self.class.openapi_types.each_pair do |key, type|
|
152
172
|
if type =~ /\AArray<(.*)>/i
|
153
|
-
# check to ensure the input is an array given that the
|
173
|
+
# check to ensure the input is an array given that the attribute
|
154
174
|
# is documented as an array but the input is not
|
155
175
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
156
176
|
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
@@ -179,7 +199,7 @@ module TalonOne
|
|
179
199
|
value.to_i
|
180
200
|
when :Float
|
181
201
|
value.to_f
|
182
|
-
when :
|
202
|
+
when :Boolean
|
183
203
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
184
204
|
true
|
185
205
|
else
|
@@ -200,8 +220,7 @@ module TalonOne
|
|
200
220
|
end
|
201
221
|
end
|
202
222
|
else # model
|
203
|
-
|
204
|
-
temp_model.build_from_hash(value)
|
223
|
+
TalonOne.const_get(type).build_from_hash(value)
|
205
224
|
end
|
206
225
|
end
|
207
226
|
|
@@ -223,7 +242,11 @@ module TalonOne
|
|
223
242
|
hash = {}
|
224
243
|
self.class.attribute_map.each_pair do |attr, param|
|
225
244
|
value = self.send(attr)
|
226
|
-
|
245
|
+
if value.nil?
|
246
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
247
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
248
|
+
end
|
249
|
+
|
227
250
|
hash[param] = _to_hash(value)
|
228
251
|
end
|
229
252
|
hash
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? 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` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -62,7 +62,7 @@ module TalonOne
|
|
62
62
|
end
|
63
63
|
|
64
64
|
# Attribute type mapping.
|
65
|
-
def self.
|
65
|
+
def self.openapi_types
|
66
66
|
{
|
67
67
|
:'id' => :'String',
|
68
68
|
:'integration_request_uuid' => :'String',
|
@@ -77,52 +77,65 @@ module TalonOne
|
|
77
77
|
}
|
78
78
|
end
|
79
79
|
|
80
|
+
# List of attributes with nullable: true
|
81
|
+
def self.openapi_nullable
|
82
|
+
Set.new([
|
83
|
+
])
|
84
|
+
end
|
85
|
+
|
80
86
|
# Initializes the object
|
81
87
|
# @param [Hash] attributes Model attributes in the form of hash
|
82
88
|
def initialize(attributes = {})
|
83
|
-
|
89
|
+
if (!attributes.is_a?(Hash))
|
90
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::WebhookLogEntry` initialize method"
|
91
|
+
end
|
84
92
|
|
85
|
-
# convert string to symbol for hash key
|
86
|
-
attributes = attributes.each_with_object({}) { |(k, v), h|
|
93
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
94
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
95
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
96
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::WebhookLogEntry`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
97
|
+
end
|
98
|
+
h[k.to_sym] = v
|
99
|
+
}
|
87
100
|
|
88
|
-
if attributes.
|
101
|
+
if attributes.key?(:'id')
|
89
102
|
self.id = attributes[:'id']
|
90
103
|
end
|
91
104
|
|
92
|
-
if attributes.
|
93
|
-
self.integration_request_uuid = attributes[:'
|
105
|
+
if attributes.key?(:'integration_request_uuid')
|
106
|
+
self.integration_request_uuid = attributes[:'integration_request_uuid']
|
94
107
|
end
|
95
108
|
|
96
|
-
if attributes.
|
97
|
-
self.webhook_id = attributes[:'
|
109
|
+
if attributes.key?(:'webhook_id')
|
110
|
+
self.webhook_id = attributes[:'webhook_id']
|
98
111
|
end
|
99
112
|
|
100
|
-
if attributes.
|
101
|
-
self.application_id = attributes[:'
|
113
|
+
if attributes.key?(:'application_id')
|
114
|
+
self.application_id = attributes[:'application_id']
|
102
115
|
end
|
103
116
|
|
104
|
-
if attributes.
|
117
|
+
if attributes.key?(:'url')
|
105
118
|
self.url = attributes[:'url']
|
106
119
|
end
|
107
120
|
|
108
|
-
if attributes.
|
121
|
+
if attributes.key?(:'request')
|
109
122
|
self.request = attributes[:'request']
|
110
123
|
end
|
111
124
|
|
112
|
-
if attributes.
|
125
|
+
if attributes.key?(:'response')
|
113
126
|
self.response = attributes[:'response']
|
114
127
|
end
|
115
128
|
|
116
|
-
if attributes.
|
129
|
+
if attributes.key?(:'status')
|
117
130
|
self.status = attributes[:'status']
|
118
131
|
end
|
119
132
|
|
120
|
-
if attributes.
|
121
|
-
self.request_time = attributes[:'
|
133
|
+
if attributes.key?(:'request_time')
|
134
|
+
self.request_time = attributes[:'request_time']
|
122
135
|
end
|
123
136
|
|
124
|
-
if attributes.
|
125
|
-
self.response_time = attributes[:'
|
137
|
+
if attributes.key?(:'response_time')
|
138
|
+
self.response_time = attributes[:'response_time']
|
126
139
|
end
|
127
140
|
end
|
128
141
|
|
@@ -193,19 +206,26 @@ module TalonOne
|
|
193
206
|
end
|
194
207
|
|
195
208
|
# Calculates hash code according to all attributes.
|
196
|
-
# @return [
|
209
|
+
# @return [Integer] Hash code
|
197
210
|
def hash
|
198
211
|
[id, integration_request_uuid, webhook_id, application_id, url, request, response, status, request_time, response_time].hash
|
199
212
|
end
|
200
213
|
|
214
|
+
# Builds the object from hash
|
215
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
216
|
+
# @return [Object] Returns the model itself
|
217
|
+
def self.build_from_hash(attributes)
|
218
|
+
new.build_from_hash(attributes)
|
219
|
+
end
|
220
|
+
|
201
221
|
# Builds the object from hash
|
202
222
|
# @param [Hash] attributes Model attributes in the form of hash
|
203
223
|
# @return [Object] Returns the model itself
|
204
224
|
def build_from_hash(attributes)
|
205
225
|
return nil unless attributes.is_a?(Hash)
|
206
|
-
self.class.
|
226
|
+
self.class.openapi_types.each_pair do |key, type|
|
207
227
|
if type =~ /\AArray<(.*)>/i
|
208
|
-
# check to ensure the input is an array given that the
|
228
|
+
# check to ensure the input is an array given that the attribute
|
209
229
|
# is documented as an array but the input is not
|
210
230
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
211
231
|
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
@@ -234,7 +254,7 @@ module TalonOne
|
|
234
254
|
value.to_i
|
235
255
|
when :Float
|
236
256
|
value.to_f
|
237
|
-
when :
|
257
|
+
when :Boolean
|
238
258
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
239
259
|
true
|
240
260
|
else
|
@@ -255,8 +275,7 @@ module TalonOne
|
|
255
275
|
end
|
256
276
|
end
|
257
277
|
else # model
|
258
|
-
|
259
|
-
temp_model.build_from_hash(value)
|
278
|
+
TalonOne.const_get(type).build_from_hash(value)
|
260
279
|
end
|
261
280
|
end
|
262
281
|
|
@@ -278,7 +297,11 @@ module TalonOne
|
|
278
297
|
hash = {}
|
279
298
|
self.class.attribute_map.each_pair do |attr, param|
|
280
299
|
value = self.send(attr)
|
281
|
-
|
300
|
+
if value.nil?
|
301
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
302
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
303
|
+
end
|
304
|
+
|
282
305
|
hash[param] = _to_hash(value)
|
283
306
|
end
|
284
307
|
hash
|
data/lib/talon_one/version.rb
CHANGED
@@ -3,13 +3,13 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? 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` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
module TalonOne
|
14
|
-
VERSION = '
|
14
|
+
VERSION = '2.1.0'
|
15
15
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? 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` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,12 +14,12 @@ require 'spec_helper'
|
|
14
14
|
require 'json'
|
15
15
|
|
16
16
|
# Unit tests for TalonOne::IntegrationApi
|
17
|
-
# Automatically generated by
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe 'IntegrationApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@
|
22
|
+
@api_instance = TalonOne::IntegrationApi.new
|
23
23
|
end
|
24
24
|
|
25
25
|
after do
|
@@ -28,7 +28,7 @@ describe 'IntegrationApi' do
|
|
28
28
|
|
29
29
|
describe 'test an instance of IntegrationApi' do
|
30
30
|
it 'should create an instance of IntegrationApi' do
|
31
|
-
expect(@
|
31
|
+
expect(@api_instance).to be_instance_of(TalonOne::IntegrationApi)
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
@@ -82,13 +82,16 @@ describe 'IntegrationApi' do
|
|
82
82
|
end
|
83
83
|
end
|
84
84
|
|
85
|
-
# unit tests for
|
86
|
-
# Get all
|
87
|
-
#
|
85
|
+
# unit tests for get_customer_inventory
|
86
|
+
# Get an inventory of all data associated with a specific customer profile.
|
87
|
+
# Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
|
88
88
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
|
-
# @
|
91
|
-
|
90
|
+
# @option opts [Boolean] :profile optional flag to decide if you would like customer profile information in the response
|
91
|
+
# @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
|
92
|
+
# @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
|
93
|
+
# @return [CustomerInventory]
|
94
|
+
describe 'get_customer_inventory test' do
|
92
95
|
it 'should work' do
|
93
96
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
94
97
|
end
|
@@ -111,6 +114,7 @@ describe 'IntegrationApi' do
|
|
111
114
|
# Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
|
112
115
|
# @param body
|
113
116
|
# @param [Hash] opts the optional parameters
|
117
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
114
118
|
# @return [IntegrationState]
|
115
119
|
describe 'track_event test' do
|
116
120
|
it 'should work' do
|
@@ -124,6 +128,7 @@ describe 'IntegrationApi' do
|
|
124
128
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
125
129
|
# @param body
|
126
130
|
# @param [Hash] opts the optional parameters
|
131
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
127
132
|
# @return [IntegrationState]
|
128
133
|
describe 'update_customer_profile test' do
|
129
134
|
it 'should work' do
|
@@ -131,12 +136,26 @@ describe 'IntegrationApi' do
|
|
131
136
|
end
|
132
137
|
end
|
133
138
|
|
139
|
+
# unit tests for update_customer_profile_v2
|
140
|
+
# Update a Customer Profile
|
141
|
+
# Update (or create) a [Customer Profile][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. [Customer Profile]: /Getting-Started/entities#customer-profile
|
142
|
+
# @param customer_profile_id The custom identifier for this profile, must be unique within the account.
|
143
|
+
# @param body
|
144
|
+
# @param [Hash] opts the optional parameters
|
145
|
+
# @return [CustomerProfileUpdate]
|
146
|
+
describe 'update_customer_profile_v2 test' do
|
147
|
+
it 'should work' do
|
148
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
134
152
|
# unit tests for update_customer_session
|
135
153
|
# Update a Customer Session
|
136
154
|
# Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
|
137
155
|
# @param customer_session_id The custom identifier for this session, must be unique within the account.
|
138
156
|
# @param body
|
139
157
|
# @param [Hash] opts the optional parameters
|
158
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
140
159
|
# @return [IntegrationState]
|
141
160
|
describe 'update_customer_session test' do
|
142
161
|
it 'should work' do
|
@@ -144,4 +163,18 @@ describe 'IntegrationApi' do
|
|
144
163
|
end
|
145
164
|
end
|
146
165
|
|
166
|
+
# unit tests for update_customer_session_v2
|
167
|
+
# Update a Customer Session
|
168
|
+
# Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. [Customer Session]: /Getting-Started/entities#customer-session
|
169
|
+
# @param customer_session_id The custom identifier for this session, must be unique within the account.
|
170
|
+
# @param body
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
173
|
+
# @return [IntegrationStateV2]
|
174
|
+
describe 'update_customer_session_v2 test' do
|
175
|
+
it 'should work' do
|
176
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
147
180
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? 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` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,12 +14,12 @@ require 'spec_helper'
|
|
14
14
|
require 'json'
|
15
15
|
|
16
16
|
# Unit tests for TalonOne::ManagementApi
|
17
|
-
# Automatically generated by
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe 'ManagementApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@
|
22
|
+
@api_instance = TalonOne::ManagementApi.new
|
23
23
|
end
|
24
24
|
|
25
25
|
after do
|
@@ -28,13 +28,12 @@ describe 'ManagementApi' do
|
|
28
28
|
|
29
29
|
describe 'test an instance of ManagementApi' do
|
30
30
|
it 'should create an instance of ManagementApi' do
|
31
|
-
expect(@
|
31
|
+
expect(@api_instance).to be_instance_of(TalonOne::ManagementApi)
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
35
|
# unit tests for add_loyalty_points
|
36
36
|
# Add points in a certain loyalty program for the specified customer
|
37
|
-
#
|
38
37
|
# @param program_id
|
39
38
|
# @param integration_id
|
40
39
|
# @param body
|
@@ -53,16 +52,39 @@ describe 'ManagementApi' do
|
|
53
52
|
# @param campaign_id
|
54
53
|
# @param body
|
55
54
|
# @param [Hash] opts the optional parameters
|
56
|
-
# @return [
|
55
|
+
# @return [InlineResponse2002]
|
57
56
|
describe 'copy_campaign_to_applications test' do
|
58
57
|
it 'should work' do
|
59
58
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
60
59
|
end
|
61
60
|
end
|
62
61
|
|
62
|
+
# unit tests for create_additional_cost
|
63
|
+
# Define a new additional cost
|
64
|
+
# Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
|
65
|
+
# @param body
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @return [AccountAdditionalCost]
|
68
|
+
describe 'create_additional_cost test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# unit tests for create_attribute
|
75
|
+
# Define a new custom attribute
|
76
|
+
# Defines a new _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating / updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
|
77
|
+
# @param body
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [Attribute]
|
80
|
+
describe 'create_attribute test' do
|
81
|
+
it 'should work' do
|
82
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
63
86
|
# unit tests for create_campaign
|
64
87
|
# Create a Campaign
|
65
|
-
#
|
66
88
|
# @param application_id
|
67
89
|
# @param body
|
68
90
|
# @param [Hash] opts the optional parameters
|
@@ -75,13 +97,13 @@ describe 'ManagementApi' do
|
|
75
97
|
|
76
98
|
# unit tests for create_coupons
|
77
99
|
# Create Coupons
|
78
|
-
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000
|
100
|
+
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
79
101
|
# @param application_id
|
80
102
|
# @param campaign_id
|
81
103
|
# @param body
|
82
104
|
# @param [Hash] opts the optional parameters
|
83
105
|
# @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
|
84
|
-
# @return [
|
106
|
+
# @return [InlineResponse2004]
|
85
107
|
describe 'create_coupons test' do
|
86
108
|
it 'should work' do
|
87
109
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -102,7 +124,6 @@ describe 'ManagementApi' do
|
|
102
124
|
|
103
125
|
# unit tests for create_ruleset
|
104
126
|
# Create a Ruleset
|
105
|
-
#
|
106
127
|
# @param application_id
|
107
128
|
# @param campaign_id
|
108
129
|
# @param body
|
@@ -116,7 +137,6 @@ describe 'ManagementApi' do
|
|
116
137
|
|
117
138
|
# unit tests for create_session
|
118
139
|
# Create a Session
|
119
|
-
#
|
120
140
|
# @param body
|
121
141
|
# @param [Hash] opts the optional parameters
|
122
142
|
# @return [Session]
|
@@ -128,7 +148,6 @@ describe 'ManagementApi' do
|
|
128
148
|
|
129
149
|
# unit tests for delete_campaign
|
130
150
|
# Delete a Campaign
|
131
|
-
#
|
132
151
|
# @param application_id
|
133
152
|
# @param campaign_id
|
134
153
|
# @param [Hash] opts the optional parameters
|
@@ -141,7 +160,6 @@ describe 'ManagementApi' do
|
|
141
160
|
|
142
161
|
# unit tests for delete_coupon
|
143
162
|
# Delete one Coupon
|
144
|
-
#
|
145
163
|
# @param application_id
|
146
164
|
# @param campaign_id
|
147
165
|
# @param coupon_id The ID of the coupon code to delete
|
@@ -155,7 +173,6 @@ describe 'ManagementApi' do
|
|
155
173
|
|
156
174
|
# unit tests for delete_coupons
|
157
175
|
# Delete Coupons
|
158
|
-
#
|
159
176
|
# @param application_id
|
160
177
|
# @param campaign_id
|
161
178
|
# @param [Hash] opts the optional parameters
|
@@ -171,7 +188,7 @@ describe 'ManagementApi' do
|
|
171
188
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
172
189
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
173
190
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
174
|
-
# @option opts [
|
191
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
175
192
|
# @return [nil]
|
176
193
|
describe 'delete_coupons test' do
|
177
194
|
it 'should work' do
|
@@ -181,7 +198,6 @@ describe 'ManagementApi' do
|
|
181
198
|
|
182
199
|
# unit tests for delete_referral
|
183
200
|
# Delete one Referral
|
184
|
-
#
|
185
201
|
# @param application_id
|
186
202
|
# @param campaign_id
|
187
203
|
# @param referral_id The ID of the referral code to delete
|
@@ -195,7 +211,6 @@ describe 'ManagementApi' do
|
|
195
211
|
|
196
212
|
# unit tests for delete_ruleset
|
197
213
|
# Delete a Ruleset
|
198
|
-
#
|
199
214
|
# @param application_id
|
200
215
|
# @param campaign_id
|
201
216
|
# @param ruleset_id
|
@@ -208,14 +223,13 @@ describe 'ManagementApi' do
|
|
208
223
|
end
|
209
224
|
|
210
225
|
# unit tests for get_access_logs
|
211
|
-
# Get access logs for application
|
212
|
-
#
|
226
|
+
# Get access logs for application (with total count)
|
213
227
|
# @param application_id
|
214
228
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
215
229
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
216
230
|
# @param [Hash] opts the optional parameters
|
217
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
218
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
231
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
232
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
219
233
|
# @option opts [String] :status Filter results by HTTP status codes.
|
220
234
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
221
235
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -229,13 +243,12 @@ describe 'ManagementApi' do
|
|
229
243
|
|
230
244
|
# unit tests for get_access_logs_without_total_count
|
231
245
|
# Get access logs for application
|
232
|
-
#
|
233
246
|
# @param application_id
|
234
247
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
235
248
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
236
249
|
# @param [Hash] opts the optional parameters
|
237
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
238
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
250
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
251
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
239
252
|
# @option opts [String] :status Filter results by HTTP status codes.
|
240
253
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
241
254
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -271,13 +284,27 @@ describe 'ManagementApi' do
|
|
271
284
|
end
|
272
285
|
end
|
273
286
|
|
274
|
-
# unit tests for
|
275
|
-
# Get
|
276
|
-
# Returns
|
277
|
-
# @param
|
287
|
+
# unit tests for get_additional_cost
|
288
|
+
# Get an additional cost
|
289
|
+
# Returns additional cost for the account by its id.
|
290
|
+
# @param additional_cost_id
|
278
291
|
# @param [Hash] opts the optional parameters
|
279
|
-
# @return [
|
280
|
-
describe '
|
292
|
+
# @return [AccountAdditionalCost]
|
293
|
+
describe 'get_additional_cost test' do
|
294
|
+
it 'should work' do
|
295
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
296
|
+
end
|
297
|
+
end
|
298
|
+
|
299
|
+
# unit tests for get_additional_costs
|
300
|
+
# List additional costs
|
301
|
+
# Returns all the defined additional costs for the account.
|
302
|
+
# @param [Hash] opts the optional parameters
|
303
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
304
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
305
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
306
|
+
# @return [InlineResponse20021]
|
307
|
+
describe 'get_additional_costs test' do
|
281
308
|
it 'should work' do
|
282
309
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
283
310
|
end
|
@@ -289,8 +316,8 @@ describe 'ManagementApi' do
|
|
289
316
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
290
317
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
291
318
|
# @param [Hash] opts the optional parameters
|
292
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
293
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
319
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
320
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
294
321
|
# @option opts [String] :status Filter results by HTTP status codes.
|
295
322
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
296
323
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -305,7 +332,7 @@ describe 'ManagementApi' do
|
|
305
332
|
# unit tests for get_all_roles
|
306
333
|
# Get all roles.
|
307
334
|
# @param [Hash] opts the optional parameters
|
308
|
-
# @return [
|
335
|
+
# @return [InlineResponse20030]
|
309
336
|
describe 'get_all_roles test' do
|
310
337
|
it 'should work' do
|
311
338
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -326,7 +353,6 @@ describe 'ManagementApi' do
|
|
326
353
|
|
327
354
|
# unit tests for get_application_api_health
|
328
355
|
# Get report of health of application API
|
329
|
-
#
|
330
356
|
# @param application_id
|
331
357
|
# @param [Hash] opts the optional parameters
|
332
358
|
# @return [ApplicationApiHealth]
|
@@ -338,7 +364,6 @@ describe 'ManagementApi' do
|
|
338
364
|
|
339
365
|
# unit tests for get_application_customer
|
340
366
|
# Get Application Customer
|
341
|
-
#
|
342
367
|
# @param application_id
|
343
368
|
# @param customer_id
|
344
369
|
# @param [Hash] opts the optional parameters
|
@@ -351,7 +376,6 @@ describe 'ManagementApi' do
|
|
351
376
|
|
352
377
|
# unit tests for get_application_customers
|
353
378
|
# List Application Customers
|
354
|
-
#
|
355
379
|
# @param application_id
|
356
380
|
# @param [Hash] opts the optional parameters
|
357
381
|
# @return [InlineResponse20012]
|
@@ -362,8 +386,8 @@ describe 'ManagementApi' do
|
|
362
386
|
end
|
363
387
|
|
364
388
|
# unit tests for get_application_customers_by_attributes
|
365
|
-
# Get a list of the customer profiles that match the given attributes
|
366
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
389
|
+
# Get a list of the customer profiles that match the given attributes (with total count)
|
390
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
367
391
|
# @param body
|
368
392
|
# @param [Hash] opts the optional parameters
|
369
393
|
# @return [InlineResponse20013]
|
@@ -389,7 +413,7 @@ describe 'ManagementApi' do
|
|
389
413
|
end
|
390
414
|
|
391
415
|
# unit tests for get_application_events
|
392
|
-
# List Applications Events
|
416
|
+
# List Applications Events (with total count)
|
393
417
|
# Lists all events recorded for an application.
|
394
418
|
# @param application_id
|
395
419
|
# @param [Hash] opts the optional parameters
|
@@ -403,8 +427,8 @@ describe 'ManagementApi' do
|
|
403
427
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
404
428
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
405
429
|
# @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
|
406
|
-
# @option opts [String] :
|
407
|
-
# @option opts [String] :
|
430
|
+
# @option opts [String] :coupon_code Coupon code
|
431
|
+
# @option opts [String] :referral_code Referral code
|
408
432
|
# @option opts [String] :rule_query Rule name filter for events
|
409
433
|
# @option opts [String] :campaign_query Campaign name filter for events
|
410
434
|
# @return [InlineResponse20017]
|
@@ -429,8 +453,8 @@ describe 'ManagementApi' do
|
|
429
453
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
430
454
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
431
455
|
# @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
|
432
|
-
# @option opts [String] :
|
433
|
-
# @option opts [String] :
|
456
|
+
# @option opts [String] :coupon_code Coupon code
|
457
|
+
# @option opts [String] :referral_code Referral code
|
434
458
|
# @option opts [String] :rule_query Rule name filter for events
|
435
459
|
# @option opts [String] :campaign_query Campaign name filter for events
|
436
460
|
# @return [InlineResponse20018]
|
@@ -442,7 +466,6 @@ describe 'ManagementApi' do
|
|
442
466
|
|
443
467
|
# unit tests for get_application_session
|
444
468
|
# Get Application Session
|
445
|
-
#
|
446
469
|
# @param application_id
|
447
470
|
# @param session_id
|
448
471
|
# @param [Hash] opts the optional parameters
|
@@ -455,7 +478,6 @@ describe 'ManagementApi' do
|
|
455
478
|
|
456
479
|
# unit tests for get_application_sessions
|
457
480
|
# List Application Sessions
|
458
|
-
#
|
459
481
|
# @param application_id
|
460
482
|
# @param [Hash] opts the optional parameters
|
461
483
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -464,6 +486,9 @@ describe 'ManagementApi' do
|
|
464
486
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
465
487
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
466
488
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
489
|
+
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
490
|
+
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
491
|
+
# @option opts [String] :customer_id Filter by integration ID of the customer for the session
|
467
492
|
# @return [InlineResponse20016]
|
468
493
|
describe 'get_application_sessions test' do
|
469
494
|
it 'should work' do
|
@@ -478,7 +503,7 @@ describe 'ManagementApi' do
|
|
478
503
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
479
504
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
480
505
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
481
|
-
# @return [
|
506
|
+
# @return [InlineResponse2001]
|
482
507
|
describe 'get_applications test' do
|
483
508
|
it 'should work' do
|
484
509
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -497,9 +522,22 @@ describe 'ManagementApi' do
|
|
497
522
|
end
|
498
523
|
end
|
499
524
|
|
525
|
+
# unit tests for get_attributes
|
526
|
+
# List custom attributes
|
527
|
+
# Returns all the defined custom attributes for the account.
|
528
|
+
# @param [Hash] opts the optional parameters
|
529
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
530
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
531
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
532
|
+
# @return [InlineResponse20020]
|
533
|
+
describe 'get_attributes test' do
|
534
|
+
it 'should work' do
|
535
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
536
|
+
end
|
537
|
+
end
|
538
|
+
|
500
539
|
# unit tests for get_campaign
|
501
540
|
# Get a Campaign
|
502
|
-
#
|
503
541
|
# @param application_id
|
504
542
|
# @param campaign_id
|
505
543
|
# @param [Hash] opts the optional parameters
|
@@ -512,7 +550,6 @@ describe 'ManagementApi' do
|
|
512
550
|
|
513
551
|
# unit tests for get_campaign_analytics
|
514
552
|
# Get analytics of campaigns
|
515
|
-
#
|
516
553
|
# @param application_id
|
517
554
|
# @param campaign_id
|
518
555
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
@@ -536,28 +573,15 @@ describe 'ManagementApi' do
|
|
536
573
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
537
574
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
538
575
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
539
|
-
# @return [
|
576
|
+
# @return [InlineResponse2002]
|
540
577
|
describe 'get_campaign_by_attributes test' do
|
541
578
|
it 'should work' do
|
542
579
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
543
580
|
end
|
544
581
|
end
|
545
582
|
|
546
|
-
# unit tests for get_campaign_set
|
547
|
-
# List CampaignSet
|
548
|
-
#
|
549
|
-
# @param application_id
|
550
|
-
# @param [Hash] opts the optional parameters
|
551
|
-
# @return [CampaignSet]
|
552
|
-
describe 'get_campaign_set test' do
|
553
|
-
it 'should work' do
|
554
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
555
|
-
end
|
556
|
-
end
|
557
|
-
|
558
583
|
# unit tests for get_campaigns
|
559
584
|
# List your Campaigns
|
560
|
-
#
|
561
585
|
# @param application_id
|
562
586
|
# @param [Hash] opts the optional parameters
|
563
587
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -568,7 +592,7 @@ describe 'ManagementApi' do
|
|
568
592
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
569
593
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
570
594
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
571
|
-
# @return [
|
595
|
+
# @return [InlineResponse2002]
|
572
596
|
describe 'get_campaigns test' do
|
573
597
|
it 'should work' do
|
574
598
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -582,7 +606,12 @@ describe 'ManagementApi' do
|
|
582
606
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
583
607
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
584
608
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
585
|
-
# @
|
609
|
+
# @option opts [Integer] :application_id
|
610
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
611
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
612
|
+
# @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
613
|
+
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
614
|
+
# @return [InlineResponse20027]
|
586
615
|
describe 'get_changes test' do
|
587
616
|
it 'should work' do
|
588
617
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -590,8 +619,7 @@ describe 'ManagementApi' do
|
|
590
619
|
end
|
591
620
|
|
592
621
|
# unit tests for get_coupons
|
593
|
-
# List Coupons
|
594
|
-
#
|
622
|
+
# List Coupons (with total count)
|
595
623
|
# @param application_id
|
596
624
|
# @param campaign_id
|
597
625
|
# @param [Hash] opts the optional parameters
|
@@ -610,8 +638,8 @@ describe 'ManagementApi' do
|
|
610
638
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
611
639
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
612
640
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
613
|
-
# @option opts [
|
614
|
-
# @return [
|
641
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
642
|
+
# @return [InlineResponse2004]
|
615
643
|
describe 'get_coupons test' do
|
616
644
|
it 'should work' do
|
617
645
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -635,9 +663,9 @@ describe 'ManagementApi' do
|
|
635
663
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
636
664
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
637
665
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
638
|
-
# @option opts [
|
666
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
639
667
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
640
|
-
# @return [
|
668
|
+
# @return [InlineResponse2004]
|
641
669
|
describe 'get_coupons_by_attributes test' do
|
642
670
|
it 'should work' do
|
643
671
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -645,7 +673,7 @@ describe 'ManagementApi' do
|
|
645
673
|
end
|
646
674
|
|
647
675
|
# unit tests for get_coupons_by_attributes_application_wide
|
648
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
676
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
649
677
|
# Gets a list of all the coupons with attributes matching the query criteria Application wide
|
650
678
|
# @param application_id
|
651
679
|
# @param body
|
@@ -661,9 +689,9 @@ describe 'ManagementApi' do
|
|
661
689
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
662
690
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
663
691
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
664
|
-
# @option opts [
|
692
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
665
693
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
666
|
-
# @return [
|
694
|
+
# @return [InlineResponse2004]
|
667
695
|
describe 'get_coupons_by_attributes_application_wide test' do
|
668
696
|
it 'should work' do
|
669
697
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -672,7 +700,6 @@ describe 'ManagementApi' do
|
|
672
700
|
|
673
701
|
# unit tests for get_coupons_without_total_count
|
674
702
|
# List Coupons
|
675
|
-
#
|
676
703
|
# @param application_id
|
677
704
|
# @param campaign_id
|
678
705
|
# @param [Hash] opts the optional parameters
|
@@ -687,7 +714,7 @@ describe 'ManagementApi' do
|
|
687
714
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
688
715
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
689
716
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
690
|
-
# @option opts [
|
717
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
691
718
|
# @return [InlineResponse2005]
|
692
719
|
describe 'get_coupons_without_total_count test' do
|
693
720
|
it 'should work' do
|
@@ -713,7 +740,7 @@ describe 'ManagementApi' do
|
|
713
740
|
end
|
714
741
|
|
715
742
|
# unit tests for get_customer_activity_reports
|
716
|
-
# Get Activity Reports for Application Customers
|
743
|
+
# Get Activity Reports for Application Customers (with total count)
|
717
744
|
# Fetch summary reports for all application customers based on a time range
|
718
745
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
719
746
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -772,7 +799,6 @@ describe 'ManagementApi' do
|
|
772
799
|
|
773
800
|
# unit tests for get_customer_profile
|
774
801
|
# Get Customer Profile
|
775
|
-
#
|
776
802
|
# @param application_id
|
777
803
|
# @param customer_id
|
778
804
|
# @param [Hash] opts the optional parameters
|
@@ -785,7 +811,6 @@ describe 'ManagementApi' do
|
|
785
811
|
|
786
812
|
# unit tests for get_customer_profiles
|
787
813
|
# List Customer Profiles
|
788
|
-
#
|
789
814
|
# @param [Hash] opts the optional parameters
|
790
815
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
791
816
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -798,7 +823,7 @@ describe 'ManagementApi' do
|
|
798
823
|
|
799
824
|
# unit tests for get_customers_by_attributes
|
800
825
|
# Get a list of the customer profiles that match the given attributes
|
801
|
-
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]:
|
826
|
+
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
802
827
|
# @param body
|
803
828
|
# @param [Hash] opts the optional parameters
|
804
829
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -816,11 +841,11 @@ describe 'ManagementApi' do
|
|
816
841
|
# @param [Hash] opts the optional parameters
|
817
842
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
818
843
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
819
|
-
# @option opts [
|
844
|
+
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
820
845
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
821
846
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
822
847
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
823
|
-
# @return [
|
848
|
+
# @return [InlineResponse20025]
|
824
849
|
describe 'get_event_types test' do
|
825
850
|
it 'should work' do
|
826
851
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -836,7 +861,7 @@ describe 'ManagementApi' do
|
|
836
861
|
# @option opts [Integer] :application_id
|
837
862
|
# @option opts [Integer] :campaign_id
|
838
863
|
# @option opts [String] :entity The name of the entity type that was exported.
|
839
|
-
# @return [
|
864
|
+
# @return [InlineResponse20028]
|
840
865
|
describe 'get_exports test' do
|
841
866
|
it 'should work' do
|
842
867
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -849,7 +874,7 @@ describe 'ManagementApi' do
|
|
849
874
|
# @param [Hash] opts the optional parameters
|
850
875
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
851
876
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
852
|
-
# @return [
|
877
|
+
# @return [InlineResponse20029]
|
853
878
|
describe 'get_imports test' do
|
854
879
|
it 'should work' do
|
855
880
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -871,7 +896,6 @@ describe 'ManagementApi' do
|
|
871
896
|
|
872
897
|
# unit tests for get_loyalty_program
|
873
898
|
# Get a loyalty program
|
874
|
-
#
|
875
899
|
# @param program_id
|
876
900
|
# @param [Hash] opts the optional parameters
|
877
901
|
# @return [LoyaltyProgram]
|
@@ -883,7 +907,6 @@ describe 'ManagementApi' do
|
|
883
907
|
|
884
908
|
# unit tests for get_loyalty_programs
|
885
909
|
# List all loyalty Programs
|
886
|
-
#
|
887
910
|
# @param [Hash] opts the optional parameters
|
888
911
|
# @return [InlineResponse2008]
|
889
912
|
describe 'get_loyalty_programs test' do
|
@@ -893,8 +916,7 @@ describe 'ManagementApi' do
|
|
893
916
|
end
|
894
917
|
|
895
918
|
# unit tests for get_referrals
|
896
|
-
# List Referrals
|
897
|
-
#
|
919
|
+
# List Referrals (with total count)
|
898
920
|
# @param application_id
|
899
921
|
# @param campaign_id
|
900
922
|
# @param [Hash] opts the optional parameters
|
@@ -916,7 +938,6 @@ describe 'ManagementApi' do
|
|
916
938
|
|
917
939
|
# unit tests for get_referrals_without_total_count
|
918
940
|
# List Referrals
|
919
|
-
#
|
920
941
|
# @param application_id
|
921
942
|
# @param campaign_id
|
922
943
|
# @param [Hash] opts the optional parameters
|
@@ -949,7 +970,6 @@ describe 'ManagementApi' do
|
|
949
970
|
|
950
971
|
# unit tests for get_ruleset
|
951
972
|
# Get a Ruleset
|
952
|
-
#
|
953
973
|
# @param application_id
|
954
974
|
# @param campaign_id
|
955
975
|
# @param ruleset_id
|
@@ -963,14 +983,13 @@ describe 'ManagementApi' do
|
|
963
983
|
|
964
984
|
# unit tests for get_rulesets
|
965
985
|
# List Campaign Rulesets
|
966
|
-
#
|
967
986
|
# @param application_id
|
968
987
|
# @param campaign_id
|
969
988
|
# @param [Hash] opts the optional parameters
|
970
989
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
971
990
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
972
991
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
973
|
-
# @return [
|
992
|
+
# @return [InlineResponse2003]
|
974
993
|
describe 'get_rulesets test' do
|
975
994
|
it 'should work' do
|
976
995
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -996,7 +1015,7 @@ describe 'ManagementApi' do
|
|
996
1015
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
997
1016
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
998
1017
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
999
|
-
# @return [
|
1018
|
+
# @return [InlineResponse20026]
|
1000
1019
|
describe 'get_users test' do
|
1001
1020
|
it 'should work' do
|
1002
1021
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1028,7 +1047,7 @@ describe 'ManagementApi' do
|
|
1028
1047
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1029
1048
|
# @option opts [DateTime] :created_before Only return events created before this date.
|
1030
1049
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
1031
|
-
# @return [
|
1050
|
+
# @return [InlineResponse20023]
|
1032
1051
|
describe 'get_webhook_activation_logs test' do
|
1033
1052
|
it 'should work' do
|
1034
1053
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1037,7 +1056,6 @@ describe 'ManagementApi' do
|
|
1037
1056
|
|
1038
1057
|
# unit tests for get_webhook_logs
|
1039
1058
|
# List Webhook Log Entries
|
1040
|
-
#
|
1041
1059
|
# @param [Hash] opts the optional parameters
|
1042
1060
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1043
1061
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1049,7 +1067,7 @@ describe 'ManagementApi' do
|
|
1049
1067
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1050
1068
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
|
1051
1069
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
1052
|
-
# @return [
|
1070
|
+
# @return [InlineResponse20024]
|
1053
1071
|
describe 'get_webhook_logs test' do
|
1054
1072
|
it 'should work' do
|
1055
1073
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1058,33 +1076,20 @@ describe 'ManagementApi' do
|
|
1058
1076
|
|
1059
1077
|
# unit tests for get_webhooks
|
1060
1078
|
# List Webhooks
|
1061
|
-
#
|
1062
1079
|
# @param [Hash] opts the optional parameters
|
1063
1080
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
1064
1081
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1065
1082
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1066
1083
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1067
|
-
# @return [
|
1084
|
+
# @return [InlineResponse20022]
|
1068
1085
|
describe 'get_webhooks test' do
|
1069
1086
|
it 'should work' do
|
1070
1087
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1071
1088
|
end
|
1072
1089
|
end
|
1073
1090
|
|
1074
|
-
# unit tests for refresh_analytics
|
1075
|
-
# Trigger refresh on stale analytics.
|
1076
|
-
# Should be used to trigger a manual refresh of analytics.
|
1077
|
-
# @param [Hash] opts the optional parameters
|
1078
|
-
# @return [nil]
|
1079
|
-
describe 'refresh_analytics test' do
|
1080
|
-
it 'should work' do
|
1081
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1082
|
-
end
|
1083
|
-
end
|
1084
|
-
|
1085
1091
|
# unit tests for remove_loyalty_points
|
1086
1092
|
# Deduct points in a certain loyalty program for the specified customer
|
1087
|
-
#
|
1088
1093
|
# @param program_id
|
1089
1094
|
# @param integration_id
|
1090
1095
|
# @param body
|
@@ -1109,7 +1114,7 @@ describe 'ManagementApi' do
|
|
1109
1114
|
end
|
1110
1115
|
|
1111
1116
|
# unit tests for search_coupons_advanced
|
1112
|
-
# Get a list of the coupons that match the given attributes
|
1117
|
+
# Get a list of the coupons that match the given attributes (with total count)
|
1113
1118
|
# Gets a list of all the coupons with attributes matching the query criteria
|
1114
1119
|
# @param application_id
|
1115
1120
|
# @param campaign_id
|
@@ -1125,9 +1130,9 @@ describe 'ManagementApi' do
|
|
1125
1130
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
1126
1131
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
1127
1132
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1128
|
-
# @option opts [
|
1133
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1129
1134
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1130
|
-
# @return [
|
1135
|
+
# @return [InlineResponse2004]
|
1131
1136
|
describe 'search_coupons_advanced test' do
|
1132
1137
|
it 'should work' do
|
1133
1138
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1135,7 +1140,7 @@ describe 'ManagementApi' do
|
|
1135
1140
|
end
|
1136
1141
|
|
1137
1142
|
# unit tests for search_coupons_advanced_application_wide
|
1138
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
1143
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
1139
1144
|
# Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
1140
1145
|
# @param application_id
|
1141
1146
|
# @param body
|
@@ -1151,9 +1156,9 @@ describe 'ManagementApi' do
|
|
1151
1156
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
1152
1157
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1153
1158
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1154
|
-
# @option opts [
|
1159
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1155
1160
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1156
|
-
# @return [
|
1161
|
+
# @return [InlineResponse2004]
|
1157
1162
|
describe 'search_coupons_advanced_application_wide test' do
|
1158
1163
|
it 'should work' do
|
1159
1164
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1177,7 +1182,7 @@ describe 'ManagementApi' do
|
|
1177
1182
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
1178
1183
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1179
1184
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1180
|
-
# @option opts [
|
1185
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1181
1186
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1182
1187
|
# @return [InlineResponse2005]
|
1183
1188
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
@@ -1203,7 +1208,7 @@ describe 'ManagementApi' do
|
|
1203
1208
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
1204
1209
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
1205
1210
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1206
|
-
# @option opts [
|
1211
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1207
1212
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1208
1213
|
# @return [InlineResponse2005]
|
1209
1214
|
describe 'search_coupons_advanced_without_total_count test' do
|
@@ -1212,41 +1217,40 @@ describe 'ManagementApi' do
|
|
1212
1217
|
end
|
1213
1218
|
end
|
1214
1219
|
|
1215
|
-
# unit tests for
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
# @param
|
1220
|
+
# unit tests for update_additional_cost
|
1221
|
+
# Update an additional cost
|
1222
|
+
# Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
|
1223
|
+
# @param additional_cost_id
|
1219
1224
|
# @param body
|
1220
1225
|
# @param [Hash] opts the optional parameters
|
1221
|
-
# @return [
|
1222
|
-
describe '
|
1226
|
+
# @return [AccountAdditionalCost]
|
1227
|
+
describe 'update_additional_cost test' do
|
1223
1228
|
it 'should work' do
|
1224
1229
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1225
1230
|
end
|
1226
1231
|
end
|
1227
1232
|
|
1228
|
-
# unit tests for
|
1229
|
-
# Update a
|
1230
|
-
#
|
1231
|
-
# @param
|
1232
|
-
# @param campaign_id
|
1233
|
+
# unit tests for update_attribute
|
1234
|
+
# Update a custom attribute
|
1235
|
+
# Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
|
1236
|
+
# @param attribute_id
|
1233
1237
|
# @param body
|
1234
1238
|
# @param [Hash] opts the optional parameters
|
1235
|
-
# @return [
|
1236
|
-
describe '
|
1239
|
+
# @return [Attribute]
|
1240
|
+
describe 'update_attribute test' do
|
1237
1241
|
it 'should work' do
|
1238
1242
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1239
1243
|
end
|
1240
1244
|
end
|
1241
1245
|
|
1242
|
-
# unit tests for
|
1243
|
-
# Update a Campaign
|
1244
|
-
#
|
1246
|
+
# unit tests for update_campaign
|
1247
|
+
# Update a Campaign
|
1245
1248
|
# @param application_id
|
1249
|
+
# @param campaign_id
|
1246
1250
|
# @param body
|
1247
1251
|
# @param [Hash] opts the optional parameters
|
1248
|
-
# @return [
|
1249
|
-
describe '
|
1252
|
+
# @return [Campaign]
|
1253
|
+
describe 'update_campaign test' do
|
1250
1254
|
it 'should work' do
|
1251
1255
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1252
1256
|
end
|
@@ -1254,7 +1258,6 @@ describe 'ManagementApi' do
|
|
1254
1258
|
|
1255
1259
|
# unit tests for update_coupon
|
1256
1260
|
# Update a Coupon
|
1257
|
-
#
|
1258
1261
|
# @param application_id
|
1259
1262
|
# @param campaign_id
|
1260
1263
|
# @param coupon_id The ID of the coupon code to update
|
@@ -1269,7 +1272,6 @@ describe 'ManagementApi' do
|
|
1269
1272
|
|
1270
1273
|
# unit tests for update_coupon_batch
|
1271
1274
|
# Update a Batch of Coupons
|
1272
|
-
#
|
1273
1275
|
# @param application_id
|
1274
1276
|
# @param campaign_id
|
1275
1277
|
# @param body
|
@@ -1283,7 +1285,6 @@ describe 'ManagementApi' do
|
|
1283
1285
|
|
1284
1286
|
# unit tests for update_ruleset
|
1285
1287
|
# Update a Ruleset
|
1286
|
-
#
|
1287
1288
|
# @param application_id
|
1288
1289
|
# @param campaign_id
|
1289
1290
|
# @param ruleset_id
|