talon_one 6.0.0 → 8.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 +563 -562
- data/docker-compose.yml +47 -0
- data/docs/AccountAnalytics.md +1 -1
- data/docs/Achievement.md +14 -4
- data/docs/AchievementAdditionalProperties.md +5 -3
- data/docs/AchievementProgress.md +3 -15
- data/docs/AddFreeItemEffectProps.md +3 -1
- data/docs/AdditionalCampaignProperties.md +5 -3
- data/docs/AnalyticsProduct.md +23 -0
- data/docs/AnalyticsProductSKU.md +21 -0
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCampaignStats.md +2 -0
- data/docs/ApplicationCustomer.md +8 -8
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +4 -4
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseLoyaltyProgram.md +3 -1
- data/docs/Binding.md +1 -1
- data/docs/BulkOperationOnCampaigns.md +3 -1
- data/docs/Campaign.md +7 -3
- data/docs/CampaignEvaluationGroup.md +1 -1
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +3 -1
- data/docs/CampaignTemplateCouponReservationSettings.md +19 -0
- data/docs/CampaignVersions.md +3 -1
- data/docs/CardExpiringPointsNotificationPolicy.md +3 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/Change.md +1 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionFilters.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponsNotificationPolicy.md +5 -1
- data/docs/CreateAchievement.md +10 -2
- data/docs/CustomerInventory.md +1 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileAudienceRequestItem.md +1 -1
- data/docs/CustomerSession.md +2 -2
- data/docs/CustomerSessionV2.md +8 -8
- data/docs/Environment.md +1 -1
- data/docs/Event.md +1 -1
- data/docs/ExpiringCouponsNotificationPolicy.md +3 -1
- data/docs/ExpiringPointsNotificationPolicy.md +3 -1
- data/docs/FeatureFlag.md +1 -1
- data/docs/GenerateCampaignDescription.md +2 -2
- data/docs/GenerateCampaignTags.md +2 -2
- data/docs/GenerateLoyaltyCard.md +3 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +3 -3
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +3 -5
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +3 -3
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +3 -5
- data/docs/InlineResponse20023.md +3 -5
- data/docs/InlineResponse20024.md +4 -4
- data/docs/InlineResponse20025.md +4 -2
- data/docs/InlineResponse20026.md +4 -2
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +3 -3
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +2 -4
- data/docs/InlineResponse20031.md +3 -3
- data/docs/InlineResponse20032.md +3 -1
- data/docs/InlineResponse20033.md +1 -3
- data/docs/InlineResponse20034.md +3 -3
- data/docs/InlineResponse20035.md +1 -1
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +5 -3
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +2 -4
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +4 -2
- data/docs/InlineResponse20045.md +3 -5
- data/docs/InlineResponse20046.md +3 -3
- data/docs/InlineResponse20047.md +5 -3
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +3 -3
- data/docs/IntegrationApi.md +164 -26
- data/docs/IntegrationCustomerSessionResponse.md +1 -1
- data/docs/LedgerInfo.md +6 -2
- data/docs/LimitCounter.md +1 -1
- data/docs/ListCampaignStoreBudgets.md +23 -0
- data/docs/ListCampaignStoreBudgetsStore.md +21 -0
- data/docs/LoyaltyBalance.md +3 -1
- data/docs/LoyaltyBalanceWithTier.md +2 -0
- data/docs/LoyaltyBalances.md +1 -1
- data/docs/LoyaltyBalancesWithTiers.md +1 -1
- data/docs/LoyaltyCard.md +4 -0
- data/docs/LoyaltyCardBalances.md +1 -1
- data/docs/LoyaltyCardBatch.md +3 -1
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +5 -3
- data/docs/LoyaltyProgramBalance.md +7 -3
- data/docs/LoyaltyProgramEntity.md +5 -1
- data/docs/LoyaltySubLedger.md +2 -0
- data/docs/LoyaltyTier.md +6 -2
- data/docs/ManagementApi.md +244 -250
- data/docs/ManagementKey.md +3 -1
- data/docs/MessageLogEntry.md +10 -2
- data/docs/ModelReturn.md +1 -1
- data/docs/NewAudience.md +1 -1
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewCampaignStoreBudget.md +21 -0
- data/docs/NewCampaignStoreBudgetStoreLimit.md +19 -0
- data/docs/NewCampaignTemplate.md +2 -0
- data/docs/NewCustomerSessionV2.md +4 -4
- data/docs/NewLoyaltyProgram.md +2 -0
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewManagementKey.md +2 -0
- data/docs/NewPicklist.md +1 -1
- data/docs/NewWebhook.md +1 -1
- data/docs/PendingPointsNotificationPolicy.md +3 -1
- 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 +19 -0
- data/docs/ScimNewUser.md +1 -1
- data/docs/ScimServiceProviderConfigResponse.md +3 -1
- data/docs/ScimServiceProviderConfigResponseSort.md +17 -0
- data/docs/ScimUser.md +1 -1
- data/docs/Store.md +3 -3
- data/docs/StrikethroughDebugResponse.md +19 -0
- data/docs/StrikethroughEffect.md +5 -1
- data/docs/StrikethroughLabelingNotification.md +4 -2
- data/docs/SummaryCampaignStoreBudget.md +23 -0
- data/docs/TemplateArgDef.md +2 -0
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeNotificationPolicy.md +3 -1
- data/docs/TierUpgradeNotificationPolicy.md +3 -1
- data/docs/TierWillDowngradeNotificationPolicy.md +2 -0
- data/docs/UpdateAchievement.md +11 -3
- data/docs/UpdateCampaignTemplate.md +2 -0
- data/docs/UpdateLoyaltyProgram.md +2 -0
- data/docs/UpdateLoyaltyProgramTier.md +21 -0
- data/docs/UpdatePicklist.md +1 -1
- data/docs/User.md +2 -2
- data/docs/ValueMap.md +23 -0
- data/docs/Webhook.md +1 -1
- data/docs/WebhookLogEntry.md +1 -1
- data/docs/WebhookWithOutgoingIntegrationDetails.md +1 -1
- data/lib/talon_one/api/integration_api.rb +233 -42
- data/lib/talon_one/api/management_api.rb +323 -333
- 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 +113 -16
- data/lib/talon_one/models/achievement_additional_properties.rb +49 -10
- data/lib/talon_one/models/achievement_progress.rb +4 -137
- data/lib/talon_one/models/add_free_item_effect_props.rb +14 -4
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +19 -12
- data/lib/talon_one/models/analytics_product.rb +251 -0
- data/lib/talon_one/models/analytics_product_sku.rb +242 -0
- data/lib/talon_one/models/application.rb +0 -1
- data/lib/talon_one/models/application_api_key.rb +2 -3
- data/lib/talon_one/models/application_campaign_analytics.rb +2 -2
- data/lib/talon_one/models/application_campaign_stats.rb +16 -1
- data/lib/talon_one/models/application_cif.rb +1 -2
- data/lib/talon_one/models/application_cif_expression.rb +1 -2
- data/lib/talon_one/models/application_customer.rb +4 -5
- data/lib/talon_one/models/application_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -2
- data/lib/talon_one/models/application_referee.rb +1 -2
- data/lib/talon_one/models/application_session.rb +3 -4
- data/lib/talon_one/models/async_coupon_deletion_job_response.rb +0 -1
- data/lib/talon_one/models/attribute.rb +0 -1
- data/lib/talon_one/models/audience.rb +1 -2
- data/lib/talon_one/models/audience_customer.rb +1 -2
- data/lib/talon_one/models/base_loyalty_program.rb +26 -4
- data/lib/talon_one/models/base_notification.rb +0 -1
- 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 +39 -11
- 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_without_payload.rb +0 -1
- data/lib/talon_one/models/campaign_evaluation_group.rb +1 -2
- data/lib/talon_one/models/campaign_group.rb +0 -1
- data/lib/talon_one/models/campaign_notification_policy.rb +14 -4
- data/lib/talon_one/models/campaign_set.rb +1 -2
- data/lib/talon_one/models/campaign_store_budget.rb +1 -2
- 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 +45 -1
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +14 -4
- 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/catalog.rb +0 -1
- data/lib/talon_one/models/catalog_item.rb +0 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +38 -4
- data/lib/talon_one/models/change.rb +0 -1
- data/lib/talon_one/models/code_generator_settings.rb +11 -0
- 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 +0 -1
- data/lib/talon_one/models/coupon_creation_job.rb +1 -2
- data/lib/talon_one/models/coupon_deletion_filters.rb +0 -2
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -2
- data/lib/talon_one/models/coupons_notification_policy.rb +24 -4
- data/lib/talon_one/models/create_achievement.rb +90 -9
- data/lib/talon_one/models/create_application_api_key.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +0 -1
- data/lib/talon_one/models/customer_inventory.rb +1 -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 +1 -2
- data/lib/talon_one/models/customer_session_v2.rb +7 -7
- 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 +1 -1
- data/lib/talon_one/models/environment.rb +1 -2
- data/lib/talon_one/models/event.rb +1 -2
- 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/expiring_coupons_notification_policy.rb +14 -4
- data/lib/talon_one/models/expiring_points_notification_policy.rb +14 -4
- 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 +11 -11
- data/lib/talon_one/models/generate_campaign_tags.rb +11 -11
- data/lib/talon_one/models/generate_loyalty_card.rb +40 -4
- data/lib/talon_one/models/giveaway.rb +0 -1
- data/lib/talon_one/models/import.rb +0 -1
- data/lib/talon_one/models/inline_response2001.rb +11 -11
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -11
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +1 -1
- data/lib/talon_one/models/inline_response20014.rb +1 -1
- data/lib/talon_one/models/inline_response20015.rb +11 -11
- data/lib/talon_one/models/inline_response20016.rb +11 -13
- data/lib/talon_one/models/inline_response20017.rb +7 -11
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +3 -1
- data/lib/talon_one/models/inline_response2002.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +11 -7
- data/lib/talon_one/models/inline_response20021.rb +11 -11
- data/lib/talon_one/models/inline_response20022.rb +7 -11
- data/lib/talon_one/models/inline_response20023.rb +7 -11
- data/lib/talon_one/models/inline_response20024.rb +11 -11
- data/lib/talon_one/models/inline_response20025.rb +11 -7
- data/lib/talon_one/models/inline_response20026.rb +11 -7
- data/lib/talon_one/models/inline_response20027.rb +6 -1
- data/lib/talon_one/models/inline_response20028.rb +1 -1
- data/lib/talon_one/models/inline_response20029.rb +8 -13
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +7 -11
- data/lib/talon_one/models/inline_response20031.rb +13 -8
- data/lib/talon_one/models/inline_response20032.rb +11 -2
- data/lib/talon_one/models/inline_response20033.rb +2 -11
- data/lib/talon_one/models/inline_response20034.rb +8 -13
- data/lib/talon_one/models/inline_response20035.rb +1 -1
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +11 -7
- 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_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +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 +7 -11
- data/lib/talon_one/models/inline_response20046.rb +13 -8
- data/lib/talon_one/models/inline_response20047.rb +11 -7
- data/lib/talon_one/models/inline_response2005.rb +11 -11
- data/lib/talon_one/models/inline_response2006.rb +11 -11
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +11 -11
- data/lib/talon_one/models/integration_coupon.rb +0 -1
- 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 +0 -1
- data/lib/talon_one/models/inventory_referral.rb +0 -1
- 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 +34 -4
- data/lib/talon_one/models/library_attribute.rb +0 -1
- data/lib/talon_one/models/limit_counter.rb +1 -2
- 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.rb +14 -4
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +12 -2
- data/lib/talon_one/models/loyalty_card.rb +54 -2
- data/lib/talon_one/models/loyalty_card_balances.rb +1 -1
- data/lib/talon_one/models/loyalty_card_batch.rb +13 -5
- data/lib/talon_one/models/loyalty_ledger_entry.rb +13 -4
- data/lib/talon_one/models/loyalty_program.rb +25 -3
- data/lib/talon_one/models/loyalty_program_balance.rb +36 -6
- 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_sub_ledger.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +24 -4
- data/lib/talon_one/models/management_key.rb +14 -5
- data/lib/talon_one/models/message_log_entry.rb +67 -7
- data/lib/talon_one/models/model_return.rb +1 -2
- 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_application_api_key.rb +2 -3
- data/lib/talon_one/models/new_attribute.rb +0 -1
- data/lib/talon_one/models/new_audience.rb +1 -2
- data/lib/talon_one/models/new_base_notification.rb +0 -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 +1 -2
- 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 +0 -1
- data/lib/talon_one/models/new_coupons.rb +0 -1
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +0 -1
- 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 +24 -2
- data/lib/talon_one/models/new_loyalty_tier.rb +2 -2
- data/lib/talon_one/models/new_management_key.rb +11 -2
- data/lib/talon_one/models/new_multiple_audiences_item.rb +0 -1
- data/lib/talon_one/models/new_referral.rb +0 -1
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +0 -1
- 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 +1 -2
- data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +0 -1
- data/lib/talon_one/models/pending_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/picklist.rb +0 -1
- data/lib/talon_one/models/product.rb +1 -20
- data/lib/talon_one/models/product_search_match.rb +232 -0
- data/lib/talon_one/models/product_sku_unit_analytics.rb +256 -0
- data/lib/talon_one/models/product_unit_analytics.rb +227 -0
- data/lib/talon_one/models/referral.rb +0 -1
- data/lib/talon_one/models/revision.rb +0 -1
- data/lib/talon_one/models/revision_version.rb +0 -1
- 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/ruleset.rb +0 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_new_user.rb +5 -0
- data/lib/talon_one/models/scim_service_provider_config_response.rb +13 -4
- data/lib/talon_one/models/scim_service_provider_config_response_sort.rb +208 -0
- data/lib/talon_one/models/scim_user.rb +5 -0
- data/lib/talon_one/models/store.rb +2 -3
- data/lib/talon_one/models/strikethrough_debug_response.rb +221 -0
- data/lib/talon_one/models/strikethrough_effect.rb +24 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +46 -2
- data/lib/talon_one/models/summary_campaign_store_budget.rb +294 -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 +1 -2
- data/lib/talon_one/models/template_limit_config.rb +0 -1
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +11 -1
- data/lib/talon_one/models/transfer_loyalty_card.rb +11 -0
- data/lib/talon_one/models/update_achievement.rb +92 -6
- 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 +0 -1
- data/lib/talon_one/models/update_coupon_batch.rb +0 -1
- data/lib/talon_one/models/update_loyalty_program.rb +24 -2
- 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/user.rb +0 -1
- data/lib/talon_one/models/value_map.rb +245 -0
- data/lib/talon_one/models/webhook.rb +1 -2
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +1 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +30 -5
- data/spec/api/integration_api_spec.rb +50 -14
- data/spec/api/management_api_spec.rb +106 -109
- data/spec/models/achievement_additional_properties_spec.rb +10 -0
- data/spec/models/achievement_base_spec.rb +103 -0
- data/spec/models/achievement_progress_spec.rb +1 -37
- data/spec/models/achievement_progress_with_definition_spec.rb +137 -0
- data/spec/models/achievement_spec.rb +42 -0
- data/spec/models/achievement_status_entry_spec.rb +137 -0
- data/spec/models/add_free_item_effect_props_spec.rb +6 -0
- data/spec/models/additional_campaign_properties_spec.rb +7 -1
- data/spec/models/analytics_product_sku_spec.rb +53 -0
- data/spec/models/analytics_product_spec.rb +59 -0
- data/spec/models/analytics_sku_spec.rb +59 -0
- data/spec/models/application_api_key_spec.rb +1 -1
- data/spec/models/application_campaign_analytics_spec.rb +1 -1
- data/spec/models/application_campaign_stats_spec.rb +6 -0
- data/spec/models/application_cif_references_spec.rb +47 -0
- data/spec/models/base_loyalty_program_spec.rb +10 -0
- data/spec/models/bulk_operation_on_campaigns_spec.rb +7 -1
- data/spec/models/campaign_detail_spec.rb +47 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +17 -1
- data/spec/models/campaign_store_budget_limit_config_spec.rb +73 -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 +10 -0
- data/spec/models/card_expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupons_notification_policy_spec.rb +12 -0
- data/spec/models/create_achievement_spec.rb +32 -0
- data/spec/models/create_application_api_key_spec.rb +1 -1
- data/spec/models/expiring_coupons_notification_policy_spec.rb +6 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/generate_campaign_description_spec.rb +1 -1
- data/spec/models/generate_campaign_tags_spec.rb +1 -1
- data/spec/models/generate_loyalty_card_spec.rb +6 -0
- data/spec/models/hidden_conditions_effects_spec.rb +59 -0
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +0 -6
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +6 -0
- data/spec/models/inline_response20021_spec.rb +1 -1
- data/spec/models/inline_response20022_spec.rb +0 -6
- data/spec/models/inline_response20023_spec.rb +0 -6
- data/spec/models/inline_response20024_spec.rb +2 -2
- data/spec/models/inline_response20025_spec.rb +6 -0
- data/spec/models/inline_response20026_spec.rb +6 -0
- data/spec/models/inline_response20029_spec.rb +1 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +0 -6
- data/spec/models/inline_response20031_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/inline_response20037_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/inline_response20046_spec.rb +1 -1
- data/spec/models/inline_response20047_spec.rb +6 -0
- data/spec/models/inline_response20048_spec.rb +47 -0
- data/spec/models/inline_response20049_spec.rb +47 -0
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +12 -0
- 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_spec.rb +6 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +6 -0
- data/spec/models/loyalty_card_batch_spec.rb +6 -0
- data/spec/models/loyalty_card_spec.rb +12 -0
- data/spec/models/loyalty_ledger_entry_flags_spec.rb +41 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
- data/spec/models/loyalty_program_balance_spec.rb +12 -0
- data/spec/models/loyalty_program_entity_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +10 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +6 -0
- data/spec/models/loyalty_tier_spec.rb +12 -0
- data/spec/models/management_key_spec.rb +6 -0
- data/spec/models/message_log_entry_spec.rb +25 -1
- data/spec/models/message_test_spec.rb +47 -0
- data/spec/models/new_application_api_key_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_loyalty_program_spec.rb +10 -0
- data/spec/models/new_management_key_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +79 -0
- data/spec/models/pending_points_notification_policy_spec.rb +6 -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_data_point_spec.rb +65 -0
- data/spec/models/product_unit_analytics_spec.rb +47 -0
- data/spec/models/product_unit_analytics_totals_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 +6 -0
- data/spec/models/sku_unit_analytics_data_point_spec.rb +59 -0
- data/spec/models/sku_unit_analytics_spec.rb +47 -0
- data/spec/models/strikethrough_debug_response_spec.rb +47 -0
- data/spec/models/strikethrough_effect_spec.rb +12 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +10 -0
- data/spec/models/summary_campaign_store_budget_spec.rb +67 -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_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_upgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_will_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +32 -0
- data/spec/models/update_campaign_template_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +10 -0
- data/spec/models/update_loyalty_program_tier_spec.rb +53 -0
- data/spec/models/value_map_spec.rb +59 -0
- metadata +481 -6
@@ -21,7 +21,7 @@ module TalonOne
|
|
21
21
|
end
|
22
22
|
# Enable user by email address
|
23
23
|
# Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
24
|
-
# @param body [
|
24
|
+
# @param body [DeactivateUserRequest] body
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
27
27
|
def activate_user_by_email(body, opts = {})
|
@@ -31,7 +31,7 @@ module TalonOne
|
|
31
31
|
|
32
32
|
# Enable user by email address
|
33
33
|
# Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
34
|
-
# @param body [
|
34
|
+
# @param body [DeactivateUserRequest] body
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
37
|
def activate_user_by_email_with_http_info(body, opts = {})
|
@@ -164,7 +164,7 @@ module TalonOne
|
|
164
164
|
# Add points to customer profile
|
165
165
|
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
166
166
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
167
|
-
# @param integration_id [String] The identifier
|
167
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
168
168
|
# @param body [AddLoyaltyPoints] body
|
169
169
|
# @param [Hash] opts the optional parameters
|
170
170
|
# @return [nil]
|
@@ -176,7 +176,7 @@ module TalonOne
|
|
176
176
|
# Add points to customer profile
|
177
177
|
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
178
178
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
179
|
-
# @param integration_id [String] The identifier
|
179
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
180
180
|
# @param body [AddLoyaltyPoints] body
|
181
181
|
# @param [Hash] opts the optional parameters
|
182
182
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -243,7 +243,7 @@ module TalonOne
|
|
243
243
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
244
244
|
# @param body [CampaignCopy] body
|
245
245
|
# @param [Hash] opts the optional parameters
|
246
|
-
# @return [
|
246
|
+
# @return [InlineResponse2008]
|
247
247
|
def copy_campaign_to_applications(application_id, campaign_id, body, opts = {})
|
248
248
|
data, _status_code, _headers = copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts)
|
249
249
|
data
|
@@ -255,7 +255,7 @@ module TalonOne
|
|
255
255
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
256
256
|
# @param body [CampaignCopy] body
|
257
257
|
# @param [Hash] opts the optional parameters
|
258
|
-
# @return [Array<(
|
258
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
259
259
|
def copy_campaign_to_applications_with_http_info(application_id, campaign_id, body, opts = {})
|
260
260
|
if @api_client.config.debugging
|
261
261
|
@api_client.config.logger.debug 'Calling API: ManagementApi.copy_campaign_to_applications ...'
|
@@ -292,7 +292,7 @@ module TalonOne
|
|
292
292
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
293
293
|
|
294
294
|
# return_type
|
295
|
-
return_type = opts[:return_type] || '
|
295
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
296
296
|
|
297
297
|
# auth_names
|
298
298
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -803,8 +803,8 @@ module TalonOne
|
|
803
803
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
804
804
|
# @param body [NewCoupons] body
|
805
805
|
# @param [Hash] opts the optional parameters
|
806
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
807
|
-
# @return [
|
806
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
807
|
+
# @return [InlineResponse20010]
|
808
808
|
def create_coupons(application_id, campaign_id, body, opts = {})
|
809
809
|
data, _status_code, _headers = create_coupons_with_http_info(application_id, campaign_id, body, opts)
|
810
810
|
data
|
@@ -816,8 +816,8 @@ module TalonOne
|
|
816
816
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
817
817
|
# @param body [NewCoupons] body
|
818
818
|
# @param [Hash] opts the optional parameters
|
819
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
820
|
-
# @return [Array<(
|
819
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
820
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
821
821
|
def create_coupons_with_http_info(application_id, campaign_id, body, opts = {})
|
822
822
|
if @api_client.config.debugging
|
823
823
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons ...'
|
@@ -855,7 +855,7 @@ module TalonOne
|
|
855
855
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
856
856
|
|
857
857
|
# return_type
|
858
|
-
return_type = opts[:return_type] || '
|
858
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
859
859
|
|
860
860
|
# auth_names
|
861
861
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -1034,8 +1034,8 @@ module TalonOne
|
|
1034
1034
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1035
1035
|
# @param body [NewCouponsForMultipleRecipients] body
|
1036
1036
|
# @param [Hash] opts the optional parameters
|
1037
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1038
|
-
# @return [
|
1037
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. (default to 'yes')
|
1038
|
+
# @return [InlineResponse20010]
|
1039
1039
|
def create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts = {})
|
1040
1040
|
data, _status_code, _headers = create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts)
|
1041
1041
|
data
|
@@ -1047,8 +1047,8 @@ module TalonOne
|
|
1047
1047
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1048
1048
|
# @param body [NewCouponsForMultipleRecipients] body
|
1049
1049
|
# @param [Hash] opts the optional parameters
|
1050
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1051
|
-
# @return [Array<(
|
1050
|
+
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
1051
|
+
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
1052
1052
|
def create_coupons_for_multiple_recipients_with_http_info(application_id, campaign_id, body, opts = {})
|
1053
1053
|
if @api_client.config.debugging
|
1054
1054
|
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_for_multiple_recipients ...'
|
@@ -1086,7 +1086,7 @@ module TalonOne
|
|
1086
1086
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
1087
1087
|
|
1088
1088
|
# return_type
|
1089
|
-
return_type = opts[:return_type] || '
|
1089
|
+
return_type = opts[:return_type] || 'InlineResponse20010'
|
1090
1090
|
|
1091
1091
|
# auth_names
|
1092
1092
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -1939,7 +1939,7 @@ module TalonOne
|
|
1939
1939
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1940
1940
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
1941
1941
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
1942
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
1942
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field.
|
1943
1943
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
1944
1944
|
# @return [nil]
|
1945
1945
|
def delete_coupons(application_id, campaign_id, opts = {})
|
@@ -1963,7 +1963,7 @@ module TalonOne
|
|
1963
1963
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1964
1964
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
1965
1965
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
1966
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
1966
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field.
|
1967
1967
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1968
1968
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1969
1969
|
def delete_coupons_with_http_info(application_id, campaign_id, opts = {})
|
@@ -2310,7 +2310,7 @@ module TalonOne
|
|
2310
2310
|
|
2311
2311
|
# Delete user by email address
|
2312
2312
|
# [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
|
2313
|
-
# @param body [
|
2313
|
+
# @param body [DeactivateUserRequest] body
|
2314
2314
|
# @param [Hash] opts the optional parameters
|
2315
2315
|
# @return [nil]
|
2316
2316
|
def delete_user_by_email(body, opts = {})
|
@@ -2320,7 +2320,7 @@ module TalonOne
|
|
2320
2320
|
|
2321
2321
|
# Delete user by email address
|
2322
2322
|
# [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
|
2323
|
-
# @param body [
|
2323
|
+
# @param body [DeactivateUserRequest] body
|
2324
2324
|
# @param [Hash] opts the optional parameters
|
2325
2325
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2326
2326
|
def delete_user_by_email_with_http_info(body, opts = {})
|
@@ -2833,10 +2833,10 @@ module TalonOne
|
|
2833
2833
|
end
|
2834
2834
|
|
2835
2835
|
# Export coupons
|
2836
|
-
# 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.
|
2836
|
+
# 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.
|
2837
2837
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2838
2838
|
# @param [Hash] opts the optional parameters
|
2839
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2839
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2840
2840
|
# @option opts [String] :sort 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.
|
2841
2841
|
# @option opts [String] :value 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.
|
2842
2842
|
# @option opts [DateTime] :created_before 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.
|
@@ -2857,10 +2857,10 @@ module TalonOne
|
|
2857
2857
|
end
|
2858
2858
|
|
2859
2859
|
# Export coupons
|
2860
|
-
# 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.
|
2860
|
+
# 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.
|
2861
2861
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2862
2862
|
# @param [Hash] opts the optional parameters
|
2863
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2863
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2864
2864
|
# @option opts [String] :sort 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.
|
2865
2865
|
# @option opts [String] :value 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.
|
2866
2866
|
# @option opts [DateTime] :created_before 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.
|
@@ -2895,7 +2895,7 @@ module TalonOne
|
|
2895
2895
|
if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
|
2896
2896
|
fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
|
2897
2897
|
end
|
2898
|
-
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
|
2898
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
2899
2899
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
2900
2900
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
2901
2901
|
end
|
@@ -3109,7 +3109,7 @@ module TalonOne
|
|
3109
3109
|
# Download a CSV file containing the triggered effects that match the given attributes. **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: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
|
3110
3110
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3111
3111
|
# @param [Hash] opts the optional parameters
|
3112
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3112
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3113
3113
|
# @option opts [DateTime] :created_before 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.
|
3114
3114
|
# @option opts [DateTime] :created_after 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.
|
3115
3115
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
@@ -3123,7 +3123,7 @@ module TalonOne
|
|
3123
3123
|
# Download a CSV file containing the triggered effects that match the given attributes. **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: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
|
3124
3124
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3125
3125
|
# @param [Hash] opts the optional parameters
|
3126
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3126
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3127
3127
|
# @option opts [DateTime] :created_before 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.
|
3128
3128
|
# @option opts [DateTime] :created_after 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.
|
3129
3129
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
@@ -3476,6 +3476,7 @@ module TalonOne
|
|
3476
3476
|
# @param 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.
|
3477
3477
|
# @param [Hash] opts the optional parameters
|
3478
3478
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
3479
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3479
3480
|
# @return [String]
|
3480
3481
|
def export_loyalty_cards(loyalty_program_id, opts = {})
|
3481
3482
|
data, _status_code, _headers = export_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
@@ -3487,6 +3488,7 @@ module TalonOne
|
|
3487
3488
|
# @param 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.
|
3488
3489
|
# @param [Hash] opts the optional parameters
|
3489
3490
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
3491
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3490
3492
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
3491
3493
|
def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
3492
3494
|
if @api_client.config.debugging
|
@@ -3496,12 +3498,17 @@ module TalonOne
|
|
3496
3498
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
3497
3499
|
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_cards"
|
3498
3500
|
end
|
3501
|
+
allowable_values = ["excel", "ISO8601"]
|
3502
|
+
if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
|
3503
|
+
fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
|
3504
|
+
end
|
3499
3505
|
# resource path
|
3500
3506
|
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/export'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
3501
3507
|
|
3502
3508
|
# query parameters
|
3503
3509
|
query_params = opts[:query_params] || {}
|
3504
3510
|
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
3511
|
+
query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
|
3505
3512
|
|
3506
3513
|
# header parameters
|
3507
3514
|
header_params = opts[:header_params] || {}
|
@@ -3541,7 +3548,7 @@ module TalonOne
|
|
3541
3548
|
# @param 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.
|
3542
3549
|
# @param 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.
|
3543
3550
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3544
|
-
# @param integration_id [String] The identifier
|
3551
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
3545
3552
|
# @param [Hash] opts the optional parameters
|
3546
3553
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3547
3554
|
# @return [String]
|
@@ -3555,7 +3562,7 @@ module TalonOne
|
|
3555
3562
|
# @param 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.
|
3556
3563
|
# @param 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.
|
3557
3564
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3558
|
-
# @param integration_id [String] The identifier
|
3565
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
3559
3566
|
# @param [Hash] opts the optional parameters
|
3560
3567
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3561
3568
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
@@ -3697,7 +3704,7 @@ module TalonOne
|
|
3697
3704
|
# Download a CSV file containing the referrals that match the given parameters. **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: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
|
3698
3705
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3699
3706
|
# @param [Hash] opts the optional parameters
|
3700
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3707
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3701
3708
|
# @option opts [DateTime] :created_before 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.
|
3702
3709
|
# @option opts [DateTime] :created_after 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.
|
3703
3710
|
# @option opts [String] :valid - `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.
|
@@ -3714,7 +3721,7 @@ module TalonOne
|
|
3714
3721
|
# Download a CSV file containing the referrals that match the given parameters. **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: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
|
3715
3722
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3716
3723
|
# @param [Hash] opts the optional parameters
|
3717
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3724
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3718
3725
|
# @option opts [DateTime] :created_before 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.
|
3719
3726
|
# @option opts [DateTime] :created_after 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.
|
3720
3727
|
# @option opts [String] :valid - `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.
|
@@ -3800,7 +3807,7 @@ module TalonOne
|
|
3800
3807
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
3801
3808
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3802
3809
|
# @option opts [String] :sort 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.
|
3803
|
-
# @return [
|
3810
|
+
# @return [InlineResponse20022]
|
3804
3811
|
def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
|
3805
3812
|
data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
|
3806
3813
|
data
|
@@ -3818,7 +3825,7 @@ module TalonOne
|
|
3818
3825
|
# @option opts [Integer] :page_size The number of items in the response.
|
3819
3826
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3820
3827
|
# @option opts [String] :sort 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.
|
3821
|
-
# @return [Array<(
|
3828
|
+
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
3822
3829
|
def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
|
3823
3830
|
if @api_client.config.debugging
|
3824
3831
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_access_logs_without_total_count ...'
|
@@ -3877,7 +3884,7 @@ module TalonOne
|
|
3877
3884
|
post_body = opts[:body]
|
3878
3885
|
|
3879
3886
|
# return_type
|
3880
|
-
return_type = opts[:return_type] || '
|
3887
|
+
return_type = opts[:return_type] || 'InlineResponse20022'
|
3881
3888
|
|
3882
3889
|
# auth_names
|
3883
3890
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4226,7 +4233,7 @@ module TalonOne
|
|
4226
4233
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4227
4234
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4228
4235
|
# @option opts [String] :sort 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.
|
4229
|
-
# @return [
|
4236
|
+
# @return [InlineResponse20038]
|
4230
4237
|
def get_additional_costs(opts = {})
|
4231
4238
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
4232
4239
|
data
|
@@ -4238,7 +4245,7 @@ module TalonOne
|
|
4238
4245
|
# @option opts [Integer] :page_size The number of items in the response.
|
4239
4246
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4240
4247
|
# @option opts [String] :sort 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.
|
4241
|
-
# @return [Array<(
|
4248
|
+
# @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
|
4242
4249
|
def get_additional_costs_with_http_info(opts = {})
|
4243
4250
|
if @api_client.config.debugging
|
4244
4251
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
|
@@ -4272,7 +4279,7 @@ module TalonOne
|
|
4272
4279
|
post_body = opts[:body]
|
4273
4280
|
|
4274
4281
|
# return_type
|
4275
|
-
return_type = opts[:return_type] || '
|
4282
|
+
return_type = opts[:return_type] || 'InlineResponse20038'
|
4276
4283
|
|
4277
4284
|
# auth_names
|
4278
4285
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4293,102 +4300,6 @@ module TalonOne
|
|
4293
4300
|
return data, status_code, headers
|
4294
4301
|
end
|
4295
4302
|
|
4296
|
-
# List access logs
|
4297
|
-
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
4298
|
-
# @param [Hash] opts the optional parameters
|
4299
|
-
# @option opts [DateTime] :range_start 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.
|
4300
|
-
# @option opts [DateTime] :range_end 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.
|
4301
|
-
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
4302
|
-
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
4303
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
4304
|
-
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4305
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4306
|
-
# @option opts [String] :sort 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.
|
4307
|
-
# @return [InlineResponse20020]
|
4308
|
-
def get_all_access_logs(opts = {})
|
4309
|
-
data, _status_code, _headers = get_all_access_logs_with_http_info(opts)
|
4310
|
-
data
|
4311
|
-
end
|
4312
|
-
|
4313
|
-
# List access logs
|
4314
|
-
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
4315
|
-
# @param [Hash] opts the optional parameters
|
4316
|
-
# @option opts [DateTime] :range_start 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.
|
4317
|
-
# @option opts [DateTime] :range_end 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.
|
4318
|
-
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
4319
|
-
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
4320
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
4321
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
4322
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4323
|
-
# @option opts [String] :sort 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.
|
4324
|
-
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
4325
|
-
def get_all_access_logs_with_http_info(opts = {})
|
4326
|
-
if @api_client.config.debugging
|
4327
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...'
|
4328
|
-
end
|
4329
|
-
allowable_values = ["get", "put", "post", "delete", "patch"]
|
4330
|
-
if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method'])
|
4331
|
-
fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}"
|
4332
|
-
end
|
4333
|
-
allowable_values = ["success", "error"]
|
4334
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
4335
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
4336
|
-
end
|
4337
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
4338
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_all_access_logs, must be smaller than or equal to 1000.'
|
4339
|
-
end
|
4340
|
-
|
4341
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
4342
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_all_access_logs, must be greater than or equal to 1.'
|
4343
|
-
end
|
4344
|
-
|
4345
|
-
# resource path
|
4346
|
-
local_var_path = '/v1/access_logs'
|
4347
|
-
|
4348
|
-
# query parameters
|
4349
|
-
query_params = opts[:query_params] || {}
|
4350
|
-
query_params[:'rangeStart'] = opts[:'range_start'] if !opts[:'range_start'].nil?
|
4351
|
-
query_params[:'rangeEnd'] = opts[:'range_end'] if !opts[:'range_end'].nil?
|
4352
|
-
query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
|
4353
|
-
query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil?
|
4354
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
4355
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
4356
|
-
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
4357
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
4358
|
-
|
4359
|
-
# header parameters
|
4360
|
-
header_params = opts[:header_params] || {}
|
4361
|
-
# HTTP header 'Accept' (if needed)
|
4362
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4363
|
-
|
4364
|
-
# form parameters
|
4365
|
-
form_params = opts[:form_params] || {}
|
4366
|
-
|
4367
|
-
# http body (model)
|
4368
|
-
post_body = opts[:body]
|
4369
|
-
|
4370
|
-
# return_type
|
4371
|
-
return_type = opts[:return_type] || 'InlineResponse20020'
|
4372
|
-
|
4373
|
-
# auth_names
|
4374
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
4375
|
-
|
4376
|
-
new_options = opts.merge(
|
4377
|
-
:header_params => header_params,
|
4378
|
-
:query_params => query_params,
|
4379
|
-
:form_params => form_params,
|
4380
|
-
:body => post_body,
|
4381
|
-
:auth_names => auth_names,
|
4382
|
-
:return_type => return_type
|
4383
|
-
)
|
4384
|
-
|
4385
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4386
|
-
if @api_client.config.debugging
|
4387
|
-
@api_client.config.logger.debug "API called: ManagementApi#get_all_access_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4388
|
-
end
|
4389
|
-
return data, status_code, headers
|
4390
|
-
end
|
4391
|
-
|
4392
4303
|
# Get Application
|
4393
4304
|
# Get the application specified by the ID.
|
4394
4305
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -4452,7 +4363,7 @@ module TalonOne
|
|
4452
4363
|
end
|
4453
4364
|
|
4454
4365
|
# Get Application health
|
4455
|
-
# Display the health of the Application and show the last time the Application was used. You can also
|
4366
|
+
# 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).
|
4456
4367
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
4457
4368
|
# @param [Hash] opts the optional parameters
|
4458
4369
|
# @return [ApplicationApiHealth]
|
@@ -4462,7 +4373,7 @@ module TalonOne
|
|
4462
4373
|
end
|
4463
4374
|
|
4464
4375
|
# Get Application health
|
4465
|
-
# Display the health of the Application and show the last time the Application was used. You can also
|
4376
|
+
# 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).
|
4466
4377
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
4467
4378
|
# @param [Hash] opts the optional parameters
|
4468
4379
|
# @return [Array<(ApplicationApiHealth, Integer, Hash)>] ApplicationApiHealth data, response status code and response headers
|
@@ -4590,7 +4501,7 @@ module TalonOne
|
|
4590
4501
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4591
4502
|
# @option opts [String] :sort 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.
|
4592
4503
|
# @option opts [Boolean] :with_total_result_size 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.
|
4593
|
-
# @return [
|
4504
|
+
# @return [InlineResponse20035]
|
4594
4505
|
def get_application_customer_friends(application_id, integration_id, opts = {})
|
4595
4506
|
data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
|
4596
4507
|
data
|
@@ -4605,7 +4516,7 @@ module TalonOne
|
|
4605
4516
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4606
4517
|
# @option opts [String] :sort 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.
|
4607
4518
|
# @option opts [Boolean] :with_total_result_size 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.
|
4608
|
-
# @return [Array<(
|
4519
|
+
# @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
|
4609
4520
|
def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
|
4610
4521
|
if @api_client.config.debugging
|
4611
4522
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
|
@@ -4648,7 +4559,7 @@ module TalonOne
|
|
4648
4559
|
post_body = opts[:body]
|
4649
4560
|
|
4650
4561
|
# return_type
|
4651
|
-
return_type = opts[:return_type] || '
|
4562
|
+
return_type = opts[:return_type] || 'InlineResponse20035'
|
4652
4563
|
|
4653
4564
|
# auth_names
|
4654
4565
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4677,7 +4588,7 @@ module TalonOne
|
|
4677
4588
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4678
4589
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4679
4590
|
# @option opts [Boolean] :with_total_result_size 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.
|
4680
|
-
# @return [
|
4591
|
+
# @return [InlineResponse20024]
|
4681
4592
|
def get_application_customers(application_id, opts = {})
|
4682
4593
|
data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
|
4683
4594
|
data
|
@@ -4691,7 +4602,7 @@ module TalonOne
|
|
4691
4602
|
# @option opts [Integer] :page_size The number of items in the response.
|
4692
4603
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4693
4604
|
# @option opts [Boolean] :with_total_result_size 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.
|
4694
|
-
# @return [Array<(
|
4605
|
+
# @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
|
4695
4606
|
def get_application_customers_with_http_info(application_id, opts = {})
|
4696
4607
|
if @api_client.config.debugging
|
4697
4608
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
|
@@ -4730,7 +4641,7 @@ module TalonOne
|
|
4730
4641
|
post_body = opts[:body]
|
4731
4642
|
|
4732
4643
|
# return_type
|
4733
|
-
return_type = opts[:return_type] || '
|
4644
|
+
return_type = opts[:return_type] || 'InlineResponse20024'
|
4734
4645
|
|
4735
4646
|
# auth_names
|
4736
4647
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4759,7 +4670,7 @@ module TalonOne
|
|
4759
4670
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4760
4671
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4761
4672
|
# @option opts [Boolean] :with_total_result_size 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.
|
4762
|
-
# @return [
|
4673
|
+
# @return [InlineResponse20025]
|
4763
4674
|
def get_application_customers_by_attributes(application_id, body, opts = {})
|
4764
4675
|
data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
|
4765
4676
|
data
|
@@ -4773,7 +4684,7 @@ module TalonOne
|
|
4773
4684
|
# @option opts [Integer] :page_size The number of items in the response.
|
4774
4685
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4775
4686
|
# @option opts [Boolean] :with_total_result_size 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.
|
4776
|
-
# @return [Array<(
|
4687
|
+
# @return [Array<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
|
4777
4688
|
def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
|
4778
4689
|
if @api_client.config.debugging
|
4779
4690
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
|
@@ -4817,7 +4728,7 @@ module TalonOne
|
|
4817
4728
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
4818
4729
|
|
4819
4730
|
# return_type
|
4820
|
-
return_type = opts[:return_type] || '
|
4731
|
+
return_type = opts[:return_type] || 'InlineResponse20025'
|
4821
4732
|
|
4822
4733
|
# auth_names
|
4823
4734
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4845,7 +4756,7 @@ module TalonOne
|
|
4845
4756
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4846
4757
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4847
4758
|
# @option opts [String] :sort 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.
|
4848
|
-
# @return [
|
4759
|
+
# @return [InlineResponse20031]
|
4849
4760
|
def get_application_event_types(application_id, opts = {})
|
4850
4761
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
4851
4762
|
data
|
@@ -4858,7 +4769,7 @@ module TalonOne
|
|
4858
4769
|
# @option opts [Integer] :page_size The number of items in the response.
|
4859
4770
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4860
4771
|
# @option opts [String] :sort 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.
|
4861
|
-
# @return [Array<(
|
4772
|
+
# @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
|
4862
4773
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
4863
4774
|
if @api_client.config.debugging
|
4864
4775
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
|
@@ -4896,7 +4807,7 @@ module TalonOne
|
|
4896
4807
|
post_body = opts[:body]
|
4897
4808
|
|
4898
4809
|
# return_type
|
4899
|
-
return_type = opts[:return_type] || '
|
4810
|
+
return_type = opts[:return_type] || 'InlineResponse20031'
|
4900
4811
|
|
4901
4812
|
# auth_names
|
4902
4813
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4935,7 +4846,7 @@ module TalonOne
|
|
4935
4846
|
# @option opts [String] :referral_code Referral code
|
4936
4847
|
# @option opts [String] :rule_query Rule name filter for events
|
4937
4848
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4938
|
-
# @return [
|
4849
|
+
# @return [InlineResponse20030]
|
4939
4850
|
def get_application_events_without_total_count(application_id, opts = {})
|
4940
4851
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
4941
4852
|
data
|
@@ -4959,7 +4870,7 @@ module TalonOne
|
|
4959
4870
|
# @option opts [String] :referral_code Referral code
|
4960
4871
|
# @option opts [String] :rule_query Rule name filter for events
|
4961
4872
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4962
|
-
# @return [Array<(
|
4873
|
+
# @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
|
4963
4874
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
4964
4875
|
if @api_client.config.debugging
|
4965
4876
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
|
@@ -5016,7 +4927,7 @@ module TalonOne
|
|
5016
4927
|
post_body = opts[:body]
|
5017
4928
|
|
5018
4929
|
# return_type
|
5019
|
-
return_type = opts[:return_type] || '
|
4930
|
+
return_type = opts[:return_type] || 'InlineResponse20030'
|
5020
4931
|
|
5021
4932
|
# auth_names
|
5022
4933
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5118,9 +5029,9 @@ module TalonOne
|
|
5118
5029
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5119
5030
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
5120
5031
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
5121
|
-
# @option opts [String] :integration_id Filter by sessions with this
|
5032
|
+
# @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
|
5122
5033
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
5123
|
-
# @return [
|
5034
|
+
# @return [InlineResponse20029]
|
5124
5035
|
def get_application_sessions(application_id, opts = {})
|
5125
5036
|
data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
|
5126
5037
|
data
|
@@ -5139,9 +5050,9 @@ module TalonOne
|
|
5139
5050
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5140
5051
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
5141
5052
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
5142
|
-
# @option opts [String] :integration_id Filter by sessions with this
|
5053
|
+
# @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
|
5143
5054
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
5144
|
-
# @return [Array<(
|
5055
|
+
# @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
|
5145
5056
|
def get_application_sessions_with_http_info(application_id, opts = {})
|
5146
5057
|
if @api_client.config.debugging
|
5147
5058
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
|
@@ -5191,7 +5102,7 @@ module TalonOne
|
|
5191
5102
|
post_body = opts[:body]
|
5192
5103
|
|
5193
5104
|
# return_type
|
5194
|
-
return_type = opts[:return_type] || '
|
5105
|
+
return_type = opts[:return_type] || 'InlineResponse20029'
|
5195
5106
|
|
5196
5107
|
# auth_names
|
5197
5108
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5218,7 +5129,7 @@ module TalonOne
|
|
5218
5129
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5219
5130
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5220
5131
|
# @option opts [String] :sort 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.
|
5221
|
-
# @return [
|
5132
|
+
# @return [InlineResponse2007]
|
5222
5133
|
def get_applications(opts = {})
|
5223
5134
|
data, _status_code, _headers = get_applications_with_http_info(opts)
|
5224
5135
|
data
|
@@ -5230,7 +5141,7 @@ module TalonOne
|
|
5230
5141
|
# @option opts [Integer] :page_size The number of items in the response.
|
5231
5142
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5232
5143
|
# @option opts [String] :sort 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.
|
5233
|
-
# @return [Array<(
|
5144
|
+
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
5234
5145
|
def get_applications_with_http_info(opts = {})
|
5235
5146
|
if @api_client.config.debugging
|
5236
5147
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_applications ...'
|
@@ -5264,7 +5175,7 @@ module TalonOne
|
|
5264
5175
|
post_body = opts[:body]
|
5265
5176
|
|
5266
5177
|
# return_type
|
5267
|
-
return_type = opts[:return_type] || '
|
5178
|
+
return_type = opts[:return_type] || 'InlineResponse2007'
|
5268
5179
|
|
5269
5180
|
# auth_names
|
5270
5181
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5354,7 +5265,7 @@ module TalonOne
|
|
5354
5265
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5355
5266
|
# @option opts [String] :sort 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.
|
5356
5267
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5357
|
-
# @return [
|
5268
|
+
# @return [InlineResponse20036]
|
5358
5269
|
def get_attributes(opts = {})
|
5359
5270
|
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
5360
5271
|
data
|
@@ -5367,7 +5278,7 @@ module TalonOne
|
|
5367
5278
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5368
5279
|
# @option opts [String] :sort 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.
|
5369
5280
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5370
|
-
# @return [Array<(
|
5281
|
+
# @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
|
5371
5282
|
def get_attributes_with_http_info(opts = {})
|
5372
5283
|
if @api_client.config.debugging
|
5373
5284
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
@@ -5402,7 +5313,7 @@ module TalonOne
|
|
5402
5313
|
post_body = opts[:body]
|
5403
5314
|
|
5404
5315
|
# return_type
|
5405
|
-
return_type = opts[:return_type] || '
|
5316
|
+
return_type = opts[:return_type] || 'InlineResponse20036'
|
5406
5317
|
|
5407
5318
|
# auth_names
|
5408
5319
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5431,7 +5342,7 @@ module TalonOne
|
|
5431
5342
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5432
5343
|
# @option opts [String] :sort 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.
|
5433
5344
|
# @option opts [String] :profile_query The filter to select a profile.
|
5434
|
-
# @return [
|
5345
|
+
# @return [InlineResponse20034]
|
5435
5346
|
def get_audience_memberships(audience_id, opts = {})
|
5436
5347
|
data, _status_code, _headers = get_audience_memberships_with_http_info(audience_id, opts)
|
5437
5348
|
data
|
@@ -5445,7 +5356,7 @@ module TalonOne
|
|
5445
5356
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5446
5357
|
# @option opts [String] :sort 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.
|
5447
5358
|
# @option opts [String] :profile_query The filter to select a profile.
|
5448
|
-
# @return [Array<(
|
5359
|
+
# @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
|
5449
5360
|
def get_audience_memberships_with_http_info(audience_id, opts = {})
|
5450
5361
|
if @api_client.config.debugging
|
5451
5362
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audience_memberships ...'
|
@@ -5484,7 +5395,7 @@ module TalonOne
|
|
5484
5395
|
post_body = opts[:body]
|
5485
5396
|
|
5486
5397
|
# return_type
|
5487
|
-
return_type = opts[:return_type] || '
|
5398
|
+
return_type = opts[:return_type] || 'InlineResponse20034'
|
5488
5399
|
|
5489
5400
|
# auth_names
|
5490
5401
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5512,7 +5423,7 @@ module TalonOne
|
|
5512
5423
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5513
5424
|
# @option opts [String] :sort 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.
|
5514
5425
|
# @option opts [Boolean] :with_total_result_size 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.
|
5515
|
-
# @return [
|
5426
|
+
# @return [InlineResponse20032]
|
5516
5427
|
def get_audiences(opts = {})
|
5517
5428
|
data, _status_code, _headers = get_audiences_with_http_info(opts)
|
5518
5429
|
data
|
@@ -5525,7 +5436,7 @@ module TalonOne
|
|
5525
5436
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5526
5437
|
# @option opts [String] :sort 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.
|
5527
5438
|
# @option opts [Boolean] :with_total_result_size 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.
|
5528
|
-
# @return [Array<(
|
5439
|
+
# @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
|
5529
5440
|
def get_audiences_with_http_info(opts = {})
|
5530
5441
|
if @api_client.config.debugging
|
5531
5442
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
|
@@ -5560,7 +5471,7 @@ module TalonOne
|
|
5560
5471
|
post_body = opts[:body]
|
5561
5472
|
|
5562
5473
|
# return_type
|
5563
|
-
return_type = opts[:return_type] || '
|
5474
|
+
return_type = opts[:return_type] || 'InlineResponse20032'
|
5564
5475
|
|
5565
5476
|
# auth_names
|
5566
5477
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5586,7 +5497,7 @@ module TalonOne
|
|
5586
5497
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5587
5498
|
# @param [Hash] opts the optional parameters
|
5588
5499
|
# @option opts [String] :sort 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.
|
5589
|
-
# @return [
|
5500
|
+
# @return [InlineResponse20033]
|
5590
5501
|
def get_audiences_analytics(audience_ids, opts = {})
|
5591
5502
|
data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
|
5592
5503
|
data
|
@@ -5597,7 +5508,7 @@ module TalonOne
|
|
5597
5508
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5598
5509
|
# @param [Hash] opts the optional parameters
|
5599
5510
|
# @option opts [String] :sort 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.
|
5600
|
-
# @return [Array<(
|
5511
|
+
# @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
|
5601
5512
|
def get_audiences_analytics_with_http_info(audience_ids, opts = {})
|
5602
5513
|
if @api_client.config.debugging
|
5603
5514
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences_analytics ...'
|
@@ -5626,7 +5537,7 @@ module TalonOne
|
|
5626
5537
|
post_body = opts[:body]
|
5627
5538
|
|
5628
5539
|
# return_type
|
5629
|
-
return_type = opts[:return_type] || '
|
5540
|
+
return_type = opts[:return_type] || 'InlineResponse20033'
|
5630
5541
|
|
5631
5542
|
# auth_names
|
5632
5543
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5723,7 +5634,7 @@ module TalonOne
|
|
5723
5634
|
# @param 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.
|
5724
5635
|
# @param [Hash] opts the optional parameters
|
5725
5636
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5726
|
-
# @return [
|
5637
|
+
# @return [InlineResponse20023]
|
5727
5638
|
def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
|
5728
5639
|
data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
|
5729
5640
|
data
|
@@ -5737,7 +5648,7 @@ module TalonOne
|
|
5737
5648
|
# @param 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.
|
5738
5649
|
# @param [Hash] opts the optional parameters
|
5739
5650
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5740
|
-
# @return [Array<(
|
5651
|
+
# @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
|
5741
5652
|
def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
|
5742
5653
|
if @api_client.config.debugging
|
5743
5654
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
|
@@ -5783,7 +5694,7 @@ module TalonOne
|
|
5783
5694
|
post_body = opts[:body]
|
5784
5695
|
|
5785
5696
|
# return_type
|
5786
|
-
return_type = opts[:return_type] || '
|
5697
|
+
return_type = opts[:return_type] || 'InlineResponse20023'
|
5787
5698
|
|
5788
5699
|
# auth_names
|
5789
5700
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5813,7 +5724,7 @@ module TalonOne
|
|
5813
5724
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5814
5725
|
# @option opts [String] :sort 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.
|
5815
5726
|
# @option opts [String] :campaign_state 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.
|
5816
|
-
# @return [
|
5727
|
+
# @return [InlineResponse2008]
|
5817
5728
|
def get_campaign_by_attributes(application_id, body, opts = {})
|
5818
5729
|
data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
|
5819
5730
|
data
|
@@ -5828,7 +5739,7 @@ module TalonOne
|
|
5828
5739
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5829
5740
|
# @option opts [String] :sort 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.
|
5830
5741
|
# @option opts [String] :campaign_state 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.
|
5831
|
-
# @return [Array<(
|
5742
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
5832
5743
|
def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
|
5833
5744
|
if @api_client.config.debugging
|
5834
5745
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_by_attributes ...'
|
@@ -5849,7 +5760,7 @@ module TalonOne
|
|
5849
5760
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_by_attributes, must be greater than or equal to 1.'
|
5850
5761
|
end
|
5851
5762
|
|
5852
|
-
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
|
5763
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
5853
5764
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
5854
5765
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
5855
5766
|
end
|
@@ -5877,7 +5788,7 @@ module TalonOne
|
|
5877
5788
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
5878
5789
|
|
5879
5790
|
# return_type
|
5880
|
-
return_type = opts[:return_type] || '
|
5791
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
5881
5792
|
|
5882
5793
|
# auth_names
|
5883
5794
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5966,7 +5877,7 @@ module TalonOne
|
|
5966
5877
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5967
5878
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5968
5879
|
# @option opts [String] :sort 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.
|
5969
|
-
# @return [
|
5880
|
+
# @return [InlineResponse20013]
|
5970
5881
|
def get_campaign_groups(opts = {})
|
5971
5882
|
data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
|
5972
5883
|
data
|
@@ -5978,7 +5889,7 @@ module TalonOne
|
|
5978
5889
|
# @option opts [Integer] :page_size The number of items in the response.
|
5979
5890
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5980
5891
|
# @option opts [String] :sort 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.
|
5981
|
-
# @return [Array<(
|
5892
|
+
# @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
|
5982
5893
|
def get_campaign_groups_with_http_info(opts = {})
|
5983
5894
|
if @api_client.config.debugging
|
5984
5895
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_groups ...'
|
@@ -6012,7 +5923,7 @@ module TalonOne
|
|
6012
5923
|
post_body = opts[:body]
|
6013
5924
|
|
6014
5925
|
# return_type
|
6015
|
-
return_type = opts[:return_type] || '
|
5926
|
+
return_type = opts[:return_type] || 'InlineResponse20013'
|
6016
5927
|
|
6017
5928
|
# auth_names
|
6018
5929
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6043,7 +5954,7 @@ module TalonOne
|
|
6043
5954
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
6044
5955
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. 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.
|
6045
5956
|
# @option opts [Integer] :user_id Filter results by user ID.
|
6046
|
-
# @return [
|
5957
|
+
# @return [InlineResponse20014]
|
6047
5958
|
def get_campaign_templates(opts = {})
|
6048
5959
|
data, _status_code, _headers = get_campaign_templates_with_http_info(opts)
|
6049
5960
|
data
|
@@ -6059,7 +5970,7 @@ module TalonOne
|
|
6059
5970
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
6060
5971
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. 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.
|
6061
5972
|
# @option opts [Integer] :user_id Filter results by user ID.
|
6062
|
-
# @return [Array<(
|
5973
|
+
# @return [Array<(InlineResponse20014, Integer, Hash)>] InlineResponse20014 data, response status code and response headers
|
6063
5974
|
def get_campaign_templates_with_http_info(opts = {})
|
6064
5975
|
if @api_client.config.debugging
|
6065
5976
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_templates ...'
|
@@ -6101,7 +6012,7 @@ module TalonOne
|
|
6101
6012
|
post_body = opts[:body]
|
6102
6013
|
|
6103
6014
|
# return_type
|
6104
|
-
return_type = opts[:return_type] || '
|
6015
|
+
return_type = opts[:return_type] || 'InlineResponse20014'
|
6105
6016
|
|
6106
6017
|
# auth_names
|
6107
6018
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6135,9 +6046,9 @@ module TalonOne
|
|
6135
6046
|
# @option opts [DateTime] :created_before 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.
|
6136
6047
|
# @option opts [DateTime] :created_after 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.
|
6137
6048
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
6138
|
-
# @option opts [Integer] :template_id The ID of the
|
6049
|
+
# @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
|
6139
6050
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
6140
|
-
# @return [
|
6051
|
+
# @return [InlineResponse2008]
|
6141
6052
|
def get_campaigns(application_id, opts = {})
|
6142
6053
|
data, _status_code, _headers = get_campaigns_with_http_info(application_id, opts)
|
6143
6054
|
data
|
@@ -6156,9 +6067,9 @@ module TalonOne
|
|
6156
6067
|
# @option opts [DateTime] :created_before 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.
|
6157
6068
|
# @option opts [DateTime] :created_after 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.
|
6158
6069
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
6159
|
-
# @option opts [Integer] :template_id The ID of the
|
6070
|
+
# @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
|
6160
6071
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
6161
|
-
# @return [Array<(
|
6072
|
+
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
6162
6073
|
def get_campaigns_with_http_info(application_id, opts = {})
|
6163
6074
|
if @api_client.config.debugging
|
6164
6075
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaigns ...'
|
@@ -6175,7 +6086,7 @@ module TalonOne
|
|
6175
6086
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaigns, must be greater than or equal to 1.'
|
6176
6087
|
end
|
6177
6088
|
|
6178
|
-
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
|
6089
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
6179
6090
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
6180
6091
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
6181
6092
|
end
|
@@ -6208,7 +6119,7 @@ module TalonOne
|
|
6208
6119
|
post_body = opts[:body]
|
6209
6120
|
|
6210
6121
|
# return_type
|
6211
|
-
return_type = opts[:return_type] || '
|
6122
|
+
return_type = opts[:return_type] || 'InlineResponse2008'
|
6212
6123
|
|
6213
6124
|
# auth_names
|
6214
6125
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6243,7 +6154,7 @@ module TalonOne
|
|
6243
6154
|
# @option opts [Boolean] :with_total_result_size 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.
|
6244
6155
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
6245
6156
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
6246
|
-
# @return [
|
6157
|
+
# @return [InlineResponse20044]
|
6247
6158
|
def get_changes(opts = {})
|
6248
6159
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
6249
6160
|
data
|
@@ -6263,7 +6174,7 @@ module TalonOne
|
|
6263
6174
|
# @option opts [Boolean] :with_total_result_size 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.
|
6264
6175
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
6265
6176
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
6266
|
-
# @return [Array<(
|
6177
|
+
# @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
|
6267
6178
|
def get_changes_with_http_info(opts = {})
|
6268
6179
|
if @api_client.config.debugging
|
6269
6180
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -6305,7 +6216,7 @@ module TalonOne
|
|
6305
6216
|
post_body = opts[:body]
|
6306
6217
|
|
6307
6218
|
# return_type
|
6308
|
-
return_type = opts[:return_type] || '
|
6219
|
+
return_type = opts[:return_type] || 'InlineResponse20044'
|
6309
6220
|
|
6310
6221
|
# auth_names
|
6311
6222
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6406,7 +6317,7 @@ module TalonOne
|
|
6406
6317
|
# @param [Hash] opts the optional parameters
|
6407
6318
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6408
6319
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6409
|
-
# @return [
|
6320
|
+
# @return [InlineResponse20021]
|
6410
6321
|
def get_collection_items(collection_id, opts = {})
|
6411
6322
|
data, _status_code, _headers = get_collection_items_with_http_info(collection_id, opts)
|
6412
6323
|
data
|
@@ -6418,7 +6329,7 @@ module TalonOne
|
|
6418
6329
|
# @param [Hash] opts the optional parameters
|
6419
6330
|
# @option opts [Integer] :page_size The number of items in the response.
|
6420
6331
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6421
|
-
# @return [Array<(
|
6332
|
+
# @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
|
6422
6333
|
def get_collection_items_with_http_info(collection_id, opts = {})
|
6423
6334
|
if @api_client.config.debugging
|
6424
6335
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_collection_items ...'
|
@@ -6455,7 +6366,7 @@ module TalonOne
|
|
6455
6366
|
post_body = opts[:body]
|
6456
6367
|
|
6457
6368
|
# return_type
|
6458
|
-
return_type = opts[:return_type] || '
|
6369
|
+
return_type = opts[:return_type] || 'InlineResponse20021'
|
6459
6370
|
|
6460
6371
|
# auth_names
|
6461
6372
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6491,15 +6402,15 @@ module TalonOne
|
|
6491
6402
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
6492
6403
|
# @option opts [String] :redeemed - `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.
|
6493
6404
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
6494
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
6405
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
6495
6406
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
6496
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
6407
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
6497
6408
|
# @option opts [DateTime] :expires_before 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.
|
6498
6409
|
# @option opts [DateTime] :expires_after 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.
|
6499
6410
|
# @option opts [DateTime] :starts_before 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.
|
6500
6411
|
# @option opts [DateTime] :starts_after 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.
|
6501
6412
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false)
|
6502
|
-
# @return [
|
6413
|
+
# @return [InlineResponse20011]
|
6503
6414
|
def get_coupons_without_total_count(application_id, campaign_id, opts = {})
|
6504
6415
|
data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
|
6505
6416
|
data
|
@@ -6520,15 +6431,15 @@ module TalonOne
|
|
6520
6431
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
6521
6432
|
# @option opts [String] :redeemed - `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.
|
6522
6433
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
6523
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
6434
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
6524
6435
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
6525
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
6436
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
6526
6437
|
# @option opts [DateTime] :expires_before 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.
|
6527
6438
|
# @option opts [DateTime] :expires_after 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.
|
6528
6439
|
# @option opts [DateTime] :starts_before 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.
|
6529
6440
|
# @option opts [DateTime] :starts_after 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.
|
6530
6441
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
6531
|
-
# @return [Array<(
|
6442
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
6532
6443
|
def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
6533
6444
|
if @api_client.config.debugging
|
6534
6445
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_coupons_without_total_count ...'
|
@@ -6597,7 +6508,7 @@ module TalonOne
|
|
6597
6508
|
post_body = opts[:body]
|
6598
6509
|
|
6599
6510
|
# return_type
|
6600
|
-
return_type = opts[:return_type] || '
|
6511
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
6601
6512
|
|
6602
6513
|
# auth_names
|
6603
6514
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6723,11 +6634,11 @@ module TalonOne
|
|
6723
6634
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6724
6635
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6725
6636
|
# @option opts [String] :sort 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.
|
6726
|
-
# @option opts [String] :name Only return reports matching the customer name
|
6637
|
+
# @option opts [String] :name Only return reports matching the customer name.
|
6727
6638
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6728
|
-
# @option opts [String] :campaign_name Only return reports matching the
|
6729
|
-
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
6730
|
-
# @return [
|
6639
|
+
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
6640
|
+
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
|
6641
|
+
# @return [InlineResponse20028]
|
6731
6642
|
def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
|
6732
6643
|
data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
|
6733
6644
|
data
|
@@ -6742,11 +6653,11 @@ module TalonOne
|
|
6742
6653
|
# @option opts [Integer] :page_size The number of items in the response.
|
6743
6654
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6744
6655
|
# @option opts [String] :sort 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.
|
6745
|
-
# @option opts [String] :name Only return reports matching the customer name
|
6656
|
+
# @option opts [String] :name Only return reports matching the customer name.
|
6746
6657
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6747
|
-
# @option opts [String] :campaign_name Only return reports matching the
|
6748
|
-
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
6749
|
-
# @return [Array<(
|
6658
|
+
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
6659
|
+
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
|
6660
|
+
# @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
|
6750
6661
|
def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
|
6751
6662
|
if @api_client.config.debugging
|
6752
6663
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
|
@@ -6798,7 +6709,7 @@ module TalonOne
|
|
6798
6709
|
post_body = opts[:body]
|
6799
6710
|
|
6800
6711
|
# return_type
|
6801
|
-
return_type = opts[:return_type] || '
|
6712
|
+
return_type = opts[:return_type] || 'InlineResponse20028'
|
6802
6713
|
|
6803
6714
|
# auth_names
|
6804
6715
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6969,13 +6880,13 @@ module TalonOne
|
|
6969
6880
|
# List customer achievements
|
6970
6881
|
# For the given customer profile, list all the achievements that match your filter criteria.
|
6971
6882
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6972
|
-
# @param integration_id [String] The identifier
|
6883
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
6973
6884
|
# @param [Hash] opts the optional parameters
|
6974
6885
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
6975
6886
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6976
6887
|
# @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
6977
6888
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6978
|
-
# @return [
|
6889
|
+
# @return [InlineResponse20049]
|
6979
6890
|
def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
|
6980
6891
|
data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
|
6981
6892
|
data
|
@@ -6984,13 +6895,13 @@ module TalonOne
|
|
6984
6895
|
# List customer achievements
|
6985
6896
|
# For the given customer profile, list all the achievements that match your filter criteria.
|
6986
6897
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6987
|
-
# @param integration_id [String] The identifier
|
6898
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
6988
6899
|
# @param [Hash] opts the optional parameters
|
6989
6900
|
# @option opts [Integer] :page_size The number of items in the response.
|
6990
6901
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6991
6902
|
# @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
6992
6903
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6993
|
-
# @return [Array<(
|
6904
|
+
# @return [Array<(InlineResponse20049, Integer, Hash)>] InlineResponse20049 data, response status code and response headers
|
6994
6905
|
def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
|
6995
6906
|
if @api_client.config.debugging
|
6996
6907
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
|
@@ -7033,7 +6944,7 @@ module TalonOne
|
|
7033
6944
|
post_body = opts[:body]
|
7034
6945
|
|
7035
6946
|
# return_type
|
7036
|
-
return_type = opts[:return_type] || '
|
6947
|
+
return_type = opts[:return_type] || 'InlineResponse20049'
|
7037
6948
|
|
7038
6949
|
# auth_names
|
7039
6950
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7059,8 +6970,8 @@ module TalonOne
|
|
7059
6970
|
# @param [Hash] opts the optional parameters
|
7060
6971
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7061
6972
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7062
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
7063
|
-
# @return [
|
6973
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
6974
|
+
# @return [InlineResponse20027]
|
7064
6975
|
def get_customer_profiles(opts = {})
|
7065
6976
|
data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
|
7066
6977
|
data
|
@@ -7071,8 +6982,8 @@ module TalonOne
|
|
7071
6982
|
# @param [Hash] opts the optional parameters
|
7072
6983
|
# @option opts [Integer] :page_size The number of items in the response.
|
7073
6984
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7074
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
7075
|
-
# @return [Array<(
|
6985
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
6986
|
+
# @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
|
7076
6987
|
def get_customer_profiles_with_http_info(opts = {})
|
7077
6988
|
if @api_client.config.debugging
|
7078
6989
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
|
@@ -7106,7 +7017,7 @@ module TalonOne
|
|
7106
7017
|
post_body = opts[:body]
|
7107
7018
|
|
7108
7019
|
# return_type
|
7109
|
-
return_type = opts[:return_type] || '
|
7020
|
+
return_type = opts[:return_type] || 'InlineResponse20027'
|
7110
7021
|
|
7111
7022
|
# auth_names
|
7112
7023
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7133,8 +7044,8 @@ module TalonOne
|
|
7133
7044
|
# @param [Hash] opts the optional parameters
|
7134
7045
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7135
7046
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7136
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
7137
|
-
# @return [
|
7047
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
7048
|
+
# @return [InlineResponse20026]
|
7138
7049
|
def get_customers_by_attributes(body, opts = {})
|
7139
7050
|
data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
|
7140
7051
|
data
|
@@ -7146,8 +7057,8 @@ module TalonOne
|
|
7146
7057
|
# @param [Hash] opts the optional parameters
|
7147
7058
|
# @option opts [Integer] :page_size The number of items in the response.
|
7148
7059
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7149
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
7150
|
-
# @return [Array<(
|
7060
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
7061
|
+
# @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
|
7151
7062
|
def get_customers_by_attributes_with_http_info(body, opts = {})
|
7152
7063
|
if @api_client.config.debugging
|
7153
7064
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
|
@@ -7187,7 +7098,7 @@ module TalonOne
|
|
7187
7098
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
7188
7099
|
|
7189
7100
|
# return_type
|
7190
|
-
return_type = opts[:return_type] || '
|
7101
|
+
return_type = opts[:return_type] || 'InlineResponse20026'
|
7191
7102
|
|
7192
7103
|
# auth_names
|
7193
7104
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7208,6 +7119,85 @@ module TalonOne
|
|
7208
7119
|
return data, status_code, headers
|
7209
7120
|
end
|
7210
7121
|
|
7122
|
+
# Get statistics for loyalty dashboard
|
7123
|
+
# Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
7124
|
+
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
7125
|
+
# @param 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.
|
7126
|
+
# @param 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.
|
7127
|
+
# @param [Hash] opts the optional parameters
|
7128
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7129
|
+
# @return [InlineResponse20016]
|
7130
|
+
def get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts = {})
|
7131
|
+
data, _status_code, _headers = get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts)
|
7132
|
+
data
|
7133
|
+
end
|
7134
|
+
|
7135
|
+
# Get statistics for loyalty dashboard
|
7136
|
+
# Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
7137
|
+
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
7138
|
+
# @param 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.
|
7139
|
+
# @param 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.
|
7140
|
+
# @param [Hash] opts the optional parameters
|
7141
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7142
|
+
# @return [Array<(InlineResponse20016, Integer, Hash)>] InlineResponse20016 data, response status code and response headers
|
7143
|
+
def get_dashboard_statistics_with_http_info(loyalty_program_id, range_start, range_end, opts = {})
|
7144
|
+
if @api_client.config.debugging
|
7145
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.get_dashboard_statistics ...'
|
7146
|
+
end
|
7147
|
+
# verify the required parameter 'loyalty_program_id' is set
|
7148
|
+
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
7149
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.get_dashboard_statistics"
|
7150
|
+
end
|
7151
|
+
# verify the required parameter 'range_start' is set
|
7152
|
+
if @api_client.config.client_side_validation && range_start.nil?
|
7153
|
+
fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.get_dashboard_statistics"
|
7154
|
+
end
|
7155
|
+
# verify the required parameter 'range_end' is set
|
7156
|
+
if @api_client.config.client_side_validation && range_end.nil?
|
7157
|
+
fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.get_dashboard_statistics"
|
7158
|
+
end
|
7159
|
+
# resource path
|
7160
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/dashboard'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
7161
|
+
|
7162
|
+
# query parameters
|
7163
|
+
query_params = opts[:query_params] || {}
|
7164
|
+
query_params[:'rangeStart'] = range_start
|
7165
|
+
query_params[:'rangeEnd'] = range_end
|
7166
|
+
query_params[:'subledgerId'] = opts[:'subledger_id'] if !opts[:'subledger_id'].nil?
|
7167
|
+
|
7168
|
+
# header parameters
|
7169
|
+
header_params = opts[:header_params] || {}
|
7170
|
+
# HTTP header 'Accept' (if needed)
|
7171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7172
|
+
|
7173
|
+
# form parameters
|
7174
|
+
form_params = opts[:form_params] || {}
|
7175
|
+
|
7176
|
+
# http body (model)
|
7177
|
+
post_body = opts[:body]
|
7178
|
+
|
7179
|
+
# return_type
|
7180
|
+
return_type = opts[:return_type] || 'InlineResponse20016'
|
7181
|
+
|
7182
|
+
# auth_names
|
7183
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
7184
|
+
|
7185
|
+
new_options = opts.merge(
|
7186
|
+
:header_params => header_params,
|
7187
|
+
:query_params => query_params,
|
7188
|
+
:form_params => form_params,
|
7189
|
+
:body => post_body,
|
7190
|
+
:auth_names => auth_names,
|
7191
|
+
:return_type => return_type
|
7192
|
+
)
|
7193
|
+
|
7194
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
7195
|
+
if @api_client.config.debugging
|
7196
|
+
@api_client.config.logger.debug "API called: ManagementApi#get_dashboard_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7197
|
+
end
|
7198
|
+
return data, status_code, headers
|
7199
|
+
end
|
7200
|
+
|
7211
7201
|
# List event types
|
7212
7202
|
# Fetch all event type definitions for your account.
|
7213
7203
|
# @param [Hash] opts the optional parameters
|
@@ -7216,7 +7206,7 @@ module TalonOne
|
|
7216
7206
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7217
7207
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7218
7208
|
# @option opts [String] :sort 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.
|
7219
|
-
# @return [
|
7209
|
+
# @return [InlineResponse20042]
|
7220
7210
|
def get_event_types(opts = {})
|
7221
7211
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
7222
7212
|
data
|
@@ -7230,7 +7220,7 @@ module TalonOne
|
|
7230
7220
|
# @option opts [Integer] :page_size The number of items in the response.
|
7231
7221
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7232
7222
|
# @option opts [String] :sort 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.
|
7233
|
-
# @return [Array<(
|
7223
|
+
# @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
|
7234
7224
|
def get_event_types_with_http_info(opts = {})
|
7235
7225
|
if @api_client.config.debugging
|
7236
7226
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -7266,7 +7256,7 @@ module TalonOne
|
|
7266
7256
|
post_body = opts[:body]
|
7267
7257
|
|
7268
7258
|
# return_type
|
7269
|
-
return_type = opts[:return_type] || '
|
7259
|
+
return_type = opts[:return_type] || 'InlineResponse20042'
|
7270
7260
|
|
7271
7261
|
# auth_names
|
7272
7262
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7295,7 +7285,7 @@ module TalonOne
|
|
7295
7285
|
# @option opts [Float] :application_id Filter results by Application ID.
|
7296
7286
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
7297
7287
|
# @option opts [String] :entity The name of the entity type that was exported.
|
7298
|
-
# @return [
|
7288
|
+
# @return [InlineResponse20045]
|
7299
7289
|
def get_exports(opts = {})
|
7300
7290
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
7301
7291
|
data
|
@@ -7309,7 +7299,7 @@ module TalonOne
|
|
7309
7299
|
# @option opts [Float] :application_id Filter results by Application ID.
|
7310
7300
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
7311
7301
|
# @option opts [String] :entity The name of the entity type that was exported.
|
7312
|
-
# @return [Array<(
|
7302
|
+
# @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
|
7313
7303
|
def get_exports_with_http_info(opts = {})
|
7314
7304
|
if @api_client.config.debugging
|
7315
7305
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
@@ -7349,7 +7339,7 @@ module TalonOne
|
|
7349
7339
|
post_body = opts[:body]
|
7350
7340
|
|
7351
7341
|
# return_type
|
7352
|
-
return_type = opts[:return_type] || '
|
7342
|
+
return_type = opts[:return_type] || 'InlineResponse20045'
|
7353
7343
|
|
7354
7344
|
# auth_names
|
7355
7345
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7452,7 +7442,7 @@ module TalonOne
|
|
7452
7442
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7453
7443
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7454
7444
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7455
|
-
# @return [
|
7445
|
+
# @return [InlineResponse20019]
|
7456
7446
|
def get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts = {})
|
7457
7447
|
data, _status_code, _headers = get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
7458
7448
|
data
|
@@ -7468,7 +7458,7 @@ module TalonOne
|
|
7468
7458
|
# @option opts [Integer] :page_size The number of items in the response.
|
7469
7459
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7470
7460
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
7471
|
-
# @return [Array<(
|
7461
|
+
# @return [Array<(InlineResponse20019, Integer, Hash)>] InlineResponse20019 data, response status code and response headers
|
7472
7462
|
def get_loyalty_card_transaction_logs_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
7473
7463
|
if @api_client.config.debugging
|
7474
7464
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_card_transaction_logs ...'
|
@@ -7516,7 +7506,7 @@ module TalonOne
|
|
7516
7506
|
post_body = opts[:body]
|
7517
7507
|
|
7518
7508
|
# return_type
|
7519
|
-
return_type = opts[:return_type] || '
|
7509
|
+
return_type = opts[:return_type] || 'InlineResponse20019'
|
7520
7510
|
|
7521
7511
|
# auth_names
|
7522
7512
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7547,7 +7537,7 @@ module TalonOne
|
|
7547
7537
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7548
7538
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7549
7539
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7550
|
-
# @return [
|
7540
|
+
# @return [InlineResponse20018]
|
7551
7541
|
def get_loyalty_cards(loyalty_program_id, opts = {})
|
7552
7542
|
data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
7553
7543
|
data
|
@@ -7563,7 +7553,7 @@ module TalonOne
|
|
7563
7553
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7564
7554
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7565
7555
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7566
|
-
# @return [Array<(
|
7556
|
+
# @return [Array<(InlineResponse20018, Integer, Hash)>] InlineResponse20018 data, response status code and response headers
|
7567
7557
|
def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
7568
7558
|
if @api_client.config.debugging
|
7569
7559
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_cards ...'
|
@@ -7612,7 +7602,7 @@ module TalonOne
|
|
7612
7602
|
post_body = opts[:body]
|
7613
7603
|
|
7614
7604
|
# return_type
|
7615
|
-
return_type = opts[:return_type] || '
|
7605
|
+
return_type = opts[:return_type] || 'InlineResponse20018'
|
7616
7606
|
|
7617
7607
|
# auth_names
|
7618
7608
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7636,7 +7626,7 @@ module TalonOne
|
|
7636
7626
|
# Get customer's full loyalty ledger
|
7637
7627
|
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
7638
7628
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
7639
|
-
# @param integration_id [String] The identifier
|
7629
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
7640
7630
|
# @param [Hash] opts the optional parameters
|
7641
7631
|
# @return [LoyaltyLedger]
|
7642
7632
|
def get_loyalty_points(loyalty_program_id, integration_id, opts = {})
|
@@ -7647,7 +7637,7 @@ module TalonOne
|
|
7647
7637
|
# Get customer's full loyalty ledger
|
7648
7638
|
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
7649
7639
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
7650
|
-
# @param integration_id [String] The identifier
|
7640
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
7651
7641
|
# @param [Hash] opts the optional parameters
|
7652
7642
|
# @return [Array<(LoyaltyLedger, Integer, Hash)>] LoyaltyLedger data, response status code and response headers
|
7653
7643
|
def get_loyalty_points_with_http_info(loyalty_program_id, integration_id, opts = {})
|
@@ -7773,7 +7763,7 @@ module TalonOne
|
|
7773
7763
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It 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.
|
7774
7764
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
7775
7765
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7776
|
-
# @return [
|
7766
|
+
# @return [InlineResponse20017]
|
7777
7767
|
def get_loyalty_program_transactions(loyalty_program_id, opts = {})
|
7778
7768
|
data, _status_code, _headers = get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts)
|
7779
7769
|
data
|
@@ -7789,7 +7779,7 @@ module TalonOne
|
|
7789
7779
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It 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.
|
7790
7780
|
# @option opts [Integer] :page_size The number of items in the response.
|
7791
7781
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7792
|
-
# @return [Array<(
|
7782
|
+
# @return [Array<(InlineResponse20017, Integer, Hash)>] InlineResponse20017 data, response status code and response headers
|
7793
7783
|
def get_loyalty_program_transactions_with_http_info(loyalty_program_id, opts = {})
|
7794
7784
|
if @api_client.config.debugging
|
7795
7785
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_program_transactions ...'
|
@@ -7834,7 +7824,7 @@ module TalonOne
|
|
7834
7824
|
post_body = opts[:body]
|
7835
7825
|
|
7836
7826
|
# return_type
|
7837
|
-
return_type = opts[:return_type] || '
|
7827
|
+
return_type = opts[:return_type] || 'InlineResponse20017'
|
7838
7828
|
|
7839
7829
|
# auth_names
|
7840
7830
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7858,7 +7848,7 @@ module TalonOne
|
|
7858
7848
|
# List loyalty programs
|
7859
7849
|
# List the loyalty programs of the account.
|
7860
7850
|
# @param [Hash] opts the optional parameters
|
7861
|
-
# @return [
|
7851
|
+
# @return [InlineResponse20015]
|
7862
7852
|
def get_loyalty_programs(opts = {})
|
7863
7853
|
data, _status_code, _headers = get_loyalty_programs_with_http_info(opts)
|
7864
7854
|
data
|
@@ -7867,7 +7857,7 @@ module TalonOne
|
|
7867
7857
|
# List loyalty programs
|
7868
7858
|
# List the loyalty programs of the account.
|
7869
7859
|
# @param [Hash] opts the optional parameters
|
7870
|
-
# @return [Array<(
|
7860
|
+
# @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
|
7871
7861
|
def get_loyalty_programs_with_http_info(opts = {})
|
7872
7862
|
if @api_client.config.debugging
|
7873
7863
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_loyalty_programs ...'
|
@@ -7890,7 +7880,7 @@ module TalonOne
|
|
7890
7880
|
post_body = opts[:body]
|
7891
7881
|
|
7892
7882
|
# return_type
|
7893
|
-
return_type = opts[:return_type] || '
|
7883
|
+
return_type = opts[:return_type] || 'InlineResponse20015'
|
7894
7884
|
|
7895
7885
|
# auth_names
|
7896
7886
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7912,7 +7902,7 @@ module TalonOne
|
|
7912
7902
|
end
|
7913
7903
|
|
7914
7904
|
# Get loyalty program statistics
|
7915
|
-
#
|
7905
|
+
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
|
7916
7906
|
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
7917
7907
|
# @param [Hash] opts the optional parameters
|
7918
7908
|
# @return [LoyaltyDashboardData]
|
@@ -7922,7 +7912,7 @@ module TalonOne
|
|
7922
7912
|
end
|
7923
7913
|
|
7924
7914
|
# Get loyalty program statistics
|
7925
|
-
#
|
7915
|
+
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
|
7926
7916
|
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
7927
7917
|
# @param [Hash] opts the optional parameters
|
7928
7918
|
# @return [Array<(LoyaltyDashboardData, Integer, Hash)>] LoyaltyDashboardData data, response status code and response headers
|
@@ -7986,8 +7976,8 @@ module TalonOne
|
|
7986
7976
|
# @option opts [DateTime] :created_after 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.
|
7987
7977
|
# @option opts [String] :valid 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.
|
7988
7978
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
7989
|
-
# @option opts [String] :advocate Filter results by match with a profile
|
7990
|
-
# @return [
|
7979
|
+
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
7980
|
+
# @return [InlineResponse20012]
|
7991
7981
|
def get_referrals_without_total_count(application_id, campaign_id, opts = {})
|
7992
7982
|
data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
|
7993
7983
|
data
|
@@ -8006,8 +7996,8 @@ module TalonOne
|
|
8006
7996
|
# @option opts [DateTime] :created_after 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.
|
8007
7997
|
# @option opts [String] :valid 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.
|
8008
7998
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
8009
|
-
# @option opts [String] :advocate Filter results by match with a profile
|
8010
|
-
# @return [Array<(
|
7999
|
+
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
8000
|
+
# @return [Array<(InlineResponse20012, Integer, Hash)>] InlineResponse20012 data, response status code and response headers
|
8011
8001
|
def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
8012
8002
|
if @api_client.config.debugging
|
8013
8003
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_referrals_without_total_count ...'
|
@@ -8063,7 +8053,7 @@ module TalonOne
|
|
8063
8053
|
post_body = opts[:body]
|
8064
8054
|
|
8065
8055
|
# return_type
|
8066
|
-
return_type = opts[:return_type] || '
|
8056
|
+
return_type = opts[:return_type] || 'InlineResponse20012'
|
8067
8057
|
|
8068
8058
|
# auth_names
|
8069
8059
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8228,7 +8218,7 @@ module TalonOne
|
|
8228
8218
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8229
8219
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8230
8220
|
# @option opts [String] :sort 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.
|
8231
|
-
# @return [
|
8221
|
+
# @return [InlineResponse2009]
|
8232
8222
|
def get_rulesets(application_id, campaign_id, opts = {})
|
8233
8223
|
data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
|
8234
8224
|
data
|
@@ -8242,7 +8232,7 @@ module TalonOne
|
|
8242
8232
|
# @option opts [Integer] :page_size The number of items in the response.
|
8243
8233
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8244
8234
|
# @option opts [String] :sort 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.
|
8245
|
-
# @return [Array<(
|
8235
|
+
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
8246
8236
|
def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
|
8247
8237
|
if @api_client.config.debugging
|
8248
8238
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_rulesets ...'
|
@@ -8284,7 +8274,7 @@ module TalonOne
|
|
8284
8274
|
post_body = opts[:body]
|
8285
8275
|
|
8286
8276
|
# return_type
|
8287
|
-
return_type = opts[:return_type] || '
|
8277
|
+
return_type = opts[:return_type] || 'InlineResponse2009'
|
8288
8278
|
|
8289
8279
|
# auth_names
|
8290
8280
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8441,7 +8431,7 @@ module TalonOne
|
|
8441
8431
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8442
8432
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8443
8433
|
# @option opts [String] :sort 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.
|
8444
|
-
# @return [
|
8434
|
+
# @return [InlineResponse20043]
|
8445
8435
|
def get_users(opts = {})
|
8446
8436
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
8447
8437
|
data
|
@@ -8453,7 +8443,7 @@ module TalonOne
|
|
8453
8443
|
# @option opts [Integer] :page_size The number of items in the response.
|
8454
8444
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8455
8445
|
# @option opts [String] :sort 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.
|
8456
|
-
# @return [Array<(
|
8446
|
+
# @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
|
8457
8447
|
def get_users_with_http_info(opts = {})
|
8458
8448
|
if @api_client.config.debugging
|
8459
8449
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -8487,7 +8477,7 @@ module TalonOne
|
|
8487
8477
|
post_body = opts[:body]
|
8488
8478
|
|
8489
8479
|
# return_type
|
8490
|
-
return_type = opts[:return_type] || '
|
8480
|
+
return_type = opts[:return_type] || 'InlineResponse20043'
|
8491
8481
|
|
8492
8482
|
# auth_names
|
8493
8483
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8577,12 +8567,12 @@ module TalonOne
|
|
8577
8567
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8578
8568
|
# @option opts [String] :sort 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.
|
8579
8569
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8580
|
-
# @option opts [Float] :webhook_id Filter results by
|
8570
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8581
8571
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8582
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8572
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8583
8573
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8584
8574
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8585
|
-
# @return [
|
8575
|
+
# @return [InlineResponse20040]
|
8586
8576
|
def get_webhook_activation_logs(opts = {})
|
8587
8577
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
8588
8578
|
data
|
@@ -8595,12 +8585,12 @@ module TalonOne
|
|
8595
8585
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8596
8586
|
# @option opts [String] :sort 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.
|
8597
8587
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8598
|
-
# @option opts [Float] :webhook_id Filter results by
|
8588
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8599
8589
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8600
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8590
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8601
8591
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8602
8592
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8603
|
-
# @return [Array<(
|
8593
|
+
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
8604
8594
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
8605
8595
|
if @api_client.config.debugging
|
8606
8596
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -8640,7 +8630,7 @@ module TalonOne
|
|
8640
8630
|
post_body = opts[:body]
|
8641
8631
|
|
8642
8632
|
# return_type
|
8643
|
-
return_type = opts[:return_type] || '
|
8633
|
+
return_type = opts[:return_type] || 'InlineResponse20040'
|
8644
8634
|
|
8645
8635
|
# auth_names
|
8646
8636
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8668,13 +8658,13 @@ module TalonOne
|
|
8668
8658
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8669
8659
|
# @option opts [String] :sort 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.
|
8670
8660
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8671
|
-
# @option opts [Float] :webhook_id Filter results by
|
8661
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8672
8662
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8673
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8663
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8674
8664
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8675
8665
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8676
8666
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8677
|
-
# @return [
|
8667
|
+
# @return [InlineResponse20041]
|
8678
8668
|
def get_webhook_logs(opts = {})
|
8679
8669
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
8680
8670
|
data
|
@@ -8687,13 +8677,13 @@ module TalonOne
|
|
8687
8677
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8688
8678
|
# @option opts [String] :sort 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.
|
8689
8679
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8690
|
-
# @option opts [Float] :webhook_id Filter results by
|
8680
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8691
8681
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8692
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8682
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8693
8683
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8694
8684
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8695
8685
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
8696
|
-
# @return [Array<(
|
8686
|
+
# @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
|
8697
8687
|
def get_webhook_logs_with_http_info(opts = {})
|
8698
8688
|
if @api_client.config.debugging
|
8699
8689
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -8738,7 +8728,7 @@ module TalonOne
|
|
8738
8728
|
post_body = opts[:body]
|
8739
8729
|
|
8740
8730
|
# return_type
|
8741
|
-
return_type = opts[:return_type] || '
|
8731
|
+
return_type = opts[:return_type] || 'InlineResponse20041'
|
8742
8732
|
|
8743
8733
|
# auth_names
|
8744
8734
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8770,7 +8760,7 @@ module TalonOne
|
|
8770
8760
|
# @option opts [String] :visibility Filter results by visibility.
|
8771
8761
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8772
8762
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8773
|
-
# @return [
|
8763
|
+
# @return [InlineResponse20039]
|
8774
8764
|
def get_webhooks(opts = {})
|
8775
8765
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
8776
8766
|
data
|
@@ -8787,7 +8777,7 @@ module TalonOne
|
|
8787
8777
|
# @option opts [String] :visibility Filter results by visibility.
|
8788
8778
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8789
8779
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8790
|
-
# @return [Array<(
|
8780
|
+
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
8791
8781
|
def get_webhooks_with_http_info(opts = {})
|
8792
8782
|
if @api_client.config.debugging
|
8793
8783
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -8834,7 +8824,7 @@ module TalonOne
|
|
8834
8824
|
post_body = opts[:body]
|
8835
8825
|
|
8836
8826
|
# return_type
|
8837
|
-
return_type = opts[:return_type] || '
|
8827
|
+
return_type = opts[:return_type] || 'InlineResponse20039'
|
8838
8828
|
|
8839
8829
|
# auth_names
|
8840
8830
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9285,7 +9275,7 @@ module TalonOne
|
|
9285
9275
|
end
|
9286
9276
|
|
9287
9277
|
# Import loyalty cards
|
9288
|
-
# 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 ```
|
9278
|
+
# 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 ```
|
9289
9279
|
# @param 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.
|
9290
9280
|
# @param [Hash] opts the optional parameters
|
9291
9281
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -9296,7 +9286,7 @@ module TalonOne
|
|
9296
9286
|
end
|
9297
9287
|
|
9298
9288
|
# Import loyalty cards
|
9299
|
-
# 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 ```
|
9289
|
+
# 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 ```
|
9300
9290
|
# @param 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.
|
9301
9291
|
# @param [Hash] opts the optional parameters
|
9302
9292
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -9419,7 +9409,7 @@ module TalonOne
|
|
9419
9409
|
end
|
9420
9410
|
|
9421
9411
|
# Import loyalty points
|
9422
|
-
# 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 ```
|
9412
|
+
# 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 ```
|
9423
9413
|
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9424
9414
|
# @param [Hash] opts the optional parameters
|
9425
9415
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -9430,7 +9420,7 @@ module TalonOne
|
|
9430
9420
|
end
|
9431
9421
|
|
9432
9422
|
# Import loyalty points
|
9433
|
-
# 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 ```
|
9423
|
+
# 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 ```
|
9434
9424
|
# @param loyalty_program_id [Integer] Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9435
9425
|
# @param [Hash] opts the optional parameters
|
9436
9426
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -9695,7 +9685,7 @@ module TalonOne
|
|
9695
9685
|
# @option opts [String] :sort 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.
|
9696
9686
|
# @option opts [Boolean] :with_total_result_size 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.
|
9697
9687
|
# @option opts [String] :name Filter by collection name.
|
9698
|
-
# @return [
|
9688
|
+
# @return [InlineResponse20020]
|
9699
9689
|
def list_account_collections(opts = {})
|
9700
9690
|
data, _status_code, _headers = list_account_collections_with_http_info(opts)
|
9701
9691
|
data
|
@@ -9709,7 +9699,7 @@ module TalonOne
|
|
9709
9699
|
# @option opts [String] :sort 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.
|
9710
9700
|
# @option opts [Boolean] :with_total_result_size 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.
|
9711
9701
|
# @option opts [String] :name Filter by collection name.
|
9712
|
-
# @return [Array<(
|
9702
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
9713
9703
|
def list_account_collections_with_http_info(opts = {})
|
9714
9704
|
if @api_client.config.debugging
|
9715
9705
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_account_collections ...'
|
@@ -9745,7 +9735,7 @@ module TalonOne
|
|
9745
9735
|
post_body = opts[:body]
|
9746
9736
|
|
9747
9737
|
# return_type
|
9748
|
-
return_type = opts[:return_type] || '
|
9738
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
9749
9739
|
|
9750
9740
|
# auth_names
|
9751
9741
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9774,7 +9764,7 @@ module TalonOne
|
|
9774
9764
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
9775
9765
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9776
9766
|
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
9777
|
-
# @return [
|
9767
|
+
# @return [InlineResponse20048]
|
9778
9768
|
def list_achievements(application_id, campaign_id, opts = {})
|
9779
9769
|
data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
|
9780
9770
|
data
|
@@ -9788,7 +9778,7 @@ module TalonOne
|
|
9788
9778
|
# @option opts [Integer] :page_size The number of items in the response.
|
9789
9779
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9790
9780
|
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
9791
|
-
# @return [Array<(
|
9781
|
+
# @return [Array<(InlineResponse20048, Integer, Hash)>] InlineResponse20048 data, response status code and response headers
|
9792
9782
|
def list_achievements_with_http_info(application_id, campaign_id, opts = {})
|
9793
9783
|
if @api_client.config.debugging
|
9794
9784
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
|
@@ -9830,7 +9820,7 @@ module TalonOne
|
|
9830
9820
|
post_body = opts[:body]
|
9831
9821
|
|
9832
9822
|
# return_type
|
9833
|
-
return_type = opts[:return_type] || '
|
9823
|
+
return_type = opts[:return_type] || 'InlineResponse20048'
|
9834
9824
|
|
9835
9825
|
# auth_names
|
9836
9826
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9854,7 +9844,7 @@ module TalonOne
|
|
9854
9844
|
# List roles
|
9855
9845
|
# List all roles.
|
9856
9846
|
# @param [Hash] opts the optional parameters
|
9857
|
-
# @return [
|
9847
|
+
# @return [InlineResponse20046]
|
9858
9848
|
def list_all_roles_v2(opts = {})
|
9859
9849
|
data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
|
9860
9850
|
data
|
@@ -9863,7 +9853,7 @@ module TalonOne
|
|
9863
9853
|
# List roles
|
9864
9854
|
# List all roles.
|
9865
9855
|
# @param [Hash] opts the optional parameters
|
9866
|
-
# @return [Array<(
|
9856
|
+
# @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
|
9867
9857
|
def list_all_roles_v2_with_http_info(opts = {})
|
9868
9858
|
if @api_client.config.debugging
|
9869
9859
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
|
@@ -9886,7 +9876,7 @@ module TalonOne
|
|
9886
9876
|
post_body = opts[:body]
|
9887
9877
|
|
9888
9878
|
# return_type
|
9889
|
-
return_type = opts[:return_type] || '
|
9879
|
+
return_type = opts[:return_type] || 'InlineResponse20046'
|
9890
9880
|
|
9891
9881
|
# auth_names
|
9892
9882
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9916,7 +9906,7 @@ module TalonOne
|
|
9916
9906
|
# @option opts [Boolean] :with_total_result_size 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.
|
9917
9907
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9918
9908
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9919
|
-
# @return [
|
9909
|
+
# @return [InlineResponse20037]
|
9920
9910
|
def list_catalog_items(catalog_id, opts = {})
|
9921
9911
|
data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
|
9922
9912
|
data
|
@@ -9931,7 +9921,7 @@ module TalonOne
|
|
9931
9921
|
# @option opts [Boolean] :with_total_result_size 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.
|
9932
9922
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9933
9923
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9934
|
-
# @return [Array<(
|
9924
|
+
# @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
|
9935
9925
|
def list_catalog_items_with_http_info(catalog_id, opts = {})
|
9936
9926
|
if @api_client.config.debugging
|
9937
9927
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_catalog_items ...'
|
@@ -9971,7 +9961,7 @@ module TalonOne
|
|
9971
9961
|
post_body = opts[:body]
|
9972
9962
|
|
9973
9963
|
# return_type
|
9974
|
-
return_type = opts[:return_type] || '
|
9964
|
+
return_type = opts[:return_type] || 'InlineResponse20037'
|
9975
9965
|
|
9976
9966
|
# auth_names
|
9977
9967
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10002,7 +9992,7 @@ module TalonOne
|
|
10002
9992
|
# @option opts [String] :sort 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.
|
10003
9993
|
# @option opts [Boolean] :with_total_result_size 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.
|
10004
9994
|
# @option opts [String] :name Filter by collection name.
|
10005
|
-
# @return [
|
9995
|
+
# @return [InlineResponse20020]
|
10006
9996
|
def list_collections(application_id, campaign_id, opts = {})
|
10007
9997
|
data, _status_code, _headers = list_collections_with_http_info(application_id, campaign_id, opts)
|
10008
9998
|
data
|
@@ -10018,7 +10008,7 @@ module TalonOne
|
|
10018
10008
|
# @option opts [String] :sort 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.
|
10019
10009
|
# @option opts [Boolean] :with_total_result_size 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.
|
10020
10010
|
# @option opts [String] :name Filter by collection name.
|
10021
|
-
# @return [Array<(
|
10011
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
10022
10012
|
def list_collections_with_http_info(application_id, campaign_id, opts = {})
|
10023
10013
|
if @api_client.config.debugging
|
10024
10014
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections ...'
|
@@ -10062,7 +10052,7 @@ module TalonOne
|
|
10062
10052
|
post_body = opts[:body]
|
10063
10053
|
|
10064
10054
|
# return_type
|
10065
|
-
return_type = opts[:return_type] || '
|
10055
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
10066
10056
|
|
10067
10057
|
# auth_names
|
10068
10058
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10092,7 +10082,7 @@ module TalonOne
|
|
10092
10082
|
# @option opts [String] :sort 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.
|
10093
10083
|
# @option opts [Boolean] :with_total_result_size 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.
|
10094
10084
|
# @option opts [String] :name Filter by collection name.
|
10095
|
-
# @return [
|
10085
|
+
# @return [InlineResponse20020]
|
10096
10086
|
def list_collections_in_application(application_id, opts = {})
|
10097
10087
|
data, _status_code, _headers = list_collections_in_application_with_http_info(application_id, opts)
|
10098
10088
|
data
|
@@ -10107,7 +10097,7 @@ module TalonOne
|
|
10107
10097
|
# @option opts [String] :sort 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.
|
10108
10098
|
# @option opts [Boolean] :with_total_result_size 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.
|
10109
10099
|
# @option opts [String] :name Filter by collection name.
|
10110
|
-
# @return [Array<(
|
10100
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
10111
10101
|
def list_collections_in_application_with_http_info(application_id, opts = {})
|
10112
10102
|
if @api_client.config.debugging
|
10113
10103
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_collections_in_application ...'
|
@@ -10147,7 +10137,7 @@ module TalonOne
|
|
10147
10137
|
post_body = opts[:body]
|
10148
10138
|
|
10149
10139
|
# return_type
|
10150
|
-
return_type = opts[:return_type] || '
|
10140
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
10151
10141
|
|
10152
10142
|
# auth_names
|
10153
10143
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10176,11 +10166,11 @@ module TalonOne
|
|
10176
10166
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10177
10167
|
# @option opts [String] :sort 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.
|
10178
10168
|
# @option opts [Boolean] :with_total_result_size 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.
|
10179
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
10169
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
10180
10170
|
# @option opts [String] :name The name of the store.
|
10181
10171
|
# @option opts [String] :integration_id The integration ID of the store.
|
10182
10172
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
10183
|
-
# @return [
|
10173
|
+
# @return [InlineResponse20047]
|
10184
10174
|
def list_stores(application_id, opts = {})
|
10185
10175
|
data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
|
10186
10176
|
data
|
@@ -10194,11 +10184,11 @@ module TalonOne
|
|
10194
10184
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10195
10185
|
# @option opts [String] :sort 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.
|
10196
10186
|
# @option opts [Boolean] :with_total_result_size 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.
|
10197
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
10187
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
10198
10188
|
# @option opts [String] :name The name of the store.
|
10199
10189
|
# @option opts [String] :integration_id The integration ID of the store.
|
10200
10190
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
10201
|
-
# @return [Array<(
|
10191
|
+
# @return [Array<(InlineResponse20047, Integer, Hash)>] InlineResponse20047 data, response status code and response headers
|
10202
10192
|
def list_stores_with_http_info(application_id, opts = {})
|
10203
10193
|
if @api_client.config.debugging
|
10204
10194
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
|
@@ -10241,7 +10231,7 @@ module TalonOne
|
|
10241
10231
|
post_body = opts[:body]
|
10242
10232
|
|
10243
10233
|
# return_type
|
10244
|
-
return_type = opts[:return_type] || '
|
10234
|
+
return_type = opts[:return_type] || 'InlineResponse20047'
|
10245
10235
|
|
10246
10236
|
# auth_names
|
10247
10237
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10385,7 +10375,7 @@ module TalonOne
|
|
10385
10375
|
end
|
10386
10376
|
|
10387
10377
|
# Create notification about added or deducted loyalty points
|
10388
|
-
# 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 [
|
10378
|
+
# 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 [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10389
10379
|
# @param loyalty_program_id [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.
|
10390
10380
|
# @param body [NewBaseNotification] body
|
10391
10381
|
# @param [Hash] opts the optional parameters
|
@@ -10396,7 +10386,7 @@ module TalonOne
|
|
10396
10386
|
end
|
10397
10387
|
|
10398
10388
|
# Create notification about added or deducted loyalty points
|
10399
|
-
# 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 [
|
10389
|
+
# 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 [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10400
10390
|
# @param loyalty_program_id [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.
|
10401
10391
|
# @param body [NewBaseNotification] body
|
10402
10392
|
# @param [Hash] opts the optional parameters
|
@@ -10455,7 +10445,7 @@ module TalonOne
|
|
10455
10445
|
end
|
10456
10446
|
|
10457
10447
|
# Create strikethrough notification
|
10458
|
-
# Create a notification for the in the given Application. For more information, see [
|
10448
|
+
# Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
10459
10449
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10460
10450
|
# @param body [NewBaseNotification] body
|
10461
10451
|
# @param [Hash] opts the optional parameters
|
@@ -10466,7 +10456,7 @@ module TalonOne
|
|
10466
10456
|
end
|
10467
10457
|
|
10468
10458
|
# Create strikethrough notification
|
10469
|
-
# Create a notification for the in the given Application. For more information, see [
|
10459
|
+
# Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
10470
10460
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10471
10461
|
# @param body [NewBaseNotification] body
|
10472
10462
|
# @param [Hash] opts the optional parameters
|
@@ -10525,7 +10515,7 @@ module TalonOne
|
|
10525
10515
|
end
|
10526
10516
|
|
10527
10517
|
# Create notification about pending loyalty points
|
10528
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [
|
10518
|
+
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10529
10519
|
# @param loyalty_program_id [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.
|
10530
10520
|
# @param body [NewBaseNotification] body
|
10531
10521
|
# @param [Hash] opts the optional parameters
|
@@ -10536,7 +10526,7 @@ module TalonOne
|
|
10536
10526
|
end
|
10537
10527
|
|
10538
10528
|
# Create notification about pending loyalty points
|
10539
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [
|
10529
|
+
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
10540
10530
|
# @param loyalty_program_id [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.
|
10541
10531
|
# @param body [NewBaseNotification] body
|
10542
10532
|
# @param [Hash] opts the optional parameters
|
@@ -10597,7 +10587,7 @@ module TalonOne
|
|
10597
10587
|
# Deduct points from customer profile
|
10598
10588
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
10599
10589
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
10600
|
-
# @param integration_id [String] The identifier
|
10590
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
10601
10591
|
# @param body [DeductLoyaltyPoints] body
|
10602
10592
|
# @param [Hash] opts the optional parameters
|
10603
10593
|
# @return [nil]
|
@@ -10609,7 +10599,7 @@ module TalonOne
|
|
10609
10599
|
# Deduct points from customer profile
|
10610
10600
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
10611
10601
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
10612
|
-
# @param integration_id [String] The identifier
|
10602
|
+
# @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
10613
10603
|
# @param body [DeductLoyaltyPoints] body
|
10614
10604
|
# @param [Hash] opts the optional parameters
|
10615
10605
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -11298,11 +11288,11 @@ module TalonOne
|
|
11298
11288
|
# @option opts [String] :valid 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.
|
11299
11289
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
11300
11290
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
11301
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
11291
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11302
11292
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11303
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
11293
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
11304
11294
|
# @option opts [String] :campaign_state 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.
|
11305
|
-
# @return [
|
11295
|
+
# @return [InlineResponse20011]
|
11306
11296
|
def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
|
11307
11297
|
data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
|
11308
11298
|
data
|
@@ -11322,11 +11312,11 @@ module TalonOne
|
|
11322
11312
|
# @option opts [String] :valid 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.
|
11323
11313
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
11324
11314
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
11325
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
11315
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11326
11316
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11327
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
11317
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
11328
11318
|
# @option opts [String] :campaign_state 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.
|
11329
|
-
# @return [Array<(
|
11319
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
11330
11320
|
def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
|
11331
11321
|
if @api_client.config.debugging
|
11332
11322
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
|
@@ -11355,7 +11345,7 @@ module TalonOne
|
|
11355
11345
|
if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
|
11356
11346
|
fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
|
11357
11347
|
end
|
11358
|
-
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired"]
|
11348
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
11359
11349
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
11360
11350
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
11361
11351
|
end
|
@@ -11392,7 +11382,7 @@ module TalonOne
|
|
11392
11382
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11393
11383
|
|
11394
11384
|
# return_type
|
11395
|
-
return_type = opts[:return_type] || '
|
11385
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
11396
11386
|
|
11397
11387
|
# auth_names
|
11398
11388
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -11428,10 +11418,10 @@ module TalonOne
|
|
11428
11418
|
# @option opts [String] :valid 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.
|
11429
11419
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
11430
11420
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
11431
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
11432
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
11421
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11422
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
11433
11423
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11434
|
-
# @return [
|
11424
|
+
# @return [InlineResponse20011]
|
11435
11425
|
def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
|
11436
11426
|
data, _status_code, _headers = search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts)
|
11437
11427
|
data
|
@@ -11452,10 +11442,10 @@ module TalonOne
|
|
11452
11442
|
# @option opts [String] :valid 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.
|
11453
11443
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
11454
11444
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
11455
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
11456
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
11445
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11446
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
11457
11447
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
11458
|
-
# @return [Array<(
|
11448
|
+
# @return [Array<(InlineResponse20011, Integer, Hash)>] InlineResponse20011 data, response status code and response headers
|
11459
11449
|
def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
|
11460
11450
|
if @api_client.config.debugging
|
11461
11451
|
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_without_total_count ...'
|
@@ -11520,7 +11510,7 @@ module TalonOne
|
|
11520
11510
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11521
11511
|
|
11522
11512
|
# return_type
|
11523
|
-
return_type = opts[:return_type] || '
|
11513
|
+
return_type = opts[:return_type] || 'InlineResponse20011'
|
11524
11514
|
|
11525
11515
|
# auth_names
|
11526
11516
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -11914,7 +11904,7 @@ module TalonOne
|
|
11914
11904
|
end
|
11915
11905
|
|
11916
11906
|
# Update campaign
|
11917
|
-
# Update the given campaign.
|
11907
|
+
# 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.
|
11918
11908
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11919
11909
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11920
11910
|
# @param body [UpdateCampaign] body
|
@@ -11926,7 +11916,7 @@ module TalonOne
|
|
11926
11916
|
end
|
11927
11917
|
|
11928
11918
|
# Update campaign
|
11929
|
-
# Update the given campaign.
|
11919
|
+
# 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.
|
11930
11920
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11931
11921
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11932
11922
|
# @param body [UpdateCampaign] body
|
@@ -12072,7 +12062,7 @@ module TalonOne
|
|
12072
12062
|
end
|
12073
12063
|
|
12074
12064
|
# Update coupon
|
12075
|
-
# Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint
|
12065
|
+
# 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>
|
12076
12066
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
12077
12067
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
12078
12068
|
# @param coupon_id [String] The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
|
@@ -12085,7 +12075,7 @@ module TalonOne
|
|
12085
12075
|
end
|
12086
12076
|
|
12087
12077
|
# Update coupon
|
12088
|
-
# Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this <code>PUT</code> endpoint
|
12078
|
+
# 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>
|
12089
12079
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
12090
12080
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
12091
12081
|
# @param coupon_id [String] The internal ID of the coupon code. You can find this value in the `id` property from the [List coupons](https://docs.talon.one/management-api#tag/Coupons/operation/getCouponsWithoutTotalCount) endpoint response.
|
@@ -12154,7 +12144,7 @@ module TalonOne
|
|
12154
12144
|
end
|
12155
12145
|
|
12156
12146
|
# Update coupons
|
12157
|
-
# Update all coupons
|
12147
|
+
# 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).
|
12158
12148
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
12159
12149
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
12160
12150
|
# @param body [UpdateCouponBatch] body
|
@@ -12166,7 +12156,7 @@ module TalonOne
|
|
12166
12156
|
end
|
12167
12157
|
|
12168
12158
|
# Update coupons
|
12169
|
-
# Update all coupons
|
12159
|
+
# 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).
|
12170
12160
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
12171
12161
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
12172
12162
|
# @param body [UpdateCouponBatch] body
|