talon_one 5.0.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/.example/.bundle/config +2 -0
- data/.github/.example/Gemfile +6 -0
- data/.github/.example/Gemfile.lock +47 -0
- data/.github/.example/example.rb +85 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/gem.build_complete +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/gem_make.out +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/json/ext/generator.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/json/ext/parser.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/mkmf.log +177 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.github/workflows/ruby.yml +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.gitignore +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.rspec +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/CHANGELOG.md +375 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Gemfile +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Guardfile +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/LICENSE +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/README.md +118 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Rakefile +40 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/ethon.gemspec +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curl.rb +90 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/classes.rb +65 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/codes.rb +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/constants.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/form_options.rb +37 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/functions.rb +58 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/infos.rb +151 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/messages.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/options.rb +503 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/settings.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/callbacks.rb +149 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/debug_info.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/features.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/form.rb +107 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/header.rb +61 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/actionable.rb +157 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/custom.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/delete.rb +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/get.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/head.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/options.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/patch.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/post.rb +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/postable.rb +32 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/put.rb +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/putable.rb +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http.rb +68 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/informations.rb +116 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/mirror.rb +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/operations.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/options.rb +50 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/params.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/queryable.rb +154 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/response_callbacks.rb +136 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/util.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy.rb +315 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/ethon_error.rb +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/global_init.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/invalid_option.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/invalid_value.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_add.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_fdset.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_remove.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_timeout.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/select.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors.rb +17 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/libc.rb +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/loggable.rb +59 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/operations.rb +228 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/options.rb +117 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/stack.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/version.rb +6 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon.rb +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/benchmarks.rb +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/memory_leaks.rb +114 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/perf_spec_helper.rb +37 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/memory_test_helpers.rb +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/os_memory_leak_tracker.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/ruby_object_leak_tracker.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/curl_spec.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/callbacks_spec.rb +81 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/debug_info_spec.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/features_spec.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/form_spec.rb +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/header_spec.rb +79 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/custom_spec.rb +177 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/delete_spec.rb +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/get_spec.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/head_spec.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/options_spec.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/patch_spec.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/post_spec.rb +317 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/put_spec.rb +168 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http_spec.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/informations_spec.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/mirror_spec.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/operations_spec.rb +271 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/options_spec.rb +193 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/queryable_spec.rb +235 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/response_callbacks_spec.rb +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/util_spec.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy_spec.rb +203 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/libc_spec.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/loggable_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/operations_spec.rb +298 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/options_spec.rb +182 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/stack_spec.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi_spec.rb +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/spec_helper.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/support/localhost_server.rb +95 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/support/server.rb +115 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/CHANGELOG.md +456 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/COPYING +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/Gemfile +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/LICENSE +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/LICENSE.SPECS +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/README.md +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/Rakefile +206 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/ffi.gemspec +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.5/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.6/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.7/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.0/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.1/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.2/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.3/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/abstract_memory.rb +44 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/autopointer.rb +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/buffer.rb +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/callback.rb +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/compat.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/data_converter.rb +67 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/dynamic_library.rb +118 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/enum.rb +302 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/errno.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/ffi.rb +50 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/function.rb +71 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/io.rb +62 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/library.rb +576 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/library_path.rb +109 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/managedstruct.rb +84 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/memorypointer.rb +1 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-darwin/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-freebsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-freebsd12/types.conf +181 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-linux/types.conf +175 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-openbsd/types.conf +134 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-freebsd/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-freebsd12/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-linux/types.conf +132 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/hppa1.1-linux/types.conf +178 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/hppa2.0-linux/types.conf +178 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-cygwin/types.conf +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-darwin/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-freebsd/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-freebsd12/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-gnu/types.conf +107 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-linux/types.conf +103 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-netbsd/types.conf +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-openbsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-solaris/types.conf +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/ia64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/loongarch64-linux/types.conf +141 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips64el-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsel-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa32r6-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa32r6el-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa64r6-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa64r6el-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-aix/types.conf +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-darwin/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-linux/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-openbsd/types.conf +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc64le-linux/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/riscv64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/s390-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/s390x-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparc-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparc-solaris/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-openbsd/types.conf +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-solaris/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sw_64-linux/types.conf +141 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-cygwin/types.conf +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-darwin/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-dragonflybsd/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-freebsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-freebsd12/types.conf +158 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-haiku/types.conf +117 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-linux/types.conf +132 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-msys/types.conf +119 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-netbsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-openbsd/types.conf +134 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-solaris/types.conf +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform.rb +187 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/pointer.rb +167 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct.rb +317 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_by_reference.rb +72 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_layout.rb +96 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_layout_builder.rb +227 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/const_generator.rb +232 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/generator.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/generator_task.rb +32 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/struct_generator.rb +195 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/types_generator.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/types.rb +222 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/union.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/variadic.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/version.rb +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi.rb +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/rakelib/ffi_gem_helper.rb +65 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/getlogin.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/getpid.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/gettimeofday.rb +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/hello.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/hello_ractor.rb +11 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/inotify.rb +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/pty.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/qsort.rb +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/qsort_ractor.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/abstract_memory.rbs +165 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/auto_pointer.rbs +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/buffer.rbs +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/data_converter.rbs +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/dynamic_library.rbs +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/enum.rbs +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/function.rbs +39 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/library.rbs +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/native_type.rbs +86 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/pointer.rbs +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct.rbs +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_by_reference.rbs +11 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_by_value.rbs +7 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_layout.rbs +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_layout_builder.rbs +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/type.rbs +39 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi.rbs +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/BSDL +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/CHANGES.md +559 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/COPYING +56 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/LEGAL +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/README.md +195 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/fbuffer/fbuffer.h +184 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/Makefile +270 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/extconf.rb +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/generator.c +1663 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/Makefile +270 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/extconf.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/parser.c +3238 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/parser.rl +1465 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/json.gemspec +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/bigdecimal.rb +58 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/complex.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/core.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/date.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/date_time.rb +67 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/exception.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/ostruct.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/range.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/rational.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/regexp.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/set.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/struct.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/symbol.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/time.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/common.rb +876 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/generator/state.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/generator.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/parser.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext.rb +23 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/generic_object.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/truffle_ruby/generator.rb +621 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/version.rb +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json.rb +587 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.github/workflows/ci.yml +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.github/workflows/experimental.yml +33 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.gitignore +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.rspec +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/CHANGELOG.md +410 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/CONTRIBUTING.md +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Gemfile +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Guardfile +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/LICENSE +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/README.md +588 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Rakefile +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/UPGRADE.md +55 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus/middleware/params_decoder/helper.rb +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus/middleware/params_decoder.rb +57 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus.rb +1 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/adapters/faraday.rb +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/dalli.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/rails.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/redis.rb +35 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/config.rb +85 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/easy_factory.rb +206 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors/no_stub.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors/typhoeus_error.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors.rb +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/expectation.rb +217 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/addable.rb +23 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/before.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/block_connection.rb +35 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/cacheable.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/memoizable.rb +56 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/queueable.rb +83 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/runnable.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/stubbable.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra.rb +95 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/pool.rb +70 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/railtie.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/actions.rb +125 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/before.rb +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/block_connection.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/cacheable.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/callbacks.rb +151 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/marshal.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/memoizable.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/operations.rb +40 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/responseable.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/streamable.rb +34 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/stubbable.rb +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request.rb +223 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/cacheable.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/header.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/informations.rb +305 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/status.rb +106 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response.rb +68 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/version.rb +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus.rb +143 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/perf/profile.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/perf/vs_nethttp.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/rack/typhoeus/middleware/params_decoder/helper_spec.rb +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/rack/typhoeus/middleware/params_decoder_spec.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/spec_helper.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/localhost_server.rb +94 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/memory_cache.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/server.rb +116 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/adapters/faraday_spec.rb +339 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/cache/dalli_spec.rb +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/cache/redis_spec.rb +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/config_spec.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/easy_factory_spec.rb +143 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/errors/no_stub_spec.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/expectation_spec.rb +280 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/addable_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/before_spec.rb +98 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/block_connection_spec.rb +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/cacheable_spec.rb +88 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/memoizable_spec.rb +53 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/queueable_spec.rb +98 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/runnable_spec.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/stubbable_spec.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/pool_spec.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/actions_spec.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/before_spec.rb +93 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/block_connection_spec.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/cacheable_spec.rb +94 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/callbacks_spec.rb +91 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/marshal_spec.rb +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/memoizable_spec.rb +34 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/operations_spec.rb +101 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/responseable_spec.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/stubbable_spec.rb +45 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request_spec.rb +256 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/header_spec.rb +147 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/informations_spec.rb +323 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/status_spec.rb +256 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response_spec.rb +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus_spec.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/typhoeus.gemspec +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/ethon-0.16.0.gemspec +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/ffi-1.17.0-arm64-darwin.gemspec +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/json-2.8.2.gemspec +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/typhoeus-1.4.1.gemspec +24 -0
- data/.github/dependabot.yml +10 -0
- data/.github/workflows/test.yml +75 -0
- data/README.md +565 -521
- data/docker-compose.yml +47 -0
- data/docs/AccountAnalytics.md +1 -1
- data/docs/Achievement.md +8 -0
- data/docs/AchievementProgress.md +2 -0
- data/docs/AdditionalCampaignProperties.md +4 -2
- data/docs/AnalyticsDataPoint.md +19 -0
- data/docs/AnalyticsDataPointWithTrend.md +19 -0
- data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
- data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
- data/docs/AnalyticsProduct.md +23 -0
- data/docs/AnalyticsProductSKU.md +21 -0
- data/docs/Application.md +4 -0
- data/docs/ApplicationAnalyticsDataPoint.md +6 -6
- data/docs/ApplicationCIF.md +33 -0
- data/docs/ApplicationCIFExpression.md +27 -0
- data/docs/ApplicationCampaignAnalytics.md +13 -19
- data/docs/ApplicationCampaignStats.md +3 -3
- data/docs/ApplicationCustomer.md +8 -8
- data/docs/ApplicationSession.md +2 -2
- data/docs/AsyncCouponDeletionJobResponse.md +17 -0
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseLoyaltyProgram.md +10 -4
- data/docs/BaseNotification.md +1 -1
- data/docs/BaseNotificationEntity.md +1 -1
- data/docs/BulkOperationOnCampaigns.md +3 -1
- data/docs/Campaign.md +18 -2
- data/docs/CampaignCollectionEditedNotification.md +21 -0
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignStateChangedNotification.md +2 -2
- data/docs/CampaignStoreBudget.md +25 -0
- data/docs/CampaignTemplate.md +3 -1
- data/docs/CampaignTemplateCouponReservationSettings.md +19 -0
- data/docs/CampaignVersions.md +29 -0
- data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/CartItem.md +1 -1
- data/docs/Change.md +1 -1
- data/docs/CodeGeneratorSettings.md +1 -1
- data/docs/Coupon.md +1 -1
- data/docs/CouponConstraints.md +1 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionFilters.md +43 -0
- data/docs/CouponDeletionJob.md +39 -0
- data/docs/CreateAchievement.md +9 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileAudienceRequestItem.md +1 -1
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +10 -8
- data/docs/Effect.md +8 -0
- data/docs/EffectEntity.md +9 -1
- data/docs/Environment.md +3 -1
- data/docs/Event.md +1 -1
- data/docs/FeatureFlag.md +1 -1
- data/docs/GenerateCampaignDescription.md +19 -0
- data/docs/GenerateCampaignTags.md +17 -0
- data/docs/GenerateItemFilterDescription.md +17 -0
- data/docs/GenerateLoyaltyCard.md +21 -0
- data/docs/GenerateRuleTitle.md +19 -0
- data/docs/GenerateRuleTitleRule.md +19 -0
- data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +4 -2
- data/docs/InlineResponse20022.md +3 -3
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -3
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +5 -3
- data/docs/InlineResponse20030.md +1 -3
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +3 -1
- data/docs/InlineResponse20033.md +3 -5
- data/docs/InlineResponse20034.md +5 -3
- data/docs/InlineResponse20035.md +3 -5
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +4 -2
- data/docs/InlineResponse20042.md +2 -4
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +5 -3
- data/docs/InlineResponse20045.md +1 -3
- data/docs/InlineResponse20046.md +3 -3
- data/docs/IntegrationApi.md +73 -12
- data/docs/IntegrationCoupon.md +1 -1
- data/docs/IntegrationCustomerSessionResponse.md +1 -1
- data/docs/InventoryCoupon.md +1 -1
- data/docs/InventoryReferral.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/ListCampaignStoreBudgets.md +23 -0
- data/docs/ListCampaignStoreBudgetsStore.md +21 -0
- data/docs/LoyaltyBalanceWithTier.md +31 -0
- data/docs/LoyaltyBalancesWithTiers.md +19 -0
- data/docs/LoyaltyCard.md +10 -2
- data/docs/LoyaltyCardBatch.md +23 -0
- data/docs/LoyaltyCardBatchResponse.md +19 -0
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +19 -9
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramEntity.md +5 -1
- data/docs/LoyaltyTier.md +6 -2
- data/docs/ManagementApi.md +1159 -258
- data/docs/MessageLogEntry.md +10 -2
- data/docs/MessageLogResponse.md +3 -3
- data/docs/NewAppWideCouponDeletionJob.md +19 -0
- data/docs/NewApplication.md +3 -1
- data/docs/NewApplicationCIF.md +27 -0
- data/docs/NewApplicationCIFExpression.md +21 -0
- data/docs/NewBaseNotification.md +1 -1
- data/docs/NewCampaignStoreBudget.md +21 -0
- data/docs/NewCampaignStoreBudgetStoreLimit.md +19 -0
- data/docs/NewCampaignTemplate.md +2 -0
- data/docs/NewCouponCreationJob.md +1 -1
- data/docs/NewCouponDeletionJob.md +17 -0
- data/docs/NewCoupons.md +1 -1
- data/docs/NewCouponsForMultipleRecipients.md +1 -1
- data/docs/NewCustomerSessionV2.md +4 -4
- data/docs/NewLoyaltyProgram.md +10 -4
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewOutgoingIntegrationWebhook.md +2 -0
- data/docs/NewPicklist.md +1 -1
- data/docs/NewReferral.md +1 -1
- data/docs/NewReferralsForMultipleAdvocates.md +1 -1
- data/docs/NewRevisionVersion.md +37 -0
- data/docs/NewWebhook.md +3 -1
- data/docs/OktaEvent.md +19 -0
- data/docs/OktaEventPayload.md +17 -0
- data/docs/OktaEventPayloadData.md +17 -0
- data/docs/OktaEventTarget.md +21 -0
- data/docs/Picklist.md +1 -1
- data/docs/Product.md +1 -1
- data/docs/ProductSearchMatch.md +21 -0
- data/docs/ProductSkuUnitAnalytics.md +23 -0
- data/docs/ProductUnitAnalytics.md +25 -0
- data/docs/ProjectedTier.md +21 -0
- data/docs/Referral.md +1 -1
- data/docs/ReferralConstraints.md +1 -1
- data/docs/RejectCouponEffectProps.md +3 -1
- data/docs/RejectReferralEffectProps.md +3 -1
- data/docs/Revision.md +35 -0
- data/docs/RevisionActivation.md +17 -0
- data/docs/RevisionVersion.md +53 -0
- data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
- data/docs/RuleFailureReason.md +5 -1
- data/docs/SSOConfig.md +3 -1
- data/docs/ScimBaseUser.md +23 -0
- data/docs/ScimBaseUserName.md +17 -0
- data/docs/ScimNewUser.md +23 -0
- data/docs/ScimPatchOperation.md +21 -0
- data/docs/ScimPatchRequest.md +19 -0
- data/docs/ScimResource.md +21 -0
- data/docs/ScimResourceTypesListResponse.md +17 -0
- data/docs/ScimSchemaResource.md +23 -0
- data/docs/ScimSchemasListResponse.md +21 -0
- data/docs/ScimServiceProviderConfigResponse.md +29 -0
- data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
- data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
- data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
- data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
- data/docs/ScimServiceProviderConfigResponseSort.md +17 -0
- data/docs/ScimUser.md +25 -0
- data/docs/ScimUsersListResponse.md +21 -0
- data/docs/Store.md +2 -2
- data/docs/StrikethroughDebugResponse.md +19 -0
- data/docs/SummaryCampaignStoreBudget.md +21 -0
- data/docs/TemplateArgDef.md +2 -0
- data/docs/Tier.md +3 -1
- data/docs/TransferLoyaltyCard.md +3 -1
- data/docs/UpdateAchievement.md +9 -1
- data/docs/UpdateApplication.md +5 -1
- data/docs/UpdateApplicationCIF.md +23 -0
- data/docs/UpdateCampaign.md +1 -1
- data/docs/UpdateCampaignTemplate.md +2 -0
- data/docs/UpdateCoupon.md +1 -1
- data/docs/UpdateCouponBatch.md +1 -1
- data/docs/UpdateLoyaltyCard.md +4 -2
- data/docs/UpdateLoyaltyProgram.md +10 -4
- data/docs/UpdateLoyaltyProgramTier.md +21 -0
- data/docs/UpdatePicklist.md +1 -1
- data/docs/UpdateReferral.md +1 -1
- data/docs/UpdateReferralBatch.md +1 -1
- data/docs/User.md +4 -2
- data/docs/ValueMap.md +23 -0
- data/docs/Webhook.md +3 -1
- data/docs/WebhookLogEntry.md +1 -1
- data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
- data/lib/talon_one/api/integration_api.rb +94 -18
- data/lib/talon_one/api/management_api.rb +1347 -387
- data/lib/talon_one/models/account.rb +0 -1
- data/lib/talon_one/models/account_additional_cost.rb +0 -1
- data/lib/talon_one/models/achievement.rb +87 -2
- data/lib/talon_one/models/achievement_progress.rb +16 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +22 -7
- data/lib/talon_one/models/analytics_data_point.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
- data/lib/talon_one/models/analytics_product.rb +252 -0
- data/lib/talon_one/models/analytics_product_sku.rb +242 -0
- data/lib/talon_one/models/application.rb +21 -2
- data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
- data/lib/talon_one/models/application_api_key.rb +0 -1
- data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
- data/lib/talon_one/models/application_campaign_stats.rb +16 -16
- data/lib/talon_one/models/application_cif.rb +307 -0
- data/lib/talon_one/models/application_cif_expression.rb +274 -0
- data/lib/talon_one/models/application_customer.rb +4 -5
- data/lib/talon_one/models/application_event.rb +0 -1
- data/lib/talon_one/models/application_referee.rb +0 -1
- data/lib/talon_one/models/application_session.rb +1 -2
- data/lib/talon_one/models/async_coupon_deletion_job_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +2 -3
- data/lib/talon_one/models/audience.rb +0 -1
- data/lib/talon_one/models/audience_customer.rb +1 -2
- data/lib/talon_one/models/base_loyalty_program.rb +62 -21
- data/lib/talon_one/models/base_notification.rb +3 -3
- data/lib/talon_one/models/base_notification_entity.rb +1 -0
- data/lib/talon_one/models/base_notification_webhook.rb +0 -1
- data/lib/talon_one/models/bulk_operation_on_campaigns.rb +16 -6
- data/lib/talon_one/models/campaign.rb +106 -8
- data/lib/talon_one/models/campaign_analytics.rb +0 -1
- data/lib/talon_one/models/campaign_collection.rb +0 -1
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +0 -1
- data/lib/talon_one/models/campaign_evaluation_group.rb +0 -1
- data/lib/talon_one/models/campaign_group.rb +0 -1
- data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
- data/lib/talon_one/models/campaign_set.rb +0 -1
- data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
- data/lib/talon_one/models/campaign_store_budget.rb +274 -0
- data/lib/talon_one/models/campaign_template.rb +10 -2
- data/lib/talon_one/models/campaign_template_coupon_reservation_settings.rb +243 -0
- data/lib/talon_one/models/campaign_versions.rb +303 -0
- data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +11 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +11 -0
- data/lib/talon_one/models/cart_item.rb +1 -1
- data/lib/talon_one/models/catalog.rb +0 -1
- data/lib/talon_one/models/catalog_item.rb +0 -1
- data/lib/talon_one/models/change.rb +0 -1
- data/lib/talon_one/models/code_generator_settings.rb +12 -1
- data/lib/talon_one/models/collection.rb +0 -1
- data/lib/talon_one/models/collection_item.rb +0 -1
- data/lib/talon_one/models/collection_without_payload.rb +0 -1
- data/lib/talon_one/models/coupon.rb +1 -2
- data/lib/talon_one/models/coupon_constraints.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +1 -2
- data/lib/talon_one/models/coupon_deletion_filters.rb +373 -0
- data/lib/talon_one/models/coupon_deletion_job.rb +369 -0
- data/lib/talon_one/models/create_achievement.rb +90 -4
- data/lib/talon_one/models/custom_effect.rb +0 -1
- data/lib/talon_one/models/customer_profile.rb +1 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +1 -1
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +1 -1
- data/lib/talon_one/models/customer_session.rb +0 -1
- data/lib/talon_one/models/customer_session_v2.rb +20 -10
- data/lib/talon_one/models/deactivate_user_request.rb +0 -1
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/effect.rb +42 -2
- data/lib/talon_one/models/effect_entity.rb +44 -4
- data/lib/talon_one/models/environment.rb +16 -5
- data/lib/talon_one/models/event.rb +0 -6
- data/lib/talon_one/models/event_type.rb +0 -1
- data/lib/talon_one/models/event_v2.rb +0 -1
- data/lib/talon_one/models/export.rb +0 -1
- data/lib/talon_one/models/features_feed.rb +0 -1
- data/lib/talon_one/models/generate_campaign_description.rb +227 -0
- data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
- data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
- data/lib/talon_one/models/generate_loyalty_card.rb +292 -0
- data/lib/talon_one/models/generate_rule_title.rb +226 -0
- data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
- data/lib/talon_one/models/giveaway.rb +0 -1
- data/lib/talon_one/models/import.rb +0 -1
- data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +1 -1
- data/lib/talon_one/models/inline_response20021.rb +11 -7
- data/lib/talon_one/models/inline_response20022.rb +10 -10
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +6 -10
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -6
- data/lib/talon_one/models/inline_response20027.rb +6 -1
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +11 -7
- data/lib/talon_one/models/inline_response20030.rb +2 -11
- data/lib/talon_one/models/inline_response20031.rb +1 -1
- data/lib/talon_one/models/inline_response20032.rb +11 -2
- data/lib/talon_one/models/inline_response20033.rb +7 -11
- data/lib/talon_one/models/inline_response20034.rb +11 -7
- data/lib/talon_one/models/inline_response20035.rb +7 -11
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +1 -1
- data/lib/talon_one/models/inline_response20038.rb +1 -1
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +11 -7
- data/lib/talon_one/models/inline_response20042.rb +7 -11
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +11 -7
- data/lib/talon_one/models/inline_response20045.rb +2 -11
- data/lib/talon_one/models/inline_response20046.rb +6 -1
- data/lib/talon_one/models/integration_coupon.rb +1 -2
- data/lib/talon_one/models/integration_customer_session_response.rb +1 -0
- data/lib/talon_one/models/integration_event.rb +0 -1
- data/lib/talon_one/models/integration_event_v2_request.rb +0 -1
- data/lib/talon_one/models/inventory_coupon.rb +1 -2
- data/lib/talon_one/models/inventory_referral.rb +1 -2
- data/lib/talon_one/models/item_attribute.rb +0 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +3 -3
- data/lib/talon_one/models/library_attribute.rb +0 -1
- data/lib/talon_one/models/limit_counter.rb +0 -1
- data/lib/talon_one/models/list_campaign_store_budgets.rb +248 -0
- data/lib/talon_one/models/list_campaign_store_budgets_store.rb +239 -0
- data/lib/talon_one/models/login_params.rb +0 -1
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
- data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +78 -6
- data/lib/talon_one/models/loyalty_card_balances.rb +1 -1
- data/lib/talon_one/models/loyalty_card_batch.rb +312 -0
- data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
- data/lib/talon_one/models/loyalty_program.rb +90 -27
- data/lib/talon_one/models/loyalty_program_balance.rb +2 -2
- data/lib/talon_one/models/loyalty_program_entity.rb +24 -4
- data/lib/talon_one/models/loyalty_program_transaction.rb +11 -0
- data/lib/talon_one/models/loyalty_tier.rb +24 -4
- data/lib/talon_one/models/management_key.rb +0 -1
- data/lib/talon_one/models/message_log_entry.rb +67 -7
- data/lib/talon_one/models/message_log_response.rb +3 -22
- data/lib/talon_one/models/model_return.rb +0 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +0 -1
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +0 -1
- data/lib/talon_one/models/new_additional_cost.rb +0 -1
- data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
- data/lib/talon_one/models/new_application.rb +14 -4
- data/lib/talon_one/models/new_application_api_key.rb +0 -1
- data/lib/talon_one/models/new_application_cif.rb +262 -0
- data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
- data/lib/talon_one/models/new_attribute.rb +2 -3
- data/lib/talon_one/models/new_audience.rb +0 -1
- data/lib/talon_one/models/new_base_notification.rb +1 -1
- data/lib/talon_one/models/new_campaign.rb +0 -1
- data/lib/talon_one/models/new_campaign_collection.rb +0 -1
- data/lib/talon_one/models/new_campaign_set.rb +0 -1
- data/lib/talon_one/models/new_campaign_store_budget.rb +283 -0
- data/lib/talon_one/models/new_campaign_store_budget_store_limit.rb +227 -0
- data/lib/talon_one/models/new_campaign_template.rb +10 -1
- data/lib/talon_one/models/new_catalog.rb +0 -1
- data/lib/talon_one/models/new_collection.rb +0 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +1 -2
- data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
- data/lib/talon_one/models/new_coupons.rb +1 -2
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -2
- data/lib/talon_one/models/new_custom_effect.rb +0 -1
- data/lib/talon_one/models/new_customer_session.rb +0 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +3 -3
- data/lib/talon_one/models/new_event.rb +0 -1
- data/lib/talon_one/models/new_event_type.rb +0 -1
- data/lib/talon_one/models/new_loyalty_program.rb +63 -22
- data/lib/talon_one/models/new_loyalty_tier.rb +2 -2
- data/lib/talon_one/models/new_management_key.rb +0 -1
- data/lib/talon_one/models/new_multiple_audiences_item.rb +0 -1
- data/lib/talon_one/models/new_notification_test.rb +2 -2
- data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
- data/lib/talon_one/models/new_referral.rb +1 -2
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -2
- data/lib/talon_one/models/new_revision_version.rb +352 -0
- data/lib/talon_one/models/new_role.rb +0 -1
- data/lib/talon_one/models/new_role_v2.rb +0 -1
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_store.rb +0 -1
- data/lib/talon_one/models/new_user.rb +0 -1
- data/lib/talon_one/models/new_webhook.rb +12 -3
- data/lib/talon_one/models/okta_event.rb +229 -0
- data/lib/talon_one/models/okta_event_payload.rb +212 -0
- data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
- data/lib/talon_one/models/okta_event_target.rb +243 -0
- data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +0 -1
- data/lib/talon_one/models/picklist.rb +0 -1
- data/lib/talon_one/models/product.rb +1 -1
- data/lib/talon_one/models/product_search_match.rb +237 -0
- data/lib/talon_one/models/product_sku_unit_analytics.rb +256 -0
- data/lib/talon_one/models/product_unit_analytics.rb +271 -0
- data/lib/talon_one/models/projected_tier.rb +232 -0
- data/lib/talon_one/models/referral.rb +1 -2
- data/lib/talon_one/models/referral_constraints.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
- data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
- data/lib/talon_one/models/revision.rb +318 -0
- data/lib/talon_one/models/revision_activation.rb +206 -0
- data/lib/talon_one/models/revision_version.rb +465 -0
- data/lib/talon_one/models/role.rb +0 -1
- data/lib/talon_one/models/role_assign.rb +0 -1
- data/lib/talon_one/models/role_v2.rb +0 -1
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
- data/lib/talon_one/models/rule_failure_reason.rb +24 -4
- data/lib/talon_one/models/ruleset.rb +0 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_user.rb +237 -0
- data/lib/talon_one/models/scim_base_user_name.rb +208 -0
- data/lib/talon_one/models/scim_new_user.rb +242 -0
- data/lib/talon_one/models/scim_patch_operation.rb +267 -0
- data/lib/talon_one/models/scim_patch_request.rb +226 -0
- data/lib/talon_one/models/scim_resource.rb +228 -0
- data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
- data/lib/talon_one/models/scim_schema_resource.rb +239 -0
- data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
- data/lib/talon_one/models/scim_service_provider_config_response.rb +265 -0
- data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
- data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
- data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
- data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
- data/lib/talon_one/models/scim_service_provider_config_response_sort.rb +208 -0
- data/lib/talon_one/models/scim_user.rb +257 -0
- data/lib/talon_one/models/scim_users_list_response.rb +236 -0
- data/lib/talon_one/models/sso_config.rb +14 -4
- data/lib/talon_one/models/store.rb +1 -2
- data/lib/talon_one/models/strikethrough_debug_response.rb +221 -0
- data/lib/talon_one/models/summary_campaign_store_budget.rb +280 -0
- data/lib/talon_one/models/talang_attribute.rb +0 -1
- data/lib/talon_one/models/template_arg_def.rb +11 -2
- data/lib/talon_one/models/template_def.rb +0 -1
- data/lib/talon_one/models/template_limit_config.rb +0 -1
- data/lib/talon_one/models/tier.rb +12 -2
- data/lib/talon_one/models/transfer_loyalty_card.rb +25 -4
- data/lib/talon_one/models/update_achievement.rb +90 -4
- data/lib/talon_one/models/update_application.rb +24 -4
- data/lib/talon_one/models/update_application_cif.rb +237 -0
- data/lib/talon_one/models/update_campaign.rb +1 -1
- data/lib/talon_one/models/update_campaign_evaluation_group.rb +0 -1
- data/lib/talon_one/models/update_campaign_group.rb +0 -1
- data/lib/talon_one/models/update_campaign_template.rb +10 -1
- data/lib/talon_one/models/update_coupon.rb +1 -2
- data/lib/talon_one/models/update_coupon_batch.rb +1 -2
- data/lib/talon_one/models/update_loyalty_card.rb +15 -5
- data/lib/talon_one/models/update_loyalty_program.rb +63 -22
- data/lib/talon_one/models/update_loyalty_program_tier.rb +257 -0
- data/lib/talon_one/models/update_picklist.rb +0 -1
- data/lib/talon_one/models/update_referral.rb +1 -1
- data/lib/talon_one/models/update_referral_batch.rb +1 -1
- data/lib/talon_one/models/user.rb +14 -5
- data/lib/talon_one/models/value_map.rb +245 -0
- data/lib/talon_one/models/webhook.rb +12 -3
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +12 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +69 -15
- data/spec/api/integration_api_spec.rb +22 -7
- data/spec/api/management_api_spec.rb +284 -98
- data/spec/models/achievement_progress_spec.rb +6 -0
- data/spec/models/achievement_spec.rb +32 -0
- data/spec/models/additional_campaign_properties_spec.rb +7 -1
- data/spec/models/analytics_data_point_spec.rb +47 -0
- data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
- data/spec/models/analytics_product_sku_spec.rb +53 -0
- data/spec/models/analytics_product_spec.rb +59 -0
- data/spec/models/application_campaign_analytics_spec.rb +1 -19
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_cif_expression_spec.rb +71 -0
- data/spec/models/application_cif_spec.rb +89 -0
- data/spec/models/application_spec.rb +12 -0
- data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +26 -4
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/bulk_operation_on_campaigns_spec.rb +7 -1
- data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +53 -1
- data/spec/models/campaign_store_budget_spec.rb +65 -0
- data/spec/models/campaign_template_coupon_reservation_settings_spec.rb +47 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/campaign_versions_spec.rb +81 -0
- data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/coupon_deletion_filters_spec.rb +123 -0
- data/spec/models/coupon_deletion_job_spec.rb +107 -0
- data/spec/models/create_achievement_spec.rb +32 -0
- data/spec/models/customer_session_v2_spec.rb +6 -0
- data/spec/models/effect_entity_spec.rb +24 -0
- data/spec/models/effect_spec.rb +24 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/generate_campaign_description_spec.rb +47 -0
- data/spec/models/generate_campaign_tags_spec.rb +41 -0
- data/spec/models/generate_item_filter_description_spec.rb +41 -0
- data/spec/models/generate_loyalty_card_spec.rb +57 -0
- data/spec/models/generate_rule_title_rule_spec.rb +47 -0
- data/spec/models/generate_rule_title_spec.rb +47 -0
- data/spec/models/inline_response20021_spec.rb +6 -0
- data/spec/models/inline_response20022_spec.rb +2 -2
- data/spec/models/inline_response20024_spec.rb +0 -6
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +6 -0
- data/spec/models/inline_response20030_spec.rb +0 -6
- data/spec/models/inline_response20032_spec.rb +6 -0
- data/spec/models/inline_response20033_spec.rb +0 -6
- data/spec/models/inline_response20034_spec.rb +6 -0
- data/spec/models/inline_response20035_spec.rb +0 -6
- data/spec/models/inline_response20041_spec.rb +6 -0
- data/spec/models/inline_response20042_spec.rb +0 -6
- data/spec/models/inline_response20044_spec.rb +6 -0
- data/spec/models/inline_response20045_spec.rb +0 -6
- data/spec/models/limit_config_spec.rb +1 -1
- data/spec/models/list_campaign_store_budgets_spec.rb +59 -0
- data/spec/models/list_campaign_store_budgets_store_spec.rb +53 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
- data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_spec.rb +63 -0
- data/spec/models/loyalty_card_spec.rb +24 -0
- data/spec/models/loyalty_program_entity_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +38 -4
- data/spec/models/loyalty_tier_spec.rb +12 -0
- data/spec/models/message_log_entry_spec.rb +25 -1
- data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
- data/spec/models/new_application_cif_expression_spec.rb +53 -0
- data/spec/models/new_application_cif_spec.rb +71 -0
- data/spec/models/new_application_spec.rb +6 -0
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_campaign_store_budget_spec.rb +61 -0
- data/spec/models/new_campaign_store_budget_store_limit_spec.rb +47 -0
- data/spec/models/new_campaign_template_spec.rb +6 -0
- data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
- data/spec/models/new_loyalty_program_spec.rb +26 -4
- data/spec/models/new_notification_test_spec.rb +1 -1
- data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
- data/spec/models/new_revision_version_spec.rb +105 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/okta_event_payload_data_spec.rb +41 -0
- data/spec/models/okta_event_payload_spec.rb +41 -0
- data/spec/models/okta_event_spec.rb +47 -0
- data/spec/models/okta_event_target_spec.rb +53 -0
- data/spec/models/product_search_match_spec.rb +53 -0
- data/spec/models/product_sku_unit_analytics_spec.rb +59 -0
- data/spec/models/product_unit_analytics_spec.rb +65 -0
- data/spec/models/projected_tier_spec.rb +53 -0
- data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
- data/spec/models/reject_referral_effect_props_spec.rb +6 -0
- data/spec/models/revision_activation_spec.rb +41 -0
- data/spec/models/revision_spec.rb +95 -0
- data/spec/models/revision_version_spec.rb +153 -0
- data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
- data/spec/models/rule_failure_reason_spec.rb +12 -0
- data/spec/models/scim_base_user_name_spec.rb +41 -0
- data/spec/models/scim_base_user_spec.rb +59 -0
- data/spec/models/scim_new_user_spec.rb +59 -0
- data/spec/models/scim_patch_operation_spec.rb +57 -0
- data/spec/models/scim_patch_request_spec.rb +47 -0
- data/spec/models/scim_resource_spec.rb +53 -0
- data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
- data/spec/models/scim_schema_resource_spec.rb +59 -0
- data/spec/models/scim_schemas_list_response_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
- data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_sort_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_spec.rb +77 -0
- data/spec/models/scim_user_spec.rb +65 -0
- data/spec/models/scim_users_list_response_spec.rb +53 -0
- data/spec/models/sso_config_spec.rb +6 -0
- data/spec/models/strikethrough_debug_response_spec.rb +47 -0
- data/spec/models/summary_campaign_store_budget_spec.rb +61 -0
- data/spec/models/template_arg_def_spec.rb +6 -0
- data/spec/models/template_limit_config_spec.rb +1 -1
- data/spec/models/tier_spec.rb +6 -0
- data/spec/models/transfer_loyalty_card_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +32 -0
- data/spec/models/update_application_cif_spec.rb +59 -0
- data/spec/models/update_application_spec.rb +12 -0
- data/spec/models/update_campaign_template_spec.rb +6 -0
- data/spec/models/update_loyalty_card_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +26 -4
- data/spec/models/update_loyalty_program_tier_spec.rb +53 -0
- data/spec/models/user_spec.rb +6 -0
- data/spec/models/value_map_spec.rb +59 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +663 -6
data/docs/ManagementApi.md
CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**activate_user_by_email**](ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate |
|
7
|
+
[**activate_user_by_email**](ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Enable user by email address
|
8
8
|
[**add_loyalty_card_points**](ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
|
9
9
|
[**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
|
10
10
|
[**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
|
@@ -12,17 +12,19 @@ Method | HTTP request | Description
|
|
12
12
|
[**create_achievement**](ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
|
13
13
|
[**create_additional_cost**](ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
|
14
14
|
[**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
15
|
+
[**create_batch_loyalty_cards**](ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
15
16
|
[**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
16
17
|
[**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
17
18
|
[**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
18
19
|
[**create_coupons_async**](ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
|
20
|
+
[**create_coupons_deletion_job**](ManagementApi.md#create_coupons_deletion_job) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job
|
19
21
|
[**create_coupons_for_multiple_recipients**](ManagementApi.md#create_coupons_for_multiple_recipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients
|
20
22
|
[**create_invite_email**](ManagementApi.md#create_invite_email) | **POST** /v1/invite_emails | Resend invitation email
|
21
23
|
[**create_invite_v2**](ManagementApi.md#create_invite_v2) | **POST** /v2/invites | Invite user
|
22
24
|
[**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
23
25
|
[**create_session**](ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
|
24
26
|
[**create_store**](ManagementApi.md#create_store) | **POST** /v1/applications/{applicationId}/stores | Create store
|
25
|
-
[**deactivate_user_by_email**](ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate |
|
27
|
+
[**deactivate_user_by_email**](ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate | Disable user by email address
|
26
28
|
[**deduct_loyalty_card_points**](ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
|
27
29
|
[**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
28
30
|
[**delete_achievement**](ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
@@ -36,9 +38,11 @@ Method | HTTP request | Description
|
|
36
38
|
[**delete_user**](ManagementApi.md#delete_user) | **DELETE** /v1/users/{userId} | Delete user
|
37
39
|
[**delete_user_by_email**](ManagementApi.md#delete_user_by_email) | **POST** /v1/users/delete | Delete user by email address
|
38
40
|
[**destroy_session**](ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy session
|
41
|
+
[**disconnect_campaign_stores**](ManagementApi.md#disconnect_campaign_stores) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
|
39
42
|
[**export_account_collection_items**](ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
40
43
|
[**export_achievements**](ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
41
44
|
[**export_audiences_memberships**](ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
45
|
+
[**export_campaign_stores**](ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
|
42
46
|
[**export_collection_items**](ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
|
43
47
|
[**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
44
48
|
[**export_customer_sessions**](ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
|
@@ -48,6 +52,7 @@ Method | HTTP request | Description
|
|
48
52
|
[**export_loyalty_balances**](ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
|
49
53
|
[**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs
|
50
54
|
[**export_loyalty_card_ledger**](ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log
|
55
|
+
[**export_loyalty_cards**](ManagementApi.md#export_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards
|
51
56
|
[**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs
|
52
57
|
[**export_pool_giveaways**](ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool
|
53
58
|
[**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
|
@@ -58,7 +63,6 @@ Method | HTTP request | Description
|
|
58
63
|
[**get_achievement**](ManagementApi.md#get_achievement) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement
|
59
64
|
[**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
|
60
65
|
[**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
61
|
-
[**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs
|
62
66
|
[**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
63
67
|
[**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health
|
64
68
|
[**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer
|
@@ -117,6 +121,7 @@ Method | HTTP request | Description
|
|
117
121
|
[**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
118
122
|
[**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
119
123
|
[**import_audiences_memberships**](ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
124
|
+
[**import_campaign_stores**](ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
120
125
|
[**import_collection**](ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
121
126
|
[**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
122
127
|
[**import_loyalty_cards**](ManagementApi.md#import_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards
|
@@ -133,11 +138,21 @@ Method | HTTP request | Description
|
|
133
138
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
134
139
|
[**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
135
140
|
[**notification_activation**](ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
141
|
+
[**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
136
142
|
[**post_added_deducted_points_notification**](ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
|
137
143
|
[**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
138
144
|
[**post_pending_points_notification**](ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
139
145
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
140
146
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
147
|
+
[**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
148
|
+
[**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
149
|
+
[**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
150
|
+
[**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
151
|
+
[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
152
|
+
[**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
153
|
+
[**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
154
|
+
[**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
155
|
+
[**scim_replace_user_attributes**](ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
141
156
|
[**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count)
|
142
157
|
[**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
|
143
158
|
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
@@ -161,9 +176,9 @@ Method | HTTP request | Description
|
|
161
176
|
|
162
177
|
> activate_user_by_email(body)
|
163
178
|
|
164
|
-
|
179
|
+
Enable user by email address
|
165
180
|
|
166
|
-
|
181
|
+
Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
167
182
|
|
168
183
|
### Example
|
169
184
|
|
@@ -184,10 +199,10 @@ TalonOne.configure do |config|
|
|
184
199
|
end
|
185
200
|
|
186
201
|
api_instance = TalonOne::ManagementApi.new
|
187
|
-
body = TalonOne::
|
202
|
+
body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
|
188
203
|
|
189
204
|
begin
|
190
|
-
#
|
205
|
+
#Enable user by email address
|
191
206
|
api_instance.activate_user_by_email(body)
|
192
207
|
rescue TalonOne::ApiError => e
|
193
208
|
puts "Exception when calling ManagementApi->activate_user_by_email: #{e}"
|
@@ -199,7 +214,7 @@ end
|
|
199
214
|
|
200
215
|
Name | Type | Description | Notes
|
201
216
|
------------- | ------------- | ------------- | -------------
|
202
|
-
**body** |
|
217
|
+
**body** | **DeactivateUserRequest**| body |
|
203
218
|
|
204
219
|
### Return type
|
205
220
|
|
@@ -642,6 +657,67 @@ Name | Type | Description | Notes
|
|
642
657
|
- **Accept**: application/json
|
643
658
|
|
644
659
|
|
660
|
+
## create_batch_loyalty_cards
|
661
|
+
|
662
|
+
> LoyaltyCardBatchResponse create_batch_loyalty_cards(loyalty_program_id, body)
|
663
|
+
|
664
|
+
Create loyalty cards
|
665
|
+
|
666
|
+
Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
|
667
|
+
|
668
|
+
### Example
|
669
|
+
|
670
|
+
```ruby
|
671
|
+
# load the gem
|
672
|
+
require 'talon_one'
|
673
|
+
# setup authorization
|
674
|
+
TalonOne.configure do |config|
|
675
|
+
# Configure API key authorization: management_key
|
676
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
677
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
678
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
679
|
+
|
680
|
+
# Configure API key authorization: manager_auth
|
681
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
682
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
683
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
684
|
+
end
|
685
|
+
|
686
|
+
api_instance = TalonOne::ManagementApi.new
|
687
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
688
|
+
body = TalonOne::LoyaltyCardBatch.new # LoyaltyCardBatch | body
|
689
|
+
|
690
|
+
begin
|
691
|
+
#Create loyalty cards
|
692
|
+
result = api_instance.create_batch_loyalty_cards(loyalty_program_id, body)
|
693
|
+
p result
|
694
|
+
rescue TalonOne::ApiError => e
|
695
|
+
puts "Exception when calling ManagementApi->create_batch_loyalty_cards: #{e}"
|
696
|
+
end
|
697
|
+
```
|
698
|
+
|
699
|
+
### Parameters
|
700
|
+
|
701
|
+
|
702
|
+
Name | Type | Description | Notes
|
703
|
+
------------- | ------------- | ------------- | -------------
|
704
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
705
|
+
**body** | [**LoyaltyCardBatch**](LoyaltyCardBatch.md)| body |
|
706
|
+
|
707
|
+
### Return type
|
708
|
+
|
709
|
+
[**LoyaltyCardBatchResponse**](LoyaltyCardBatchResponse.md)
|
710
|
+
|
711
|
+
### Authorization
|
712
|
+
|
713
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
714
|
+
|
715
|
+
### HTTP request headers
|
716
|
+
|
717
|
+
- **Content-Type**: application/json
|
718
|
+
- **Accept**: application/json
|
719
|
+
|
720
|
+
|
645
721
|
## create_campaign_from_template
|
646
722
|
|
647
723
|
> CreateTemplateCampaignResponse create_campaign_from_template(application_id, body)
|
@@ -896,6 +972,69 @@ Name | Type | Description | Notes
|
|
896
972
|
- **Accept**: application/json
|
897
973
|
|
898
974
|
|
975
|
+
## create_coupons_deletion_job
|
976
|
+
|
977
|
+
> AsyncCouponDeletionJobResponse create_coupons_deletion_job(application_id, campaign_id, body)
|
978
|
+
|
979
|
+
Creates a coupon deletion job
|
980
|
+
|
981
|
+
This endpoint handles creating a job to delete coupons asynchronously.
|
982
|
+
|
983
|
+
### Example
|
984
|
+
|
985
|
+
```ruby
|
986
|
+
# load the gem
|
987
|
+
require 'talon_one'
|
988
|
+
# setup authorization
|
989
|
+
TalonOne.configure do |config|
|
990
|
+
# Configure API key authorization: management_key
|
991
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
992
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
993
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
994
|
+
|
995
|
+
# Configure API key authorization: manager_auth
|
996
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
997
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
998
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
999
|
+
end
|
1000
|
+
|
1001
|
+
api_instance = TalonOne::ManagementApi.new
|
1002
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1003
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1004
|
+
body = TalonOne::NewCouponDeletionJob.new # NewCouponDeletionJob | body
|
1005
|
+
|
1006
|
+
begin
|
1007
|
+
#Creates a coupon deletion job
|
1008
|
+
result = api_instance.create_coupons_deletion_job(application_id, campaign_id, body)
|
1009
|
+
p result
|
1010
|
+
rescue TalonOne::ApiError => e
|
1011
|
+
puts "Exception when calling ManagementApi->create_coupons_deletion_job: #{e}"
|
1012
|
+
end
|
1013
|
+
```
|
1014
|
+
|
1015
|
+
### Parameters
|
1016
|
+
|
1017
|
+
|
1018
|
+
Name | Type | Description | Notes
|
1019
|
+
------------- | ------------- | ------------- | -------------
|
1020
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
1021
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
1022
|
+
**body** | [**NewCouponDeletionJob**](NewCouponDeletionJob.md)| body |
|
1023
|
+
|
1024
|
+
### Return type
|
1025
|
+
|
1026
|
+
[**AsyncCouponDeletionJobResponse**](AsyncCouponDeletionJobResponse.md)
|
1027
|
+
|
1028
|
+
### Authorization
|
1029
|
+
|
1030
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
1031
|
+
|
1032
|
+
### HTTP request headers
|
1033
|
+
|
1034
|
+
- **Content-Type**: application/json
|
1035
|
+
- **Accept**: application/json
|
1036
|
+
|
1037
|
+
|
899
1038
|
## create_coupons_for_multiple_recipients
|
900
1039
|
|
901
1040
|
> InlineResponse2008 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
|
@@ -1264,9 +1403,9 @@ Name | Type | Description | Notes
|
|
1264
1403
|
|
1265
1404
|
> deactivate_user_by_email(body)
|
1266
1405
|
|
1267
|
-
|
1406
|
+
Disable user by email address
|
1268
1407
|
|
1269
|
-
|
1408
|
+
[Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
1270
1409
|
|
1271
1410
|
### Example
|
1272
1411
|
|
@@ -1290,7 +1429,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
1290
1429
|
body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
|
1291
1430
|
|
1292
1431
|
begin
|
1293
|
-
#
|
1432
|
+
#Disable user by email address
|
1294
1433
|
api_instance.deactivate_user_by_email(body)
|
1295
1434
|
rescue TalonOne::ApiError => e
|
1296
1435
|
puts "Exception when calling ManagementApi->deactivate_user_by_email: #{e}"
|
@@ -1717,15 +1856,15 @@ opts = {
|
|
1717
1856
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1718
1857
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1719
1858
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1720
|
-
starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1721
|
-
starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1722
|
-
expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1723
|
-
expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1859
|
+
starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1860
|
+
starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1861
|
+
expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1862
|
+
expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1724
1863
|
valid: 'valid_example', # String | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
1725
1864
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
1726
1865
|
usable: 'usable_example', # String | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
1727
1866
|
referral_id: 56, # Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
1728
|
-
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile
|
1867
|
+
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field.
|
1729
1868
|
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
1730
1869
|
}
|
1731
1870
|
|
@@ -1747,15 +1886,15 @@ Name | Type | Description | Notes
|
|
1747
1886
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
1748
1887
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1749
1888
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1750
|
-
**starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1751
|
-
**starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1752
|
-
**expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1753
|
-
**expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1889
|
+
**starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1890
|
+
**starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1891
|
+
**expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1892
|
+
**expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
1754
1893
|
**valid** | **String**| - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | [optional]
|
1755
1894
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
1756
1895
|
**usable** | **String**| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | [optional]
|
1757
1896
|
**referral_id** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
|
1758
|
-
**recipient_integration_id** | **String**| Filter results by match with a profile
|
1897
|
+
**recipient_integration_id** | **String**| Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. | [optional]
|
1759
1898
|
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
1760
1899
|
|
1761
1900
|
### Return type
|
@@ -2018,7 +2157,7 @@ nil (empty response body)
|
|
2018
2157
|
|
2019
2158
|
Delete user by email address
|
2020
2159
|
|
2021
|
-
Delete a specific user by their email address.
|
2160
|
+
[Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
|
2022
2161
|
|
2023
2162
|
### Example
|
2024
2163
|
|
@@ -2039,7 +2178,7 @@ TalonOne.configure do |config|
|
|
2039
2178
|
end
|
2040
2179
|
|
2041
2180
|
api_instance = TalonOne::ManagementApi.new
|
2042
|
-
body = TalonOne::
|
2181
|
+
body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
|
2043
2182
|
|
2044
2183
|
begin
|
2045
2184
|
#Delete user by email address
|
@@ -2054,7 +2193,7 @@ end
|
|
2054
2193
|
|
2055
2194
|
Name | Type | Description | Notes
|
2056
2195
|
------------- | ------------- | ------------- | -------------
|
2057
|
-
**body** |
|
2196
|
+
**body** | **DeactivateUserRequest**| body |
|
2058
2197
|
|
2059
2198
|
### Return type
|
2060
2199
|
|
@@ -2124,6 +2263,66 @@ nil (empty response body)
|
|
2124
2263
|
- **Accept**: Not defined
|
2125
2264
|
|
2126
2265
|
|
2266
|
+
## disconnect_campaign_stores
|
2267
|
+
|
2268
|
+
> disconnect_campaign_stores(application_id, campaign_id)
|
2269
|
+
|
2270
|
+
Disconnect stores
|
2271
|
+
|
2272
|
+
Disconnect the stores linked to a specific campaign.
|
2273
|
+
|
2274
|
+
### Example
|
2275
|
+
|
2276
|
+
```ruby
|
2277
|
+
# load the gem
|
2278
|
+
require 'talon_one'
|
2279
|
+
# setup authorization
|
2280
|
+
TalonOne.configure do |config|
|
2281
|
+
# Configure API key authorization: management_key
|
2282
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2284
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2285
|
+
|
2286
|
+
# Configure API key authorization: manager_auth
|
2287
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2288
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2289
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2290
|
+
end
|
2291
|
+
|
2292
|
+
api_instance = TalonOne::ManagementApi.new
|
2293
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2294
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2295
|
+
|
2296
|
+
begin
|
2297
|
+
#Disconnect stores
|
2298
|
+
api_instance.disconnect_campaign_stores(application_id, campaign_id)
|
2299
|
+
rescue TalonOne::ApiError => e
|
2300
|
+
puts "Exception when calling ManagementApi->disconnect_campaign_stores: #{e}"
|
2301
|
+
end
|
2302
|
+
```
|
2303
|
+
|
2304
|
+
### Parameters
|
2305
|
+
|
2306
|
+
|
2307
|
+
Name | Type | Description | Notes
|
2308
|
+
------------- | ------------- | ------------- | -------------
|
2309
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2310
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
2311
|
+
|
2312
|
+
### Return type
|
2313
|
+
|
2314
|
+
nil (empty response body)
|
2315
|
+
|
2316
|
+
### Authorization
|
2317
|
+
|
2318
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
2319
|
+
|
2320
|
+
### HTTP request headers
|
2321
|
+
|
2322
|
+
- **Content-Type**: Not defined
|
2323
|
+
- **Accept**: application/json
|
2324
|
+
|
2325
|
+
|
2127
2326
|
## export_account_collection_items
|
2128
2327
|
|
2129
2328
|
> String export_account_collection_items(collection_id)
|
@@ -2305,6 +2504,67 @@ Name | Type | Description | Notes
|
|
2305
2504
|
- **Accept**: application/csv
|
2306
2505
|
|
2307
2506
|
|
2507
|
+
## export_campaign_stores
|
2508
|
+
|
2509
|
+
> String export_campaign_stores(application_id, campaign_id)
|
2510
|
+
|
2511
|
+
Export stores
|
2512
|
+
|
2513
|
+
Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
2514
|
+
|
2515
|
+
### Example
|
2516
|
+
|
2517
|
+
```ruby
|
2518
|
+
# load the gem
|
2519
|
+
require 'talon_one'
|
2520
|
+
# setup authorization
|
2521
|
+
TalonOne.configure do |config|
|
2522
|
+
# Configure API key authorization: management_key
|
2523
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2524
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2525
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2526
|
+
|
2527
|
+
# Configure API key authorization: manager_auth
|
2528
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2530
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2531
|
+
end
|
2532
|
+
|
2533
|
+
api_instance = TalonOne::ManagementApi.new
|
2534
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2535
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2536
|
+
|
2537
|
+
begin
|
2538
|
+
#Export stores
|
2539
|
+
result = api_instance.export_campaign_stores(application_id, campaign_id)
|
2540
|
+
p result
|
2541
|
+
rescue TalonOne::ApiError => e
|
2542
|
+
puts "Exception when calling ManagementApi->export_campaign_stores: #{e}"
|
2543
|
+
end
|
2544
|
+
```
|
2545
|
+
|
2546
|
+
### Parameters
|
2547
|
+
|
2548
|
+
|
2549
|
+
Name | Type | Description | Notes
|
2550
|
+
------------- | ------------- | ------------- | -------------
|
2551
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2552
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
2553
|
+
|
2554
|
+
### Return type
|
2555
|
+
|
2556
|
+
**String**
|
2557
|
+
|
2558
|
+
### Authorization
|
2559
|
+
|
2560
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
2561
|
+
|
2562
|
+
### HTTP request headers
|
2563
|
+
|
2564
|
+
- **Content-Type**: Not defined
|
2565
|
+
- **Accept**: application/csv
|
2566
|
+
|
2567
|
+
|
2308
2568
|
## export_collection_items
|
2309
2569
|
|
2310
2570
|
> String export_collection_items(application_id, campaign_id, collection_id)
|
@@ -2374,7 +2634,7 @@ Name | Type | Description | Notes
|
|
2374
2634
|
|
2375
2635
|
Export coupons
|
2376
2636
|
|
2377
|
-
Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
|
2637
|
+
Download a CSV file containing the coupons that match the given properties. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date in RFC3339 of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
|
2378
2638
|
|
2379
2639
|
### Example
|
2380
2640
|
|
@@ -2397,7 +2657,7 @@ end
|
|
2397
2657
|
api_instance = TalonOne::ManagementApi.new
|
2398
2658
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2399
2659
|
opts = {
|
2400
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
2660
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
2401
2661
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
2402
2662
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
2403
2663
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -2409,7 +2669,7 @@ opts = {
|
|
2409
2669
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
2410
2670
|
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
|
2411
2671
|
date_format: 'date_format_example', # String | Determines the format of dates in the export document.
|
2412
|
-
campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
2672
|
+
campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
2413
2673
|
values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
2414
2674
|
}
|
2415
2675
|
|
@@ -2428,7 +2688,7 @@ end
|
|
2428
2688
|
Name | Type | Description | Notes
|
2429
2689
|
------------- | ------------- | ------------- | -------------
|
2430
2690
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2431
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
2691
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
2432
2692
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
2433
2693
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
2434
2694
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -2440,7 +2700,7 @@ Name | Type | Description | Notes
|
|
2440
2700
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
2441
2701
|
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
|
2442
2702
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
2443
|
-
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
2703
|
+
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
2444
2704
|
**values_only** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false]
|
2445
2705
|
|
2446
2706
|
### Return type
|
@@ -2534,7 +2794,7 @@ Name | Type | Description | Notes
|
|
2534
2794
|
|
2535
2795
|
Export customers' tier data
|
2536
2796
|
|
2537
|
-
Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `
|
2797
|
+
Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.
|
2538
2798
|
|
2539
2799
|
### Example
|
2540
2800
|
|
@@ -2622,9 +2882,9 @@ end
|
|
2622
2882
|
api_instance = TalonOne::ManagementApi.new
|
2623
2883
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2624
2884
|
opts = {
|
2625
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
2626
|
-
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2627
|
-
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2885
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
2886
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2887
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2628
2888
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
2629
2889
|
}
|
2630
2890
|
|
@@ -2643,9 +2903,9 @@ end
|
|
2643
2903
|
Name | Type | Description | Notes
|
2644
2904
|
------------- | ------------- | ------------- | -------------
|
2645
2905
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2646
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
2647
|
-
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2648
|
-
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2906
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
2907
|
+
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
2908
|
+
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
2649
2909
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
2650
2910
|
|
2651
2911
|
### Return type
|
@@ -2920,13 +3180,13 @@ Name | Type | Description | Notes
|
|
2920
3180
|
- **Accept**: application/csv
|
2921
3181
|
|
2922
3182
|
|
2923
|
-
##
|
3183
|
+
## export_loyalty_cards
|
2924
3184
|
|
2925
|
-
> String
|
3185
|
+
> String export_loyalty_cards(loyalty_program_id, opts)
|
2926
3186
|
|
2927
|
-
Export
|
3187
|
+
Export loyalty cards
|
2928
3188
|
|
2929
|
-
Download a CSV file containing
|
3189
|
+
Download a CSV file containing the loyalty cards from a specified loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
|
2930
3190
|
|
2931
3191
|
### Example
|
2932
3192
|
|
@@ -2947,20 +3207,18 @@ TalonOne.configure do |config|
|
|
2947
3207
|
end
|
2948
3208
|
|
2949
3209
|
api_instance = TalonOne::ManagementApi.new
|
2950
|
-
|
2951
|
-
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
2952
|
-
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
2953
|
-
integration_id = 'integration_id_example' # String | The identifier of the profile.
|
3210
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2954
3211
|
opts = {
|
3212
|
+
batch_id: 'batch_id_example', # String | Filter results by loyalty card batch ID.
|
2955
3213
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
2956
3214
|
}
|
2957
3215
|
|
2958
3216
|
begin
|
2959
|
-
#Export
|
2960
|
-
result = api_instance.
|
3217
|
+
#Export loyalty cards
|
3218
|
+
result = api_instance.export_loyalty_cards(loyalty_program_id, opts)
|
2961
3219
|
p result
|
2962
3220
|
rescue TalonOne::ApiError => e
|
2963
|
-
puts "Exception when calling ManagementApi->
|
3221
|
+
puts "Exception when calling ManagementApi->export_loyalty_cards: #{e}"
|
2964
3222
|
end
|
2965
3223
|
```
|
2966
3224
|
|
@@ -2969,10 +3227,8 @@ end
|
|
2969
3227
|
|
2970
3228
|
Name | Type | Description | Notes
|
2971
3229
|
------------- | ------------- | ------------- | -------------
|
2972
|
-
**
|
2973
|
-
**
|
2974
|
-
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
2975
|
-
**integration_id** | **String**| The identifier of the profile. |
|
3230
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
3231
|
+
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
2976
3232
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
2977
3233
|
|
2978
3234
|
### Return type
|
@@ -2989,13 +3245,13 @@ Name | Type | Description | Notes
|
|
2989
3245
|
- **Accept**: application/csv
|
2990
3246
|
|
2991
3247
|
|
2992
|
-
##
|
3248
|
+
## export_loyalty_ledger
|
2993
3249
|
|
2994
|
-
> String
|
3250
|
+
> String export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
|
2995
3251
|
|
2996
|
-
Export
|
3252
|
+
Export customer's transaction logs
|
2997
3253
|
|
2998
|
-
Download a CSV file containing
|
3254
|
+
Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
|
2999
3255
|
|
3000
3256
|
### Example
|
3001
3257
|
|
@@ -3016,18 +3272,20 @@ TalonOne.configure do |config|
|
|
3016
3272
|
end
|
3017
3273
|
|
3018
3274
|
api_instance = TalonOne::ManagementApi.new
|
3019
|
-
|
3275
|
+
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3276
|
+
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3277
|
+
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
3278
|
+
integration_id = 'integration_id_example' # String | The identifier of the profile.
|
3020
3279
|
opts = {
|
3021
|
-
|
3022
|
-
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
|
3280
|
+
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
3023
3281
|
}
|
3024
3282
|
|
3025
3283
|
begin
|
3026
|
-
#Export
|
3027
|
-
result = api_instance.
|
3284
|
+
#Export customer's transaction logs
|
3285
|
+
result = api_instance.export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts)
|
3028
3286
|
p result
|
3029
3287
|
rescue TalonOne::ApiError => e
|
3030
|
-
puts "Exception when calling ManagementApi->
|
3288
|
+
puts "Exception when calling ManagementApi->export_loyalty_ledger: #{e}"
|
3031
3289
|
end
|
3032
3290
|
```
|
3033
3291
|
|
@@ -3036,8 +3294,75 @@ end
|
|
3036
3294
|
|
3037
3295
|
Name | Type | Description | Notes
|
3038
3296
|
------------- | ------------- | ------------- | -------------
|
3039
|
-
**
|
3040
|
-
**
|
3297
|
+
**range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
3298
|
+
**range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
3299
|
+
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
3300
|
+
**integration_id** | **String**| The identifier of the profile. |
|
3301
|
+
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
3302
|
+
|
3303
|
+
### Return type
|
3304
|
+
|
3305
|
+
**String**
|
3306
|
+
|
3307
|
+
### Authorization
|
3308
|
+
|
3309
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
3310
|
+
|
3311
|
+
### HTTP request headers
|
3312
|
+
|
3313
|
+
- **Content-Type**: Not defined
|
3314
|
+
- **Accept**: application/csv
|
3315
|
+
|
3316
|
+
|
3317
|
+
## export_pool_giveaways
|
3318
|
+
|
3319
|
+
> String export_pool_giveaways(pool_id, opts)
|
3320
|
+
|
3321
|
+
Export giveaway codes of a giveaway pool
|
3322
|
+
|
3323
|
+
Download a CSV file containing the giveaway codes of a specific giveaway pool. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
|
3324
|
+
|
3325
|
+
### Example
|
3326
|
+
|
3327
|
+
```ruby
|
3328
|
+
# load the gem
|
3329
|
+
require 'talon_one'
|
3330
|
+
# setup authorization
|
3331
|
+
TalonOne.configure do |config|
|
3332
|
+
# Configure API key authorization: management_key
|
3333
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3335
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3336
|
+
|
3337
|
+
# Configure API key authorization: manager_auth
|
3338
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3340
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3341
|
+
end
|
3342
|
+
|
3343
|
+
api_instance = TalonOne::ManagementApi.new
|
3344
|
+
pool_id = 56 # Integer | The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
|
3345
|
+
opts = {
|
3346
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
|
3347
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
|
3348
|
+
}
|
3349
|
+
|
3350
|
+
begin
|
3351
|
+
#Export giveaway codes of a giveaway pool
|
3352
|
+
result = api_instance.export_pool_giveaways(pool_id, opts)
|
3353
|
+
p result
|
3354
|
+
rescue TalonOne::ApiError => e
|
3355
|
+
puts "Exception when calling ManagementApi->export_pool_giveaways: #{e}"
|
3356
|
+
end
|
3357
|
+
```
|
3358
|
+
|
3359
|
+
### Parameters
|
3360
|
+
|
3361
|
+
|
3362
|
+
Name | Type | Description | Notes
|
3363
|
+
------------- | ------------- | ------------- | -------------
|
3364
|
+
**pool_id** | **Integer**| The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section. |
|
3365
|
+
**created_before** | **DateTime**| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | [optional]
|
3041
3366
|
**created_after** | **DateTime**| Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. | [optional]
|
3042
3367
|
|
3043
3368
|
### Return type
|
@@ -3083,7 +3408,7 @@ end
|
|
3083
3408
|
api_instance = TalonOne::ManagementApi.new
|
3084
3409
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3085
3410
|
opts = {
|
3086
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
3411
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
3087
3412
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
3088
3413
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
3089
3414
|
valid: 'valid_example', # String | - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
|
@@ -3107,7 +3432,7 @@ end
|
|
3107
3432
|
Name | Type | Description | Notes
|
3108
3433
|
------------- | ------------- | ------------- | -------------
|
3109
3434
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
3110
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
3435
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
3111
3436
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
3112
3437
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
3113
3438
|
**valid** | **String**| - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | [optional]
|
@@ -3507,7 +3832,7 @@ Name | Type | Description | Notes
|
|
3507
3832
|
|
3508
3833
|
## get_additional_costs
|
3509
3834
|
|
3510
|
-
>
|
3835
|
+
> InlineResponse20035 get_additional_costs(opts)
|
3511
3836
|
|
3512
3837
|
List additional costs
|
3513
3838
|
|
@@ -3558,82 +3883,7 @@ Name | Type | Description | Notes
|
|
3558
3883
|
|
3559
3884
|
### Return type
|
3560
3885
|
|
3561
|
-
[**
|
3562
|
-
|
3563
|
-
### Authorization
|
3564
|
-
|
3565
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
3566
|
-
|
3567
|
-
### HTTP request headers
|
3568
|
-
|
3569
|
-
- **Content-Type**: Not defined
|
3570
|
-
- **Accept**: application/json
|
3571
|
-
|
3572
|
-
|
3573
|
-
## get_all_access_logs
|
3574
|
-
|
3575
|
-
> InlineResponse20020 get_all_access_logs(opts)
|
3576
|
-
|
3577
|
-
List access logs
|
3578
|
-
|
3579
|
-
Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
3580
|
-
|
3581
|
-
### Example
|
3582
|
-
|
3583
|
-
```ruby
|
3584
|
-
# load the gem
|
3585
|
-
require 'talon_one'
|
3586
|
-
# setup authorization
|
3587
|
-
TalonOne.configure do |config|
|
3588
|
-
# Configure API key authorization: management_key
|
3589
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
3590
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3591
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3592
|
-
|
3593
|
-
# Configure API key authorization: manager_auth
|
3594
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
3595
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3596
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
3597
|
-
end
|
3598
|
-
|
3599
|
-
api_instance = TalonOne::ManagementApi.new
|
3600
|
-
opts = {
|
3601
|
-
range_start: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3602
|
-
range_end: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3603
|
-
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
3604
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
3605
|
-
status: 'status_example', # String | Filter results by HTTP status codes.
|
3606
|
-
page_size: 1000, # Integer | The number of items in the response.
|
3607
|
-
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
3608
|
-
sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
3609
|
-
}
|
3610
|
-
|
3611
|
-
begin
|
3612
|
-
#List access logs
|
3613
|
-
result = api_instance.get_all_access_logs(opts)
|
3614
|
-
p result
|
3615
|
-
rescue TalonOne::ApiError => e
|
3616
|
-
puts "Exception when calling ManagementApi->get_all_access_logs: #{e}"
|
3617
|
-
end
|
3618
|
-
```
|
3619
|
-
|
3620
|
-
### Parameters
|
3621
|
-
|
3622
|
-
|
3623
|
-
Name | Type | Description | Notes
|
3624
|
-
------------- | ------------- | ------------- | -------------
|
3625
|
-
**range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
3626
|
-
**range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
3627
|
-
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
3628
|
-
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
3629
|
-
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
3630
|
-
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
3631
|
-
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
3632
|
-
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
3633
|
-
|
3634
|
-
### Return type
|
3635
|
-
|
3636
|
-
[**InlineResponse20020**](InlineResponse20020.md)
|
3886
|
+
[**InlineResponse20035**](InlineResponse20035.md)
|
3637
3887
|
|
3638
3888
|
### Authorization
|
3639
3889
|
|
@@ -3710,7 +3960,7 @@ Name | Type | Description | Notes
|
|
3710
3960
|
|
3711
3961
|
Get Application health
|
3712
3962
|
|
3713
|
-
Display the health of the Application and show the last time the Application was used. You can also
|
3963
|
+
Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click **Settings** > **Integration API Keys**. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status).
|
3714
3964
|
|
3715
3965
|
### Example
|
3716
3966
|
|
@@ -3826,7 +4076,7 @@ Name | Type | Description | Notes
|
|
3826
4076
|
|
3827
4077
|
## get_application_customer_friends
|
3828
4078
|
|
3829
|
-
>
|
4079
|
+
> InlineResponse20032 get_application_customer_friends(application_id, integration_id, opts)
|
3830
4080
|
|
3831
4081
|
List friends referred by customer profile
|
3832
4082
|
|
@@ -3883,7 +4133,7 @@ Name | Type | Description | Notes
|
|
3883
4133
|
|
3884
4134
|
### Return type
|
3885
4135
|
|
3886
|
-
[**
|
4136
|
+
[**InlineResponse20032**](InlineResponse20032.md)
|
3887
4137
|
|
3888
4138
|
### Authorization
|
3889
4139
|
|
@@ -3897,7 +4147,7 @@ Name | Type | Description | Notes
|
|
3897
4147
|
|
3898
4148
|
## get_application_customers
|
3899
4149
|
|
3900
|
-
>
|
4150
|
+
> InlineResponse20021 get_application_customers(application_id, opts)
|
3901
4151
|
|
3902
4152
|
List application's customers
|
3903
4153
|
|
@@ -3952,7 +4202,7 @@ Name | Type | Description | Notes
|
|
3952
4202
|
|
3953
4203
|
### Return type
|
3954
4204
|
|
3955
|
-
[**
|
4205
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
3956
4206
|
|
3957
4207
|
### Authorization
|
3958
4208
|
|
@@ -3966,7 +4216,7 @@ Name | Type | Description | Notes
|
|
3966
4216
|
|
3967
4217
|
## get_application_customers_by_attributes
|
3968
4218
|
|
3969
|
-
>
|
4219
|
+
> InlineResponse20022 get_application_customers_by_attributes(application_id, body, opts)
|
3970
4220
|
|
3971
4221
|
List application customers matching the given attributes
|
3972
4222
|
|
@@ -4021,7 +4271,7 @@ Name | Type | Description | Notes
|
|
4021
4271
|
|
4022
4272
|
### Return type
|
4023
4273
|
|
4024
|
-
[**
|
4274
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
4025
4275
|
|
4026
4276
|
### Authorization
|
4027
4277
|
|
@@ -4035,7 +4285,7 @@ Name | Type | Description | Notes
|
|
4035
4285
|
|
4036
4286
|
## get_application_event_types
|
4037
4287
|
|
4038
|
-
>
|
4288
|
+
> InlineResponse20028 get_application_event_types(application_id, opts)
|
4039
4289
|
|
4040
4290
|
List Applications event types
|
4041
4291
|
|
@@ -4088,7 +4338,7 @@ Name | Type | Description | Notes
|
|
4088
4338
|
|
4089
4339
|
### Return type
|
4090
4340
|
|
4091
|
-
[**
|
4341
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
4092
4342
|
|
4093
4343
|
### Authorization
|
4094
4344
|
|
@@ -4102,7 +4352,7 @@ Name | Type | Description | Notes
|
|
4102
4352
|
|
4103
4353
|
## get_application_events_without_total_count
|
4104
4354
|
|
4105
|
-
>
|
4355
|
+
> InlineResponse20027 get_application_events_without_total_count(application_id, opts)
|
4106
4356
|
|
4107
4357
|
List Applications events
|
4108
4358
|
|
@@ -4177,7 +4427,7 @@ Name | Type | Description | Notes
|
|
4177
4427
|
|
4178
4428
|
### Return type
|
4179
4429
|
|
4180
|
-
[**
|
4430
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
4181
4431
|
|
4182
4432
|
### Authorization
|
4183
4433
|
|
@@ -4252,7 +4502,7 @@ Name | Type | Description | Notes
|
|
4252
4502
|
|
4253
4503
|
## get_application_sessions
|
4254
4504
|
|
4255
|
-
>
|
4505
|
+
> InlineResponse20026 get_application_sessions(application_id, opts)
|
4256
4506
|
|
4257
4507
|
List Application sessions
|
4258
4508
|
|
@@ -4288,7 +4538,7 @@ opts = {
|
|
4288
4538
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
4289
4539
|
coupon: 'coupon_example', # String | Filter by sessions with this coupon. Must be exact match.
|
4290
4540
|
referral: 'referral_example', # String | Filter by sessions with this referral. Must be exact match.
|
4291
|
-
integration_id: 'integration_id_example', # String | Filter by sessions with this
|
4541
|
+
integration_id: 'integration_id_example', # String | Filter by sessions with this integration ID. Must be exact match.
|
4292
4542
|
store_integration_id: 'store_integration_id_example' # String | The integration ID of the store. You choose this ID when you create a store.
|
4293
4543
|
}
|
4294
4544
|
|
@@ -4316,12 +4566,12 @@ Name | Type | Description | Notes
|
|
4316
4566
|
**created_after** | **DateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
4317
4567
|
**coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
|
4318
4568
|
**referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
|
4319
|
-
**integration_id** | **String**| Filter by sessions with this
|
4569
|
+
**integration_id** | **String**| Filter by sessions with this integration ID. Must be exact match. | [optional]
|
4320
4570
|
**store_integration_id** | **String**| The integration ID of the store. You choose this ID when you create a store. | [optional]
|
4321
4571
|
|
4322
4572
|
### Return type
|
4323
4573
|
|
4324
|
-
[**
|
4574
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
4325
4575
|
|
4326
4576
|
### Authorization
|
4327
4577
|
|
@@ -4459,7 +4709,7 @@ Name | Type | Description | Notes
|
|
4459
4709
|
|
4460
4710
|
## get_attributes
|
4461
4711
|
|
4462
|
-
>
|
4712
|
+
> InlineResponse20033 get_attributes(opts)
|
4463
4713
|
|
4464
4714
|
List custom attributes
|
4465
4715
|
|
@@ -4512,7 +4762,7 @@ Name | Type | Description | Notes
|
|
4512
4762
|
|
4513
4763
|
### Return type
|
4514
4764
|
|
4515
|
-
[**
|
4765
|
+
[**InlineResponse20033**](InlineResponse20033.md)
|
4516
4766
|
|
4517
4767
|
### Authorization
|
4518
4768
|
|
@@ -4526,7 +4776,7 @@ Name | Type | Description | Notes
|
|
4526
4776
|
|
4527
4777
|
## get_audience_memberships
|
4528
4778
|
|
4529
|
-
>
|
4779
|
+
> InlineResponse20031 get_audience_memberships(audience_id, opts)
|
4530
4780
|
|
4531
4781
|
List audience members
|
4532
4782
|
|
@@ -4581,7 +4831,7 @@ Name | Type | Description | Notes
|
|
4581
4831
|
|
4582
4832
|
### Return type
|
4583
4833
|
|
4584
|
-
[**
|
4834
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
4585
4835
|
|
4586
4836
|
### Authorization
|
4587
4837
|
|
@@ -4595,7 +4845,7 @@ Name | Type | Description | Notes
|
|
4595
4845
|
|
4596
4846
|
## get_audiences
|
4597
4847
|
|
4598
|
-
>
|
4848
|
+
> InlineResponse20029 get_audiences(opts)
|
4599
4849
|
|
4600
4850
|
List audiences
|
4601
4851
|
|
@@ -4648,7 +4898,7 @@ Name | Type | Description | Notes
|
|
4648
4898
|
|
4649
4899
|
### Return type
|
4650
4900
|
|
4651
|
-
[**
|
4901
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
4652
4902
|
|
4653
4903
|
### Authorization
|
4654
4904
|
|
@@ -4662,7 +4912,7 @@ Name | Type | Description | Notes
|
|
4662
4912
|
|
4663
4913
|
## get_audiences_analytics
|
4664
4914
|
|
4665
|
-
>
|
4915
|
+
> InlineResponse20030 get_audiences_analytics(audience_ids, opts)
|
4666
4916
|
|
4667
4917
|
List audience analytics
|
4668
4918
|
|
@@ -4711,7 +4961,7 @@ Name | Type | Description | Notes
|
|
4711
4961
|
|
4712
4962
|
### Return type
|
4713
4963
|
|
4714
|
-
[**
|
4964
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
4715
4965
|
|
4716
4966
|
### Authorization
|
4717
4967
|
|
@@ -4786,7 +5036,7 @@ Name | Type | Description | Notes
|
|
4786
5036
|
|
4787
5037
|
## get_campaign_analytics
|
4788
5038
|
|
4789
|
-
>
|
5039
|
+
> InlineResponse20020 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
4790
5040
|
|
4791
5041
|
Get analytics of campaigns
|
4792
5042
|
|
@@ -4841,7 +5091,7 @@ Name | Type | Description | Notes
|
|
4841
5091
|
|
4842
5092
|
### Return type
|
4843
5093
|
|
4844
|
-
[**
|
5094
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
4845
5095
|
|
4846
5096
|
### Authorization
|
4847
5097
|
|
@@ -4886,7 +5136,7 @@ opts = {
|
|
4886
5136
|
page_size: 1000, # Integer | The number of items in the response.
|
4887
5137
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4888
5138
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
4889
|
-
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5139
|
+
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
4890
5140
|
}
|
4891
5141
|
|
4892
5142
|
begin
|
@@ -4908,7 +5158,7 @@ Name | Type | Description | Notes
|
|
4908
5158
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4909
5159
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4910
5160
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
4911
|
-
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5161
|
+
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
4912
5162
|
|
4913
5163
|
### Return type
|
4914
5164
|
|
@@ -5153,13 +5403,13 @@ opts = {
|
|
5153
5403
|
page_size: 1000, # Integer | The number of items in the response.
|
5154
5404
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5155
5405
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5156
|
-
campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5406
|
+
campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5157
5407
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
|
5158
5408
|
tags: 'tags_example', # String | 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
|
5159
5409
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5160
5410
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5161
5411
|
campaign_group_id: 56, # Integer | Filter results to campaigns owned by the specified campaign access group ID.
|
5162
|
-
template_id: 56, # Integer | The ID of the
|
5412
|
+
template_id: 56, # Integer | The ID of the campaign template this campaign was created from.
|
5163
5413
|
store_id: 56 # Integer | Filter results to campaigns linked to the specified store ID.
|
5164
5414
|
}
|
5165
5415
|
|
@@ -5181,13 +5431,13 @@ Name | Type | Description | Notes
|
|
5181
5431
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5182
5432
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5183
5433
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
5184
|
-
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5434
|
+
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
5185
5435
|
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
|
5186
5436
|
**tags** | **String**| 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 | [optional]
|
5187
5437
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5188
5438
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5189
5439
|
**campaign_group_id** | **Integer**| Filter results to campaigns owned by the specified campaign access group ID. | [optional]
|
5190
|
-
**template_id** | **Integer**| The ID of the
|
5440
|
+
**template_id** | **Integer**| The ID of the campaign template this campaign was created from. | [optional]
|
5191
5441
|
**store_id** | **Integer**| Filter results to campaigns linked to the specified store ID. | [optional]
|
5192
5442
|
|
5193
5443
|
### Return type
|
@@ -5206,7 +5456,7 @@ Name | Type | Description | Notes
|
|
5206
5456
|
|
5207
5457
|
## get_changes
|
5208
5458
|
|
5209
|
-
>
|
5459
|
+
> InlineResponse20041 get_changes(opts)
|
5210
5460
|
|
5211
5461
|
Get audit logs for an account
|
5212
5462
|
|
@@ -5273,7 +5523,7 @@ Name | Type | Description | Notes
|
|
5273
5523
|
|
5274
5524
|
### Return type
|
5275
5525
|
|
5276
|
-
[**
|
5526
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
5277
5527
|
|
5278
5528
|
### Authorization
|
5279
5529
|
|
@@ -5451,10 +5701,16 @@ opts = {
|
|
5451
5701
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5452
5702
|
valid: 'valid_example', # String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
5453
5703
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
5704
|
+
redeemed: 'redeemed_example', # String | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter.
|
5454
5705
|
referral_id: 56, # Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
5455
|
-
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile
|
5706
|
+
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
5456
5707
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
5457
|
-
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
5708
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
|
5709
|
+
expires_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5710
|
+
expires_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5711
|
+
starts_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5712
|
+
starts_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5713
|
+
values_only: false # Boolean | Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
5458
5714
|
}
|
5459
5715
|
|
5460
5716
|
begin
|
@@ -5481,10 +5737,16 @@ Name | Type | Description | Notes
|
|
5481
5737
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5482
5738
|
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
|
5483
5739
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
5740
|
+
**redeemed** | **String**| - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | [optional]
|
5484
5741
|
**referral_id** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
|
5485
|
-
**recipient_integration_id** | **String**| Filter results by match with a profile
|
5742
|
+
**recipient_integration_id** | **String**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional]
|
5486
5743
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
5487
|
-
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
5744
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
|
5745
|
+
**expires_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5746
|
+
**expires_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5747
|
+
**starts_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5748
|
+
**starts_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5749
|
+
**values_only** | **Boolean**| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [optional] [default to false]
|
5488
5750
|
|
5489
5751
|
### Return type
|
5490
5752
|
|
@@ -5573,7 +5835,7 @@ Name | Type | Description | Notes
|
|
5573
5835
|
|
5574
5836
|
## get_customer_activity_reports_without_total_count
|
5575
5837
|
|
5576
|
-
>
|
5838
|
+
> InlineResponse20025 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
5577
5839
|
|
5578
5840
|
Get Activity Reports for Application Customers
|
5579
5841
|
|
@@ -5605,10 +5867,10 @@ opts = {
|
|
5605
5867
|
page_size: 1000, # Integer | The number of items in the response.
|
5606
5868
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5607
5869
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
5608
|
-
name: 'name_example', # String | Only return reports matching the customer name
|
5870
|
+
name: 'name_example', # String | Only return reports matching the customer name.
|
5609
5871
|
integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
|
5610
|
-
campaign_name: 'campaign_name_example', # String | Only return reports matching the
|
5611
|
-
advocate_name: 'advocate_name_example' # String | Only return reports matching the current customer referrer name
|
5872
|
+
campaign_name: 'campaign_name_example', # String | Only return reports matching the campaign name.
|
5873
|
+
advocate_name: 'advocate_name_example' # String | Only return reports matching the current customer referrer name.
|
5612
5874
|
}
|
5613
5875
|
|
5614
5876
|
begin
|
@@ -5631,14 +5893,14 @@ Name | Type | Description | Notes
|
|
5631
5893
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5632
5894
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5633
5895
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
5634
|
-
**name** | **String**| Only return reports matching the customer name | [optional]
|
5896
|
+
**name** | **String**| Only return reports matching the customer name. | [optional]
|
5635
5897
|
**integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
|
5636
|
-
**campaign_name** | **String**| Only return reports matching the
|
5637
|
-
**advocate_name** | **String**| Only return reports matching the current customer referrer name | [optional]
|
5898
|
+
**campaign_name** | **String**| Only return reports matching the campaign name. | [optional]
|
5899
|
+
**advocate_name** | **String**| Only return reports matching the current customer referrer name. | [optional]
|
5638
5900
|
|
5639
5901
|
### Return type
|
5640
5902
|
|
5641
|
-
[**
|
5903
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
5642
5904
|
|
5643
5905
|
### Authorization
|
5644
5906
|
|
@@ -5780,7 +6042,7 @@ Name | Type | Description | Notes
|
|
5780
6042
|
|
5781
6043
|
## get_customer_profile_achievement_progress
|
5782
6044
|
|
5783
|
-
>
|
6045
|
+
> InlineResponse20046 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
5784
6046
|
|
5785
6047
|
List customer achievements
|
5786
6048
|
|
@@ -5837,7 +6099,7 @@ Name | Type | Description | Notes
|
|
5837
6099
|
|
5838
6100
|
### Return type
|
5839
6101
|
|
5840
|
-
[**
|
6102
|
+
[**InlineResponse20046**](InlineResponse20046.md)
|
5841
6103
|
|
5842
6104
|
### Authorization
|
5843
6105
|
|
@@ -5851,7 +6113,7 @@ Name | Type | Description | Notes
|
|
5851
6113
|
|
5852
6114
|
## get_customer_profiles
|
5853
6115
|
|
5854
|
-
>
|
6116
|
+
> InlineResponse20024 get_customer_profiles(opts)
|
5855
6117
|
|
5856
6118
|
List customer profiles
|
5857
6119
|
|
@@ -5879,7 +6141,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5879
6141
|
opts = {
|
5880
6142
|
page_size: 1000, # Integer | The number of items in the response.
|
5881
6143
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5882
|
-
sandbox: false # Boolean | Indicates whether you are pointing to a sandbox or
|
6144
|
+
sandbox: false # Boolean | Indicates whether you are pointing to a sandbox or live customer.
|
5883
6145
|
}
|
5884
6146
|
|
5885
6147
|
begin
|
@@ -5898,11 +6160,11 @@ Name | Type | Description | Notes
|
|
5898
6160
|
------------- | ------------- | ------------- | -------------
|
5899
6161
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5900
6162
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5901
|
-
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or
|
6163
|
+
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to false]
|
5902
6164
|
|
5903
6165
|
### Return type
|
5904
6166
|
|
5905
|
-
[**
|
6167
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
5906
6168
|
|
5907
6169
|
### Authorization
|
5908
6170
|
|
@@ -5916,7 +6178,7 @@ Name | Type | Description | Notes
|
|
5916
6178
|
|
5917
6179
|
## get_customers_by_attributes
|
5918
6180
|
|
5919
|
-
>
|
6181
|
+
> InlineResponse20023 get_customers_by_attributes(body, opts)
|
5920
6182
|
|
5921
6183
|
List customer profiles matching the given attributes
|
5922
6184
|
|
@@ -5945,7 +6207,7 @@ body = TalonOne::CustomerProfileSearchQuery.new # CustomerProfileSearchQuery | b
|
|
5945
6207
|
opts = {
|
5946
6208
|
page_size: 1000, # Integer | The number of items in the response.
|
5947
6209
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5948
|
-
sandbox: false # Boolean | Indicates whether you are pointing to a sandbox or
|
6210
|
+
sandbox: false # Boolean | Indicates whether you are pointing to a sandbox or live customer.
|
5949
6211
|
}
|
5950
6212
|
|
5951
6213
|
begin
|
@@ -5965,11 +6227,11 @@ Name | Type | Description | Notes
|
|
5965
6227
|
**body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body |
|
5966
6228
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5967
6229
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5968
|
-
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or
|
6230
|
+
**sandbox** | **Boolean**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to false]
|
5969
6231
|
|
5970
6232
|
### Return type
|
5971
6233
|
|
5972
|
-
[**
|
6234
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
5973
6235
|
|
5974
6236
|
### Authorization
|
5975
6237
|
|
@@ -5983,7 +6245,7 @@ Name | Type | Description | Notes
|
|
5983
6245
|
|
5984
6246
|
## get_event_types
|
5985
6247
|
|
5986
|
-
>
|
6248
|
+
> InlineResponse20039 get_event_types(opts)
|
5987
6249
|
|
5988
6250
|
List event types
|
5989
6251
|
|
@@ -6038,7 +6300,7 @@ Name | Type | Description | Notes
|
|
6038
6300
|
|
6039
6301
|
### Return type
|
6040
6302
|
|
6041
|
-
[**
|
6303
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
6042
6304
|
|
6043
6305
|
### Authorization
|
6044
6306
|
|
@@ -6052,7 +6314,7 @@ Name | Type | Description | Notes
|
|
6052
6314
|
|
6053
6315
|
## get_exports
|
6054
6316
|
|
6055
|
-
>
|
6317
|
+
> InlineResponse20042 get_exports(opts)
|
6056
6318
|
|
6057
6319
|
Get exports
|
6058
6320
|
|
@@ -6107,7 +6369,7 @@ Name | Type | Description | Notes
|
|
6107
6369
|
|
6108
6370
|
### Return type
|
6109
6371
|
|
6110
|
-
[**
|
6372
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
6111
6373
|
|
6112
6374
|
### Authorization
|
6113
6375
|
|
@@ -6285,8 +6547,9 @@ opts = {
|
|
6285
6547
|
page_size: 1000, # Integer | The number of items in the response.
|
6286
6548
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6287
6549
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
6288
|
-
identifier: 'identifier_example', # String |
|
6289
|
-
profile_id: 56 # Integer | Filter by
|
6550
|
+
identifier: 'identifier_example', # String | The card code by which to filter loyalty cards in the response.
|
6551
|
+
profile_id: 56, # Integer | Filter results by customer profile ID.
|
6552
|
+
batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
|
6290
6553
|
}
|
6291
6554
|
|
6292
6555
|
begin
|
@@ -6307,8 +6570,9 @@ Name | Type | Description | Notes
|
|
6307
6570
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6308
6571
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6309
6572
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
6310
|
-
**identifier** | **String**|
|
6311
|
-
**profile_id** | **Integer**| Filter by
|
6573
|
+
**identifier** | **String**| The card code by which to filter loyalty cards in the response. | [optional]
|
6574
|
+
**profile_id** | **Integer**| Filter results by customer profile ID. | [optional]
|
6575
|
+
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
6312
6576
|
|
6313
6577
|
### Return type
|
6314
6578
|
|
@@ -6669,7 +6933,7 @@ opts = {
|
|
6669
6933
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6670
6934
|
valid: 'valid_example', # String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
6671
6935
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
6672
|
-
advocate: 'advocate_example' # String | Filter results by match with a profile
|
6936
|
+
advocate: 'advocate_example' # String | Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
6673
6937
|
}
|
6674
6938
|
|
6675
6939
|
begin
|
@@ -6696,7 +6960,7 @@ Name | Type | Description | Notes
|
|
6696
6960
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
6697
6961
|
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. | [optional]
|
6698
6962
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | [optional]
|
6699
|
-
**advocate** | **String**| Filter results by match with a profile
|
6963
|
+
**advocate** | **String**| Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. | [optional]
|
6700
6964
|
|
6701
6965
|
### Return type
|
6702
6966
|
|
@@ -7025,7 +7289,7 @@ Name | Type | Description | Notes
|
|
7025
7289
|
|
7026
7290
|
## get_users
|
7027
7291
|
|
7028
|
-
>
|
7292
|
+
> InlineResponse20040 get_users(opts)
|
7029
7293
|
|
7030
7294
|
List users in account
|
7031
7295
|
|
@@ -7076,7 +7340,7 @@ Name | Type | Description | Notes
|
|
7076
7340
|
|
7077
7341
|
### Return type
|
7078
7342
|
|
7079
|
-
[**
|
7343
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
7080
7344
|
|
7081
7345
|
### Authorization
|
7082
7346
|
|
@@ -7149,7 +7413,7 @@ Name | Type | Description | Notes
|
|
7149
7413
|
|
7150
7414
|
## get_webhook_activation_logs
|
7151
7415
|
|
7152
|
-
>
|
7416
|
+
> InlineResponse20037 get_webhook_activation_logs(opts)
|
7153
7417
|
|
7154
7418
|
List webhook activation log entries
|
7155
7419
|
|
@@ -7179,9 +7443,9 @@ opts = {
|
|
7179
7443
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7180
7444
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7181
7445
|
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
7182
|
-
webhook_id: 3.4, # Float | Filter results by
|
7446
|
+
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7183
7447
|
application_id: 3.4, # Float | Filter results by Application ID.
|
7184
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
7448
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
7185
7449
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7186
7450
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7187
7451
|
}
|
@@ -7204,15 +7468,15 @@ Name | Type | Description | Notes
|
|
7204
7468
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7205
7469
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
7206
7470
|
**integration_request_uuid** | **String**| Filter results by integration request UUID. | [optional]
|
7207
|
-
**webhook_id** | **Float**| Filter results by
|
7471
|
+
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7208
7472
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
7209
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
7473
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
7210
7474
|
**created_before** | **DateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7211
7475
|
**created_after** | **DateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7212
7476
|
|
7213
7477
|
### Return type
|
7214
7478
|
|
7215
|
-
[**
|
7479
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
7216
7480
|
|
7217
7481
|
### Authorization
|
7218
7482
|
|
@@ -7226,7 +7490,7 @@ Name | Type | Description | Notes
|
|
7226
7490
|
|
7227
7491
|
## get_webhook_logs
|
7228
7492
|
|
7229
|
-
>
|
7493
|
+
> InlineResponse20038 get_webhook_logs(opts)
|
7230
7494
|
|
7231
7495
|
List webhook log entries
|
7232
7496
|
|
@@ -7256,9 +7520,9 @@ opts = {
|
|
7256
7520
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7257
7521
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7258
7522
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
7259
|
-
webhook_id: 3.4, # Float | Filter results by
|
7523
|
+
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7260
7524
|
application_id: 3.4, # Float | Filter results by Application ID.
|
7261
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
7525
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
7262
7526
|
request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
|
7263
7527
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7264
7528
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -7282,16 +7546,16 @@ Name | Type | Description | Notes
|
|
7282
7546
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7283
7547
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
7284
7548
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
7285
|
-
**webhook_id** | **Float**| Filter results by
|
7549
|
+
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7286
7550
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
7287
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
7551
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
7288
7552
|
**request_uuid** | **String**| Filter results by request UUID. | [optional]
|
7289
7553
|
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7290
7554
|
**created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7291
7555
|
|
7292
7556
|
### Return type
|
7293
7557
|
|
7294
|
-
[**
|
7558
|
+
[**InlineResponse20038**](InlineResponse20038.md)
|
7295
7559
|
|
7296
7560
|
### Authorization
|
7297
7561
|
|
@@ -7305,7 +7569,7 @@ Name | Type | Description | Notes
|
|
7305
7569
|
|
7306
7570
|
## get_webhooks
|
7307
7571
|
|
7308
|
-
>
|
7572
|
+
> InlineResponse20036 get_webhooks(opts)
|
7309
7573
|
|
7310
7574
|
List webhooks
|
7311
7575
|
|
@@ -7331,7 +7595,7 @@ end
|
|
7331
7595
|
|
7332
7596
|
api_instance = TalonOne::ManagementApi.new
|
7333
7597
|
opts = {
|
7334
|
-
application_ids: 'application_ids_example', # String |
|
7598
|
+
application_ids: 'application_ids_example', # String | Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
7335
7599
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
7336
7600
|
page_size: 1000, # Integer | The number of items in the response.
|
7337
7601
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
@@ -7355,7 +7619,7 @@ end
|
|
7355
7619
|
|
7356
7620
|
Name | Type | Description | Notes
|
7357
7621
|
------------- | ------------- | ------------- | -------------
|
7358
|
-
**application_ids** | **String**|
|
7622
|
+
**application_ids** | **String**| Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications. | [optional]
|
7359
7623
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
7360
7624
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7361
7625
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
@@ -7366,7 +7630,7 @@ Name | Type | Description | Notes
|
|
7366
7630
|
|
7367
7631
|
### Return type
|
7368
7632
|
|
7369
|
-
[**
|
7633
|
+
[**InlineResponse20036**](InlineResponse20036.md)
|
7370
7634
|
|
7371
7635
|
### Authorization
|
7372
7636
|
|
@@ -7567,6 +7831,71 @@ Name | Type | Description | Notes
|
|
7567
7831
|
- **Accept**: application/json
|
7568
7832
|
|
7569
7833
|
|
7834
|
+
## import_campaign_stores
|
7835
|
+
|
7836
|
+
> Import import_campaign_stores(application_id, campaign_id, opts)
|
7837
|
+
|
7838
|
+
Import stores
|
7839
|
+
|
7840
|
+
Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
7841
|
+
|
7842
|
+
### Example
|
7843
|
+
|
7844
|
+
```ruby
|
7845
|
+
# load the gem
|
7846
|
+
require 'talon_one'
|
7847
|
+
# setup authorization
|
7848
|
+
TalonOne.configure do |config|
|
7849
|
+
# Configure API key authorization: management_key
|
7850
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
7851
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
7852
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
7853
|
+
|
7854
|
+
# Configure API key authorization: manager_auth
|
7855
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
7856
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
7857
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
7858
|
+
end
|
7859
|
+
|
7860
|
+
api_instance = TalonOne::ManagementApi.new
|
7861
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
7862
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
7863
|
+
opts = {
|
7864
|
+
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
7865
|
+
}
|
7866
|
+
|
7867
|
+
begin
|
7868
|
+
#Import stores
|
7869
|
+
result = api_instance.import_campaign_stores(application_id, campaign_id, opts)
|
7870
|
+
p result
|
7871
|
+
rescue TalonOne::ApiError => e
|
7872
|
+
puts "Exception when calling ManagementApi->import_campaign_stores: #{e}"
|
7873
|
+
end
|
7874
|
+
```
|
7875
|
+
|
7876
|
+
### Parameters
|
7877
|
+
|
7878
|
+
|
7879
|
+
Name | Type | Description | Notes
|
7880
|
+
------------- | ------------- | ------------- | -------------
|
7881
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
7882
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
7883
|
+
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
7884
|
+
|
7885
|
+
### Return type
|
7886
|
+
|
7887
|
+
[**Import**](Import.md)
|
7888
|
+
|
7889
|
+
### Authorization
|
7890
|
+
|
7891
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
7892
|
+
|
7893
|
+
### HTTP request headers
|
7894
|
+
|
7895
|
+
- **Content-Type**: multipart/form-data
|
7896
|
+
- **Accept**: application/json
|
7897
|
+
|
7898
|
+
|
7570
7899
|
## import_collection
|
7571
7900
|
|
7572
7901
|
> Import import_collection(application_id, campaign_id, collection_id, opts)
|
@@ -7707,7 +8036,7 @@ Name | Type | Description | Notes
|
|
7707
8036
|
|
7708
8037
|
Import loyalty cards
|
7709
8038
|
|
7710
|
-
Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
|
8039
|
+
Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
|
7711
8040
|
|
7712
8041
|
### Example
|
7713
8042
|
|
@@ -7770,7 +8099,7 @@ Name | Type | Description | Notes
|
|
7770
8099
|
|
7771
8100
|
Import customers into loyalty tiers
|
7772
8101
|
|
7773
|
-
Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
8102
|
+
Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
7774
8103
|
|
7775
8104
|
### Example
|
7776
8105
|
|
@@ -7833,7 +8162,7 @@ Name | Type | Description | Notes
|
|
7833
8162
|
|
7834
8163
|
Import loyalty points
|
7835
8164
|
|
7836
|
-
Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
8165
|
+
Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
7837
8166
|
|
7838
8167
|
### Example
|
7839
8168
|
|
@@ -8024,7 +8353,7 @@ Name | Type | Description | Notes
|
|
8024
8353
|
|
8025
8354
|
Invite user from identity provider
|
8026
8355
|
|
8027
|
-
Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
|
8356
|
+
[Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.
|
8028
8357
|
|
8029
8358
|
### Example
|
8030
8359
|
|
@@ -8147,7 +8476,7 @@ Name | Type | Description | Notes
|
|
8147
8476
|
|
8148
8477
|
## list_achievements
|
8149
8478
|
|
8150
|
-
>
|
8479
|
+
> InlineResponse20045 list_achievements(application_id, campaign_id, opts)
|
8151
8480
|
|
8152
8481
|
List achievements
|
8153
8482
|
|
@@ -8202,7 +8531,7 @@ Name | Type | Description | Notes
|
|
8202
8531
|
|
8203
8532
|
### Return type
|
8204
8533
|
|
8205
|
-
[**
|
8534
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
8206
8535
|
|
8207
8536
|
### Authorization
|
8208
8537
|
|
@@ -8216,7 +8545,7 @@ Name | Type | Description | Notes
|
|
8216
8545
|
|
8217
8546
|
## list_all_roles_v2
|
8218
8547
|
|
8219
|
-
>
|
8548
|
+
> InlineResponse20043 list_all_roles_v2
|
8220
8549
|
|
8221
8550
|
List roles
|
8222
8551
|
|
@@ -8257,7 +8586,7 @@ This endpoint does not need any parameter.
|
|
8257
8586
|
|
8258
8587
|
### Return type
|
8259
8588
|
|
8260
|
-
[**
|
8589
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
8261
8590
|
|
8262
8591
|
### Authorization
|
8263
8592
|
|
@@ -8271,7 +8600,7 @@ This endpoint does not need any parameter.
|
|
8271
8600
|
|
8272
8601
|
## list_catalog_items
|
8273
8602
|
|
8274
|
-
>
|
8603
|
+
> InlineResponse20034 list_catalog_items(catalog_id, opts)
|
8275
8604
|
|
8276
8605
|
List items in a catalog
|
8277
8606
|
|
@@ -8328,7 +8657,7 @@ Name | Type | Description | Notes
|
|
8328
8657
|
|
8329
8658
|
### Return type
|
8330
8659
|
|
8331
|
-
[**
|
8660
|
+
[**InlineResponse20034**](InlineResponse20034.md)
|
8332
8661
|
|
8333
8662
|
### Authorization
|
8334
8663
|
|
@@ -8486,7 +8815,7 @@ Name | Type | Description | Notes
|
|
8486
8815
|
|
8487
8816
|
## list_stores
|
8488
8817
|
|
8489
|
-
>
|
8818
|
+
> InlineResponse20044 list_stores(application_id, opts)
|
8490
8819
|
|
8491
8820
|
List stores
|
8492
8821
|
|
@@ -8517,7 +8846,7 @@ opts = {
|
|
8517
8846
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8518
8847
|
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
|
8519
8848
|
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8520
|
-
campaign_id: 3.4, # Float | Filter results by campaign.
|
8849
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
8521
8850
|
name: 'name_example', # String | The name of the store.
|
8522
8851
|
integration_id: 'integration_id_example', # String | The integration ID of the store.
|
8523
8852
|
query: 'query_example' # String | Filter results by `name` or `integrationId`.
|
@@ -8542,14 +8871,14 @@ Name | Type | Description | Notes
|
|
8542
8871
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8543
8872
|
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
|
8544
8873
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
8545
|
-
**campaign_id** | **Float**| Filter results by campaign. | [optional]
|
8874
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
8546
8875
|
**name** | **String**| The name of the store. | [optional]
|
8547
8876
|
**integration_id** | **String**| The integration ID of the store. | [optional]
|
8548
8877
|
**query** | **String**| Filter results by `name` or `integrationId`. | [optional]
|
8549
8878
|
|
8550
8879
|
### Return type
|
8551
8880
|
|
8552
|
-
[**
|
8881
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
8553
8882
|
|
8554
8883
|
### Authorization
|
8555
8884
|
|
@@ -8621,13 +8950,13 @@ nil (empty response body)
|
|
8621
8950
|
- **Accept**: Not defined
|
8622
8951
|
|
8623
8952
|
|
8624
|
-
##
|
8953
|
+
## okta_event_handler_challenge
|
8625
8954
|
|
8626
|
-
>
|
8955
|
+
> okta_event_handler_challenge
|
8627
8956
|
|
8628
|
-
|
8957
|
+
Validate Okta API ownership
|
8629
8958
|
|
8630
|
-
|
8959
|
+
Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
8631
8960
|
|
8632
8961
|
### Example
|
8633
8962
|
|
@@ -8648,8 +8977,62 @@ TalonOne.configure do |config|
|
|
8648
8977
|
end
|
8649
8978
|
|
8650
8979
|
api_instance = TalonOne::ManagementApi.new
|
8651
|
-
|
8652
|
-
|
8980
|
+
|
8981
|
+
begin
|
8982
|
+
#Validate Okta API ownership
|
8983
|
+
api_instance.okta_event_handler_challenge
|
8984
|
+
rescue TalonOne::ApiError => e
|
8985
|
+
puts "Exception when calling ManagementApi->okta_event_handler_challenge: #{e}"
|
8986
|
+
end
|
8987
|
+
```
|
8988
|
+
|
8989
|
+
### Parameters
|
8990
|
+
|
8991
|
+
This endpoint does not need any parameter.
|
8992
|
+
|
8993
|
+
### Return type
|
8994
|
+
|
8995
|
+
nil (empty response body)
|
8996
|
+
|
8997
|
+
### Authorization
|
8998
|
+
|
8999
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9000
|
+
|
9001
|
+
### HTTP request headers
|
9002
|
+
|
9003
|
+
- **Content-Type**: Not defined
|
9004
|
+
- **Accept**: Not defined
|
9005
|
+
|
9006
|
+
|
9007
|
+
## post_added_deducted_points_notification
|
9008
|
+
|
9009
|
+
> BaseNotification post_added_deducted_points_notification(loyalty_program_id, body)
|
9010
|
+
|
9011
|
+
Create notification about added or deducted loyalty points
|
9012
|
+
|
9013
|
+
Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
9014
|
+
|
9015
|
+
### Example
|
9016
|
+
|
9017
|
+
```ruby
|
9018
|
+
# load the gem
|
9019
|
+
require 'talon_one'
|
9020
|
+
# setup authorization
|
9021
|
+
TalonOne.configure do |config|
|
9022
|
+
# Configure API key authorization: management_key
|
9023
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9024
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9025
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9026
|
+
|
9027
|
+
# Configure API key authorization: manager_auth
|
9028
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9029
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9030
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9031
|
+
end
|
9032
|
+
|
9033
|
+
api_instance = TalonOne::ManagementApi.new
|
9034
|
+
loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9035
|
+
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
8653
9036
|
|
8654
9037
|
begin
|
8655
9038
|
#Create notification about added or deducted loyalty points
|
@@ -8925,6 +9308,524 @@ Name | Type | Description | Notes
|
|
8925
9308
|
- **Accept**: application/json
|
8926
9309
|
|
8927
9310
|
|
9311
|
+
## scim_create_user
|
9312
|
+
|
9313
|
+
> ScimUser scim_create_user(body)
|
9314
|
+
|
9315
|
+
Create SCIM user
|
9316
|
+
|
9317
|
+
Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
9318
|
+
|
9319
|
+
### Example
|
9320
|
+
|
9321
|
+
```ruby
|
9322
|
+
# load the gem
|
9323
|
+
require 'talon_one'
|
9324
|
+
# setup authorization
|
9325
|
+
TalonOne.configure do |config|
|
9326
|
+
# Configure API key authorization: management_key
|
9327
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9328
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9329
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9330
|
+
|
9331
|
+
# Configure API key authorization: manager_auth
|
9332
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9333
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9334
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9335
|
+
end
|
9336
|
+
|
9337
|
+
api_instance = TalonOne::ManagementApi.new
|
9338
|
+
body = TalonOne::ScimNewUser.new # ScimNewUser | body
|
9339
|
+
|
9340
|
+
begin
|
9341
|
+
#Create SCIM user
|
9342
|
+
result = api_instance.scim_create_user(body)
|
9343
|
+
p result
|
9344
|
+
rescue TalonOne::ApiError => e
|
9345
|
+
puts "Exception when calling ManagementApi->scim_create_user: #{e}"
|
9346
|
+
end
|
9347
|
+
```
|
9348
|
+
|
9349
|
+
### Parameters
|
9350
|
+
|
9351
|
+
|
9352
|
+
Name | Type | Description | Notes
|
9353
|
+
------------- | ------------- | ------------- | -------------
|
9354
|
+
**body** | [**ScimNewUser**](ScimNewUser.md)| body |
|
9355
|
+
|
9356
|
+
### Return type
|
9357
|
+
|
9358
|
+
[**ScimUser**](ScimUser.md)
|
9359
|
+
|
9360
|
+
### Authorization
|
9361
|
+
|
9362
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9363
|
+
|
9364
|
+
### HTTP request headers
|
9365
|
+
|
9366
|
+
- **Content-Type**: application/json
|
9367
|
+
- **Accept**: application/json
|
9368
|
+
|
9369
|
+
|
9370
|
+
## scim_delete_user
|
9371
|
+
|
9372
|
+
> scim_delete_user(user_id)
|
9373
|
+
|
9374
|
+
Delete SCIM user
|
9375
|
+
|
9376
|
+
Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
9377
|
+
|
9378
|
+
### Example
|
9379
|
+
|
9380
|
+
```ruby
|
9381
|
+
# load the gem
|
9382
|
+
require 'talon_one'
|
9383
|
+
# setup authorization
|
9384
|
+
TalonOne.configure do |config|
|
9385
|
+
# Configure API key authorization: management_key
|
9386
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9387
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9388
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9389
|
+
|
9390
|
+
# Configure API key authorization: manager_auth
|
9391
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9392
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9393
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9394
|
+
end
|
9395
|
+
|
9396
|
+
api_instance = TalonOne::ManagementApi.new
|
9397
|
+
user_id = 56 # Integer | The ID of the user.
|
9398
|
+
|
9399
|
+
begin
|
9400
|
+
#Delete SCIM user
|
9401
|
+
api_instance.scim_delete_user(user_id)
|
9402
|
+
rescue TalonOne::ApiError => e
|
9403
|
+
puts "Exception when calling ManagementApi->scim_delete_user: #{e}"
|
9404
|
+
end
|
9405
|
+
```
|
9406
|
+
|
9407
|
+
### Parameters
|
9408
|
+
|
9409
|
+
|
9410
|
+
Name | Type | Description | Notes
|
9411
|
+
------------- | ------------- | ------------- | -------------
|
9412
|
+
**user_id** | **Integer**| The ID of the user. |
|
9413
|
+
|
9414
|
+
### Return type
|
9415
|
+
|
9416
|
+
nil (empty response body)
|
9417
|
+
|
9418
|
+
### Authorization
|
9419
|
+
|
9420
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9421
|
+
|
9422
|
+
### HTTP request headers
|
9423
|
+
|
9424
|
+
- **Content-Type**: Not defined
|
9425
|
+
- **Accept**: Not defined
|
9426
|
+
|
9427
|
+
|
9428
|
+
## scim_get_resource_types
|
9429
|
+
|
9430
|
+
> ScimResourceTypesListResponse scim_get_resource_types
|
9431
|
+
|
9432
|
+
List supported SCIM resource types
|
9433
|
+
|
9434
|
+
Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
9435
|
+
|
9436
|
+
### Example
|
9437
|
+
|
9438
|
+
```ruby
|
9439
|
+
# load the gem
|
9440
|
+
require 'talon_one'
|
9441
|
+
# setup authorization
|
9442
|
+
TalonOne.configure do |config|
|
9443
|
+
# Configure API key authorization: management_key
|
9444
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9445
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9446
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9447
|
+
|
9448
|
+
# Configure API key authorization: manager_auth
|
9449
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9450
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9451
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9452
|
+
end
|
9453
|
+
|
9454
|
+
api_instance = TalonOne::ManagementApi.new
|
9455
|
+
|
9456
|
+
begin
|
9457
|
+
#List supported SCIM resource types
|
9458
|
+
result = api_instance.scim_get_resource_types
|
9459
|
+
p result
|
9460
|
+
rescue TalonOne::ApiError => e
|
9461
|
+
puts "Exception when calling ManagementApi->scim_get_resource_types: #{e}"
|
9462
|
+
end
|
9463
|
+
```
|
9464
|
+
|
9465
|
+
### Parameters
|
9466
|
+
|
9467
|
+
This endpoint does not need any parameter.
|
9468
|
+
|
9469
|
+
### Return type
|
9470
|
+
|
9471
|
+
[**ScimResourceTypesListResponse**](ScimResourceTypesListResponse.md)
|
9472
|
+
|
9473
|
+
### Authorization
|
9474
|
+
|
9475
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9476
|
+
|
9477
|
+
### HTTP request headers
|
9478
|
+
|
9479
|
+
- **Content-Type**: Not defined
|
9480
|
+
- **Accept**: application/json
|
9481
|
+
|
9482
|
+
|
9483
|
+
## scim_get_schemas
|
9484
|
+
|
9485
|
+
> ScimSchemasListResponse scim_get_schemas
|
9486
|
+
|
9487
|
+
List supported SCIM schemas
|
9488
|
+
|
9489
|
+
Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.
|
9490
|
+
|
9491
|
+
### Example
|
9492
|
+
|
9493
|
+
```ruby
|
9494
|
+
# load the gem
|
9495
|
+
require 'talon_one'
|
9496
|
+
# setup authorization
|
9497
|
+
TalonOne.configure do |config|
|
9498
|
+
# Configure API key authorization: management_key
|
9499
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9500
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9501
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9502
|
+
|
9503
|
+
# Configure API key authorization: manager_auth
|
9504
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9505
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9506
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9507
|
+
end
|
9508
|
+
|
9509
|
+
api_instance = TalonOne::ManagementApi.new
|
9510
|
+
|
9511
|
+
begin
|
9512
|
+
#List supported SCIM schemas
|
9513
|
+
result = api_instance.scim_get_schemas
|
9514
|
+
p result
|
9515
|
+
rescue TalonOne::ApiError => e
|
9516
|
+
puts "Exception when calling ManagementApi->scim_get_schemas: #{e}"
|
9517
|
+
end
|
9518
|
+
```
|
9519
|
+
|
9520
|
+
### Parameters
|
9521
|
+
|
9522
|
+
This endpoint does not need any parameter.
|
9523
|
+
|
9524
|
+
### Return type
|
9525
|
+
|
9526
|
+
[**ScimSchemasListResponse**](ScimSchemasListResponse.md)
|
9527
|
+
|
9528
|
+
### Authorization
|
9529
|
+
|
9530
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9531
|
+
|
9532
|
+
### HTTP request headers
|
9533
|
+
|
9534
|
+
- **Content-Type**: Not defined
|
9535
|
+
- **Accept**: application/json
|
9536
|
+
|
9537
|
+
|
9538
|
+
## scim_get_service_provider_config
|
9539
|
+
|
9540
|
+
> ScimServiceProviderConfigResponse scim_get_service_provider_config
|
9541
|
+
|
9542
|
+
Get SCIM service provider configuration
|
9543
|
+
|
9544
|
+
Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.
|
9545
|
+
|
9546
|
+
### Example
|
9547
|
+
|
9548
|
+
```ruby
|
9549
|
+
# load the gem
|
9550
|
+
require 'talon_one'
|
9551
|
+
# setup authorization
|
9552
|
+
TalonOne.configure do |config|
|
9553
|
+
# Configure API key authorization: management_key
|
9554
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9555
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9556
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9557
|
+
|
9558
|
+
# Configure API key authorization: manager_auth
|
9559
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9560
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9561
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9562
|
+
end
|
9563
|
+
|
9564
|
+
api_instance = TalonOne::ManagementApi.new
|
9565
|
+
|
9566
|
+
begin
|
9567
|
+
#Get SCIM service provider configuration
|
9568
|
+
result = api_instance.scim_get_service_provider_config
|
9569
|
+
p result
|
9570
|
+
rescue TalonOne::ApiError => e
|
9571
|
+
puts "Exception when calling ManagementApi->scim_get_service_provider_config: #{e}"
|
9572
|
+
end
|
9573
|
+
```
|
9574
|
+
|
9575
|
+
### Parameters
|
9576
|
+
|
9577
|
+
This endpoint does not need any parameter.
|
9578
|
+
|
9579
|
+
### Return type
|
9580
|
+
|
9581
|
+
[**ScimServiceProviderConfigResponse**](ScimServiceProviderConfigResponse.md)
|
9582
|
+
|
9583
|
+
### Authorization
|
9584
|
+
|
9585
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9586
|
+
|
9587
|
+
### HTTP request headers
|
9588
|
+
|
9589
|
+
- **Content-Type**: Not defined
|
9590
|
+
- **Accept**: application/json
|
9591
|
+
|
9592
|
+
|
9593
|
+
## scim_get_user
|
9594
|
+
|
9595
|
+
> ScimUser scim_get_user(user_id)
|
9596
|
+
|
9597
|
+
Get SCIM user
|
9598
|
+
|
9599
|
+
Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
9600
|
+
|
9601
|
+
### Example
|
9602
|
+
|
9603
|
+
```ruby
|
9604
|
+
# load the gem
|
9605
|
+
require 'talon_one'
|
9606
|
+
# setup authorization
|
9607
|
+
TalonOne.configure do |config|
|
9608
|
+
# Configure API key authorization: management_key
|
9609
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9610
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9611
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9612
|
+
|
9613
|
+
# Configure API key authorization: manager_auth
|
9614
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9615
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9616
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9617
|
+
end
|
9618
|
+
|
9619
|
+
api_instance = TalonOne::ManagementApi.new
|
9620
|
+
user_id = 56 # Integer | The ID of the user.
|
9621
|
+
|
9622
|
+
begin
|
9623
|
+
#Get SCIM user
|
9624
|
+
result = api_instance.scim_get_user(user_id)
|
9625
|
+
p result
|
9626
|
+
rescue TalonOne::ApiError => e
|
9627
|
+
puts "Exception when calling ManagementApi->scim_get_user: #{e}"
|
9628
|
+
end
|
9629
|
+
```
|
9630
|
+
|
9631
|
+
### Parameters
|
9632
|
+
|
9633
|
+
|
9634
|
+
Name | Type | Description | Notes
|
9635
|
+
------------- | ------------- | ------------- | -------------
|
9636
|
+
**user_id** | **Integer**| The ID of the user. |
|
9637
|
+
|
9638
|
+
### Return type
|
9639
|
+
|
9640
|
+
[**ScimUser**](ScimUser.md)
|
9641
|
+
|
9642
|
+
### Authorization
|
9643
|
+
|
9644
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9645
|
+
|
9646
|
+
### HTTP request headers
|
9647
|
+
|
9648
|
+
- **Content-Type**: Not defined
|
9649
|
+
- **Accept**: application/json
|
9650
|
+
|
9651
|
+
|
9652
|
+
## scim_get_users
|
9653
|
+
|
9654
|
+
> ScimUsersListResponse scim_get_users
|
9655
|
+
|
9656
|
+
List SCIM users
|
9657
|
+
|
9658
|
+
Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
|
9659
|
+
|
9660
|
+
### Example
|
9661
|
+
|
9662
|
+
```ruby
|
9663
|
+
# load the gem
|
9664
|
+
require 'talon_one'
|
9665
|
+
# setup authorization
|
9666
|
+
TalonOne.configure do |config|
|
9667
|
+
# Configure API key authorization: management_key
|
9668
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9670
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9671
|
+
|
9672
|
+
# Configure API key authorization: manager_auth
|
9673
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9674
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9675
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9676
|
+
end
|
9677
|
+
|
9678
|
+
api_instance = TalonOne::ManagementApi.new
|
9679
|
+
|
9680
|
+
begin
|
9681
|
+
#List SCIM users
|
9682
|
+
result = api_instance.scim_get_users
|
9683
|
+
p result
|
9684
|
+
rescue TalonOne::ApiError => e
|
9685
|
+
puts "Exception when calling ManagementApi->scim_get_users: #{e}"
|
9686
|
+
end
|
9687
|
+
```
|
9688
|
+
|
9689
|
+
### Parameters
|
9690
|
+
|
9691
|
+
This endpoint does not need any parameter.
|
9692
|
+
|
9693
|
+
### Return type
|
9694
|
+
|
9695
|
+
[**ScimUsersListResponse**](ScimUsersListResponse.md)
|
9696
|
+
|
9697
|
+
### Authorization
|
9698
|
+
|
9699
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9700
|
+
|
9701
|
+
### HTTP request headers
|
9702
|
+
|
9703
|
+
- **Content-Type**: Not defined
|
9704
|
+
- **Accept**: application/json
|
9705
|
+
|
9706
|
+
|
9707
|
+
## scim_patch_user
|
9708
|
+
|
9709
|
+
> ScimUser scim_patch_user(user_id, body)
|
9710
|
+
|
9711
|
+
Update SCIM user attributes
|
9712
|
+
|
9713
|
+
Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
9714
|
+
|
9715
|
+
### Example
|
9716
|
+
|
9717
|
+
```ruby
|
9718
|
+
# load the gem
|
9719
|
+
require 'talon_one'
|
9720
|
+
# setup authorization
|
9721
|
+
TalonOne.configure do |config|
|
9722
|
+
# Configure API key authorization: management_key
|
9723
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9724
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9725
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9726
|
+
|
9727
|
+
# Configure API key authorization: manager_auth
|
9728
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9729
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9730
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9731
|
+
end
|
9732
|
+
|
9733
|
+
api_instance = TalonOne::ManagementApi.new
|
9734
|
+
user_id = 56 # Integer | The ID of the user.
|
9735
|
+
body = TalonOne::ScimPatchRequest.new # ScimPatchRequest | body
|
9736
|
+
|
9737
|
+
begin
|
9738
|
+
#Update SCIM user attributes
|
9739
|
+
result = api_instance.scim_patch_user(user_id, body)
|
9740
|
+
p result
|
9741
|
+
rescue TalonOne::ApiError => e
|
9742
|
+
puts "Exception when calling ManagementApi->scim_patch_user: #{e}"
|
9743
|
+
end
|
9744
|
+
```
|
9745
|
+
|
9746
|
+
### Parameters
|
9747
|
+
|
9748
|
+
|
9749
|
+
Name | Type | Description | Notes
|
9750
|
+
------------- | ------------- | ------------- | -------------
|
9751
|
+
**user_id** | **Integer**| The ID of the user. |
|
9752
|
+
**body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body |
|
9753
|
+
|
9754
|
+
### Return type
|
9755
|
+
|
9756
|
+
[**ScimUser**](ScimUser.md)
|
9757
|
+
|
9758
|
+
### Authorization
|
9759
|
+
|
9760
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9761
|
+
|
9762
|
+
### HTTP request headers
|
9763
|
+
|
9764
|
+
- **Content-Type**: application/json
|
9765
|
+
- **Accept**: application/json
|
9766
|
+
|
9767
|
+
|
9768
|
+
## scim_replace_user_attributes
|
9769
|
+
|
9770
|
+
> ScimUser scim_replace_user_attributes(user_id, body)
|
9771
|
+
|
9772
|
+
Update SCIM user
|
9773
|
+
|
9774
|
+
Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
9775
|
+
|
9776
|
+
### Example
|
9777
|
+
|
9778
|
+
```ruby
|
9779
|
+
# load the gem
|
9780
|
+
require 'talon_one'
|
9781
|
+
# setup authorization
|
9782
|
+
TalonOne.configure do |config|
|
9783
|
+
# Configure API key authorization: management_key
|
9784
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9785
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9786
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9787
|
+
|
9788
|
+
# Configure API key authorization: manager_auth
|
9789
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9790
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9791
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9792
|
+
end
|
9793
|
+
|
9794
|
+
api_instance = TalonOne::ManagementApi.new
|
9795
|
+
user_id = 56 # Integer | The ID of the user.
|
9796
|
+
body = TalonOne::ScimNewUser.new # ScimNewUser | body
|
9797
|
+
|
9798
|
+
begin
|
9799
|
+
#Update SCIM user
|
9800
|
+
result = api_instance.scim_replace_user_attributes(user_id, body)
|
9801
|
+
p result
|
9802
|
+
rescue TalonOne::ApiError => e
|
9803
|
+
puts "Exception when calling ManagementApi->scim_replace_user_attributes: #{e}"
|
9804
|
+
end
|
9805
|
+
```
|
9806
|
+
|
9807
|
+
### Parameters
|
9808
|
+
|
9809
|
+
|
9810
|
+
Name | Type | Description | Notes
|
9811
|
+
------------- | ------------- | ------------- | -------------
|
9812
|
+
**user_id** | **Integer**| The ID of the user. |
|
9813
|
+
**body** | [**ScimNewUser**](ScimNewUser.md)| body |
|
9814
|
+
|
9815
|
+
### Return type
|
9816
|
+
|
9817
|
+
[**ScimUser**](ScimUser.md)
|
9818
|
+
|
9819
|
+
### Authorization
|
9820
|
+
|
9821
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9822
|
+
|
9823
|
+
### HTTP request headers
|
9824
|
+
|
9825
|
+
- **Content-Type**: application/json
|
9826
|
+
- **Accept**: application/json
|
9827
|
+
|
9828
|
+
|
8928
9829
|
## search_coupons_advanced_application_wide_without_total_count
|
8929
9830
|
|
8930
9831
|
> InlineResponse2009 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
@@ -8964,10 +9865,10 @@ opts = {
|
|
8964
9865
|
valid: 'valid_example', # String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
8965
9866
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
8966
9867
|
referral_id: 56, # Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
8967
|
-
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile
|
9868
|
+
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
8968
9869
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
8969
|
-
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
8970
|
-
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
9870
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
|
9871
|
+
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
8971
9872
|
}
|
8972
9873
|
|
8973
9874
|
begin
|
@@ -8995,10 +9896,10 @@ Name | Type | Description | Notes
|
|
8995
9896
|
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
|
8996
9897
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
8997
9898
|
**referral_id** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
|
8998
|
-
**recipient_integration_id** | **String**| Filter results by match with a profile
|
9899
|
+
**recipient_integration_id** | **String**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional]
|
8999
9900
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
9000
|
-
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
9001
|
-
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
9901
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
|
9902
|
+
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
9002
9903
|
|
9003
9904
|
### Return type
|
9004
9905
|
|
@@ -9054,8 +9955,8 @@ opts = {
|
|
9054
9955
|
valid: 'valid_example', # String | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
9055
9956
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
9056
9957
|
referral_id: 56, # Integer | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
9057
|
-
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile
|
9058
|
-
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
9958
|
+
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
9959
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code.
|
9059
9960
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
9060
9961
|
}
|
9061
9962
|
|
@@ -9085,8 +9986,8 @@ Name | Type | Description | Notes
|
|
9085
9986
|
**valid** | **String**| Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | [optional]
|
9086
9987
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
9087
9988
|
**referral_id** | **Integer**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional]
|
9088
|
-
**recipient_integration_id** | **String**| Filter results by match with a profile
|
9089
|
-
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
9989
|
+
**recipient_integration_id** | **String**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional]
|
9990
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to false]
|
9090
9991
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
9091
9992
|
|
9092
9993
|
### Return type
|
@@ -9419,7 +10320,7 @@ Name | Type | Description | Notes
|
|
9419
10320
|
|
9420
10321
|
Update campaign
|
9421
10322
|
|
9422
|
-
Update the given campaign.
|
10323
|
+
Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application.
|
9423
10324
|
|
9424
10325
|
### Example
|
9425
10326
|
|
@@ -9547,7 +10448,7 @@ Name | Type | Description | Notes
|
|
9547
10448
|
|
9548
10449
|
Update coupon
|
9549
10450
|
|
9550
|
-
Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint
|
10451
|
+
Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code>, <code>expiryDate</code>, and <code>recipientIntegrationId</code> properties in your request, it is automatically set to <code>null</code>.</p> </div>
|
9551
10452
|
|
9552
10453
|
### Example
|
9553
10454
|
|
@@ -9612,7 +10513,7 @@ Name | Type | Description | Notes
|
|
9612
10513
|
|
9613
10514
|
Update coupons
|
9614
10515
|
|
9615
|
-
Update all coupons
|
10516
|
+
Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.</li> <li>With this <code>PUT</code> endpoint, if you do not explicitly set a value for the <code>startDate</code> and <code>expiryDate</code> properties in your request, it is automatically set to <code>null</code>.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
|
9616
10517
|
|
9617
10518
|
### Example
|
9618
10519
|
|