talon_one 5.0.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/.example/.bundle/config +2 -0
- data/.github/.example/Gemfile +6 -0
- data/.github/.example/Gemfile.lock +47 -0
- data/.github/.example/example.rb +85 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/gem.build_complete +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/gem_make.out +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/json/ext/generator.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/json/ext/parser.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/extensions/arm64-darwin-24/3.3.0/json-2.8.2/mkmf.log +177 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.github/workflows/ruby.yml +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.gitignore +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/.rspec +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/CHANGELOG.md +375 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Gemfile +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Guardfile +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/LICENSE +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/README.md +118 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/Rakefile +40 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/ethon.gemspec +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curl.rb +90 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/classes.rb +65 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/codes.rb +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/constants.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/form_options.rb +37 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/functions.rb +58 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/infos.rb +151 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/messages.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/options.rb +503 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/curls/settings.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/callbacks.rb +149 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/debug_info.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/features.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/form.rb +107 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/header.rb +61 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/actionable.rb +157 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/custom.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/delete.rb +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/get.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/head.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/options.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/patch.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/post.rb +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/postable.rb +32 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/put.rb +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http/putable.rb +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/http.rb +68 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/informations.rb +116 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/mirror.rb +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/operations.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/options.rb +50 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/params.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/queryable.rb +154 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/response_callbacks.rb +136 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy/util.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/easy.rb +315 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/ethon_error.rb +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/global_init.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/invalid_option.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/invalid_value.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_add.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_fdset.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_remove.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/multi_timeout.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors/select.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/errors.rb +17 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/libc.rb +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/loggable.rb +59 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/operations.rb +228 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/options.rb +117 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi/stack.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/multi.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon/version.rb +6 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/lib/ethon.rb +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/benchmarks.rb +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/memory_leaks.rb +114 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/perf_spec_helper.rb +37 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/memory_test_helpers.rb +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/os_memory_leak_tracker.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/profile/support/ruby_object_leak_tracker.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/curl_spec.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/callbacks_spec.rb +81 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/debug_info_spec.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/features_spec.rb +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/form_spec.rb +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/header_spec.rb +79 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/custom_spec.rb +177 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/delete_spec.rb +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/get_spec.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/head_spec.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/options_spec.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/patch_spec.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/post_spec.rb +317 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http/put_spec.rb +168 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/http_spec.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/informations_spec.rb +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/mirror_spec.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/operations_spec.rb +271 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/options_spec.rb +193 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/queryable_spec.rb +235 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/response_callbacks_spec.rb +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy/util_spec.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/easy_spec.rb +203 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/libc_spec.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/loggable_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/operations_spec.rb +298 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/options_spec.rb +182 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi/stack_spec.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/ethon/multi_spec.rb +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/spec_helper.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/support/localhost_server.rb +95 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ethon-0.16.0/spec/support/server.rb +115 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/CHANGELOG.md +456 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/COPYING +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/Gemfile +21 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/LICENSE +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/LICENSE.SPECS +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/README.md +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/Rakefile +206 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/ffi.gemspec +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.5/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.6/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/2.7/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.0/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.1/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.2/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/3.3/ffi_c.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/abstract_memory.rb +44 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/autopointer.rb +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/buffer.rb +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/callback.rb +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/compat.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/data_converter.rb +67 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/dynamic_library.rb +118 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/enum.rb +302 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/errno.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/ffi.rb +50 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/function.rb +71 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/io.rb +62 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/library.rb +576 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/library_path.rb +109 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/managedstruct.rb +84 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/memorypointer.rb +1 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-darwin/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-freebsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-freebsd12/types.conf +181 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-linux/types.conf +175 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-openbsd/types.conf +134 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/aarch64-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-freebsd/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-freebsd12/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/arm-linux/types.conf +132 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/hppa1.1-linux/types.conf +178 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/hppa2.0-linux/types.conf +178 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-cygwin/types.conf +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-darwin/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-freebsd/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-freebsd12/types.conf +152 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-gnu/types.conf +107 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-linux/types.conf +103 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-netbsd/types.conf +126 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-openbsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-solaris/types.conf +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/i386-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/ia64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/loongarch64-linux/types.conf +141 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mips64el-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsel-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa32r6-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa32r6el-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa64r6-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/mipsisa64r6el-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-aix/types.conf +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-darwin/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-linux/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc-openbsd/types.conf +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/powerpc64le-linux/types.conf +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/riscv64-linux/types.conf +104 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/s390-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/s390x-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparc-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparc-solaris/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-linux/types.conf +102 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-openbsd/types.conf +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sparcv9-solaris/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/sw_64-linux/types.conf +141 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-cygwin/types.conf +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-darwin/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-dragonflybsd/types.conf +130 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-freebsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-freebsd12/types.conf +158 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-haiku/types.conf +117 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-linux/types.conf +132 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-msys/types.conf +119 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-netbsd/types.conf +128 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-openbsd/types.conf +134 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-solaris/types.conf +122 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform/x86_64-windows/types.conf +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/platform.rb +187 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/pointer.rb +167 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct.rb +317 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_by_reference.rb +72 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_layout.rb +96 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/struct_layout_builder.rb +227 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/const_generator.rb +232 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/generator.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/generator_task.rb +32 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/struct_generator.rb +195 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/tools/types_generator.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/types.rb +222 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/union.rb +43 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/variadic.rb +80 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi/version.rb +3 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/lib/ffi.rb +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/rakelib/ffi_gem_helper.rb +65 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/getlogin.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/getpid.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/gettimeofday.rb +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/hello.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/hello_ractor.rb +11 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/inotify.rb +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/pty.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/qsort.rb +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/samples/qsort_ractor.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/abstract_memory.rbs +165 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/auto_pointer.rbs +27 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/buffer.rbs +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/data_converter.rbs +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/dynamic_library.rbs +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/enum.rbs +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/function.rbs +39 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/library.rbs +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/native_type.rbs +86 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/pointer.rbs +42 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct.rbs +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_by_reference.rbs +11 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_by_value.rbs +7 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_layout.rbs +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/struct_layout_builder.rbs +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi/type.rbs +39 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/ffi-1.17.0-arm64-darwin/sig/ffi.rbs +26 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/BSDL +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/CHANGES.md +559 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/COPYING +56 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/LEGAL +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/README.md +195 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/fbuffer/fbuffer.h +184 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/Makefile +270 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/extconf.rb +10 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/generator/generator.c +1663 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/Makefile +270 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/extconf.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/parser.c +3238 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/ext/json/ext/parser/parser.rl +1465 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/json.gemspec +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/bigdecimal.rb +58 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/complex.rb +51 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/core.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/date.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/date_time.rb +67 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/exception.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/ostruct.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/range.rb +54 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/rational.rb +49 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/regexp.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/set.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/struct.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/symbol.rb +47 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/add/time.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/common.rb +876 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/generator/state.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/generator.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext/parser.bundle +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/ext.rb +23 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/generic_object.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/truffle_ruby/generator.rb +621 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json/version.rb +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/json-2.8.2/lib/json.rb +587 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.github/workflows/ci.yml +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.github/workflows/experimental.yml +33 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.gitignore +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/.rspec +4 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/CHANGELOG.md +410 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/CONTRIBUTING.md +20 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Gemfile +36 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Guardfile +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/LICENSE +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/README.md +588 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/Rakefile +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/UPGRADE.md +55 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus/middleware/params_decoder/helper.rb +76 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus/middleware/params_decoder.rb +57 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/rack/typhoeus.rb +1 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/adapters/faraday.rb +180 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/dalli.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/rails.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/cache/redis.rb +35 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/config.rb +85 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/easy_factory.rb +206 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors/no_stub.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors/typhoeus_error.rb +8 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/errors.rb +9 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/expectation.rb +217 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/addable.rb +23 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/before.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/block_connection.rb +35 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/cacheable.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/memoizable.rb +56 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/queueable.rb +83 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/runnable.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra/stubbable.rb +28 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/hydra.rb +95 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/pool.rb +70 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/railtie.rb +12 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/actions.rb +125 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/before.rb +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/block_connection.rb +52 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/cacheable.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/callbacks.rb +151 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/marshal.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/memoizable.rb +38 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/operations.rb +40 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/responseable.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/streamable.rb +34 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request/stubbable.rb +30 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/request.rb +223 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/cacheable.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/header.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/informations.rb +305 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response/status.rb +106 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/response.rb +68 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus/version.rb +5 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/lib/typhoeus.rb +143 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/perf/profile.rb +14 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/perf/vs_nethttp.rb +64 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/rack/typhoeus/middleware/params_decoder/helper_spec.rb +156 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/rack/typhoeus/middleware/params_decoder_spec.rb +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/spec_helper.rb +29 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/localhost_server.rb +94 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/memory_cache.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/support/server.rb +116 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/adapters/faraday_spec.rb +339 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/cache/dalli_spec.rb +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/cache/redis_spec.rb +41 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/config_spec.rb +15 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/easy_factory_spec.rb +143 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/errors/no_stub_spec.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/expectation_spec.rb +280 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/addable_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/before_spec.rb +98 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/block_connection_spec.rb +18 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/cacheable_spec.rb +88 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/memoizable_spec.rb +53 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/queueable_spec.rb +98 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/runnable_spec.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra/stubbable_spec.rb +48 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/hydra_spec.rb +22 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/pool_spec.rb +137 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/actions_spec.rb +19 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/before_spec.rb +93 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/block_connection_spec.rb +75 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/cacheable_spec.rb +94 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/callbacks_spec.rb +91 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/marshal_spec.rb +60 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/memoizable_spec.rb +34 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/operations_spec.rb +101 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/responseable_spec.rb +13 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request/stubbable_spec.rb +45 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/request_spec.rb +256 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/header_spec.rb +147 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/informations_spec.rb +323 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response/status_spec.rb +256 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus/response_spec.rb +100 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/spec/typhoeus_spec.rb +105 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/gems/typhoeus-1.4.1/typhoeus.gemspec +25 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/ethon-0.16.0.gemspec +24 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/ffi-1.17.0-arm64-darwin.gemspec +31 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/json-2.8.2.gemspec +0 -0
- data/.github/.example/vendor/bundle/ruby/3.3.0/specifications/typhoeus-1.4.1.gemspec +24 -0
- data/.github/dependabot.yml +10 -0
- data/.github/workflows/test.yml +75 -0
- data/README.md +565 -521
- data/docker-compose.yml +47 -0
- data/docs/AccountAnalytics.md +1 -1
- data/docs/Achievement.md +8 -0
- data/docs/AchievementProgress.md +2 -0
- data/docs/AdditionalCampaignProperties.md +4 -2
- data/docs/AnalyticsDataPoint.md +19 -0
- data/docs/AnalyticsDataPointWithTrend.md +19 -0
- data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
- data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
- data/docs/AnalyticsProduct.md +23 -0
- data/docs/AnalyticsProductSKU.md +21 -0
- data/docs/Application.md +4 -0
- data/docs/ApplicationAnalyticsDataPoint.md +6 -6
- data/docs/ApplicationCIF.md +33 -0
- data/docs/ApplicationCIFExpression.md +27 -0
- data/docs/ApplicationCampaignAnalytics.md +13 -19
- data/docs/ApplicationCampaignStats.md +3 -3
- data/docs/ApplicationCustomer.md +8 -8
- data/docs/ApplicationSession.md +2 -2
- data/docs/AsyncCouponDeletionJobResponse.md +17 -0
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseLoyaltyProgram.md +10 -4
- data/docs/BaseNotification.md +1 -1
- data/docs/BaseNotificationEntity.md +1 -1
- data/docs/BulkOperationOnCampaigns.md +3 -1
- data/docs/Campaign.md +18 -2
- data/docs/CampaignCollectionEditedNotification.md +21 -0
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignStateChangedNotification.md +2 -2
- data/docs/CampaignStoreBudget.md +25 -0
- data/docs/CampaignTemplate.md +3 -1
- data/docs/CampaignTemplateCouponReservationSettings.md +19 -0
- data/docs/CampaignVersions.md +29 -0
- data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/CartItem.md +1 -1
- data/docs/Change.md +1 -1
- data/docs/CodeGeneratorSettings.md +1 -1
- data/docs/Coupon.md +1 -1
- data/docs/CouponConstraints.md +1 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionFilters.md +43 -0
- data/docs/CouponDeletionJob.md +39 -0
- data/docs/CreateAchievement.md +9 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileAudienceRequestItem.md +1 -1
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +10 -8
- data/docs/Effect.md +8 -0
- data/docs/EffectEntity.md +9 -1
- data/docs/Environment.md +3 -1
- data/docs/Event.md +1 -1
- data/docs/FeatureFlag.md +1 -1
- data/docs/GenerateCampaignDescription.md +19 -0
- data/docs/GenerateCampaignTags.md +17 -0
- data/docs/GenerateItemFilterDescription.md +17 -0
- data/docs/GenerateLoyaltyCard.md +21 -0
- data/docs/GenerateRuleTitle.md +19 -0
- data/docs/GenerateRuleTitleRule.md +19 -0
- data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +4 -2
- data/docs/InlineResponse20022.md +3 -3
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -3
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +5 -3
- data/docs/InlineResponse20030.md +1 -3
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +3 -1
- data/docs/InlineResponse20033.md +3 -5
- data/docs/InlineResponse20034.md +5 -3
- data/docs/InlineResponse20035.md +3 -5
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +4 -2
- data/docs/InlineResponse20042.md +2 -4
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +5 -3
- data/docs/InlineResponse20045.md +1 -3
- data/docs/InlineResponse20046.md +3 -3
- data/docs/IntegrationApi.md +73 -12
- data/docs/IntegrationCoupon.md +1 -1
- data/docs/IntegrationCustomerSessionResponse.md +1 -1
- data/docs/InventoryCoupon.md +1 -1
- data/docs/InventoryReferral.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/ListCampaignStoreBudgets.md +23 -0
- data/docs/ListCampaignStoreBudgetsStore.md +21 -0
- data/docs/LoyaltyBalanceWithTier.md +31 -0
- data/docs/LoyaltyBalancesWithTiers.md +19 -0
- data/docs/LoyaltyCard.md +10 -2
- data/docs/LoyaltyCardBatch.md +23 -0
- data/docs/LoyaltyCardBatchResponse.md +19 -0
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +19 -9
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramEntity.md +5 -1
- data/docs/LoyaltyTier.md +6 -2
- data/docs/ManagementApi.md +1159 -258
- data/docs/MessageLogEntry.md +10 -2
- data/docs/MessageLogResponse.md +3 -3
- data/docs/NewAppWideCouponDeletionJob.md +19 -0
- data/docs/NewApplication.md +3 -1
- data/docs/NewApplicationCIF.md +27 -0
- data/docs/NewApplicationCIFExpression.md +21 -0
- data/docs/NewBaseNotification.md +1 -1
- data/docs/NewCampaignStoreBudget.md +21 -0
- data/docs/NewCampaignStoreBudgetStoreLimit.md +19 -0
- data/docs/NewCampaignTemplate.md +2 -0
- data/docs/NewCouponCreationJob.md +1 -1
- data/docs/NewCouponDeletionJob.md +17 -0
- data/docs/NewCoupons.md +1 -1
- data/docs/NewCouponsForMultipleRecipients.md +1 -1
- data/docs/NewCustomerSessionV2.md +4 -4
- data/docs/NewLoyaltyProgram.md +10 -4
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewOutgoingIntegrationWebhook.md +2 -0
- data/docs/NewPicklist.md +1 -1
- data/docs/NewReferral.md +1 -1
- data/docs/NewReferralsForMultipleAdvocates.md +1 -1
- data/docs/NewRevisionVersion.md +37 -0
- data/docs/NewWebhook.md +3 -1
- data/docs/OktaEvent.md +19 -0
- data/docs/OktaEventPayload.md +17 -0
- data/docs/OktaEventPayloadData.md +17 -0
- data/docs/OktaEventTarget.md +21 -0
- data/docs/Picklist.md +1 -1
- data/docs/Product.md +1 -1
- data/docs/ProductSearchMatch.md +21 -0
- data/docs/ProductSkuUnitAnalytics.md +23 -0
- data/docs/ProductUnitAnalytics.md +25 -0
- data/docs/ProjectedTier.md +21 -0
- data/docs/Referral.md +1 -1
- data/docs/ReferralConstraints.md +1 -1
- data/docs/RejectCouponEffectProps.md +3 -1
- data/docs/RejectReferralEffectProps.md +3 -1
- data/docs/Revision.md +35 -0
- data/docs/RevisionActivation.md +17 -0
- data/docs/RevisionVersion.md +53 -0
- data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
- data/docs/RuleFailureReason.md +5 -1
- data/docs/SSOConfig.md +3 -1
- data/docs/ScimBaseUser.md +23 -0
- data/docs/ScimBaseUserName.md +17 -0
- data/docs/ScimNewUser.md +23 -0
- data/docs/ScimPatchOperation.md +21 -0
- data/docs/ScimPatchRequest.md +19 -0
- data/docs/ScimResource.md +21 -0
- data/docs/ScimResourceTypesListResponse.md +17 -0
- data/docs/ScimSchemaResource.md +23 -0
- data/docs/ScimSchemasListResponse.md +21 -0
- data/docs/ScimServiceProviderConfigResponse.md +29 -0
- data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
- data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
- data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
- data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
- data/docs/ScimServiceProviderConfigResponseSort.md +17 -0
- data/docs/ScimUser.md +25 -0
- data/docs/ScimUsersListResponse.md +21 -0
- data/docs/Store.md +2 -2
- data/docs/StrikethroughDebugResponse.md +19 -0
- data/docs/SummaryCampaignStoreBudget.md +21 -0
- data/docs/TemplateArgDef.md +2 -0
- data/docs/Tier.md +3 -1
- data/docs/TransferLoyaltyCard.md +3 -1
- data/docs/UpdateAchievement.md +9 -1
- data/docs/UpdateApplication.md +5 -1
- data/docs/UpdateApplicationCIF.md +23 -0
- data/docs/UpdateCampaign.md +1 -1
- data/docs/UpdateCampaignTemplate.md +2 -0
- data/docs/UpdateCoupon.md +1 -1
- data/docs/UpdateCouponBatch.md +1 -1
- data/docs/UpdateLoyaltyCard.md +4 -2
- data/docs/UpdateLoyaltyProgram.md +10 -4
- data/docs/UpdateLoyaltyProgramTier.md +21 -0
- data/docs/UpdatePicklist.md +1 -1
- data/docs/UpdateReferral.md +1 -1
- data/docs/UpdateReferralBatch.md +1 -1
- data/docs/User.md +4 -2
- data/docs/ValueMap.md +23 -0
- data/docs/Webhook.md +3 -1
- data/docs/WebhookLogEntry.md +1 -1
- data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
- data/lib/talon_one/api/integration_api.rb +94 -18
- data/lib/talon_one/api/management_api.rb +1347 -387
- data/lib/talon_one/models/account.rb +0 -1
- data/lib/talon_one/models/account_additional_cost.rb +0 -1
- data/lib/talon_one/models/achievement.rb +87 -2
- data/lib/talon_one/models/achievement_progress.rb +16 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +22 -7
- data/lib/talon_one/models/analytics_data_point.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
- data/lib/talon_one/models/analytics_product.rb +252 -0
- data/lib/talon_one/models/analytics_product_sku.rb +242 -0
- data/lib/talon_one/models/application.rb +21 -2
- data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
- data/lib/talon_one/models/application_api_key.rb +0 -1
- data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
- data/lib/talon_one/models/application_campaign_stats.rb +16 -16
- data/lib/talon_one/models/application_cif.rb +307 -0
- data/lib/talon_one/models/application_cif_expression.rb +274 -0
- data/lib/talon_one/models/application_customer.rb +4 -5
- data/lib/talon_one/models/application_event.rb +0 -1
- data/lib/talon_one/models/application_referee.rb +0 -1
- data/lib/talon_one/models/application_session.rb +1 -2
- data/lib/talon_one/models/async_coupon_deletion_job_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +2 -3
- data/lib/talon_one/models/audience.rb +0 -1
- data/lib/talon_one/models/audience_customer.rb +1 -2
- data/lib/talon_one/models/base_loyalty_program.rb +62 -21
- data/lib/talon_one/models/base_notification.rb +3 -3
- data/lib/talon_one/models/base_notification_entity.rb +1 -0
- data/lib/talon_one/models/base_notification_webhook.rb +0 -1
- data/lib/talon_one/models/bulk_operation_on_campaigns.rb +16 -6
- data/lib/talon_one/models/campaign.rb +106 -8
- data/lib/talon_one/models/campaign_analytics.rb +0 -1
- data/lib/talon_one/models/campaign_collection.rb +0 -1
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +0 -1
- data/lib/talon_one/models/campaign_evaluation_group.rb +0 -1
- data/lib/talon_one/models/campaign_group.rb +0 -1
- data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
- data/lib/talon_one/models/campaign_set.rb +0 -1
- data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
- data/lib/talon_one/models/campaign_store_budget.rb +274 -0
- data/lib/talon_one/models/campaign_template.rb +10 -2
- data/lib/talon_one/models/campaign_template_coupon_reservation_settings.rb +243 -0
- data/lib/talon_one/models/campaign_versions.rb +303 -0
- data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +11 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +11 -0
- data/lib/talon_one/models/cart_item.rb +1 -1
- data/lib/talon_one/models/catalog.rb +0 -1
- data/lib/talon_one/models/catalog_item.rb +0 -1
- data/lib/talon_one/models/change.rb +0 -1
- data/lib/talon_one/models/code_generator_settings.rb +12 -1
- data/lib/talon_one/models/collection.rb +0 -1
- data/lib/talon_one/models/collection_item.rb +0 -1
- data/lib/talon_one/models/collection_without_payload.rb +0 -1
- data/lib/talon_one/models/coupon.rb +1 -2
- data/lib/talon_one/models/coupon_constraints.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +1 -2
- data/lib/talon_one/models/coupon_deletion_filters.rb +373 -0
- data/lib/talon_one/models/coupon_deletion_job.rb +369 -0
- data/lib/talon_one/models/create_achievement.rb +90 -4
- data/lib/talon_one/models/custom_effect.rb +0 -1
- data/lib/talon_one/models/customer_profile.rb +1 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +1 -1
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +1 -1
- data/lib/talon_one/models/customer_session.rb +0 -1
- data/lib/talon_one/models/customer_session_v2.rb +20 -10
- data/lib/talon_one/models/deactivate_user_request.rb +0 -1
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/effect.rb +42 -2
- data/lib/talon_one/models/effect_entity.rb +44 -4
- data/lib/talon_one/models/environment.rb +16 -5
- data/lib/talon_one/models/event.rb +0 -6
- data/lib/talon_one/models/event_type.rb +0 -1
- data/lib/talon_one/models/event_v2.rb +0 -1
- data/lib/talon_one/models/export.rb +0 -1
- data/lib/talon_one/models/features_feed.rb +0 -1
- data/lib/talon_one/models/generate_campaign_description.rb +227 -0
- data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
- data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
- data/lib/talon_one/models/generate_loyalty_card.rb +292 -0
- data/lib/talon_one/models/generate_rule_title.rb +226 -0
- data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
- data/lib/talon_one/models/giveaway.rb +0 -1
- data/lib/talon_one/models/import.rb +0 -1
- data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +1 -1
- data/lib/talon_one/models/inline_response20021.rb +11 -7
- data/lib/talon_one/models/inline_response20022.rb +10 -10
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +6 -10
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -6
- data/lib/talon_one/models/inline_response20027.rb +6 -1
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +11 -7
- data/lib/talon_one/models/inline_response20030.rb +2 -11
- data/lib/talon_one/models/inline_response20031.rb +1 -1
- data/lib/talon_one/models/inline_response20032.rb +11 -2
- data/lib/talon_one/models/inline_response20033.rb +7 -11
- data/lib/talon_one/models/inline_response20034.rb +11 -7
- data/lib/talon_one/models/inline_response20035.rb +7 -11
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +1 -1
- data/lib/talon_one/models/inline_response20038.rb +1 -1
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +11 -7
- data/lib/talon_one/models/inline_response20042.rb +7 -11
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +11 -7
- data/lib/talon_one/models/inline_response20045.rb +2 -11
- data/lib/talon_one/models/inline_response20046.rb +6 -1
- data/lib/talon_one/models/integration_coupon.rb +1 -2
- data/lib/talon_one/models/integration_customer_session_response.rb +1 -0
- data/lib/talon_one/models/integration_event.rb +0 -1
- data/lib/talon_one/models/integration_event_v2_request.rb +0 -1
- data/lib/talon_one/models/inventory_coupon.rb +1 -2
- data/lib/talon_one/models/inventory_referral.rb +1 -2
- data/lib/talon_one/models/item_attribute.rb +0 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +3 -3
- data/lib/talon_one/models/library_attribute.rb +0 -1
- data/lib/talon_one/models/limit_counter.rb +0 -1
- data/lib/talon_one/models/list_campaign_store_budgets.rb +248 -0
- data/lib/talon_one/models/list_campaign_store_budgets_store.rb +239 -0
- data/lib/talon_one/models/login_params.rb +0 -1
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
- data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +78 -6
- data/lib/talon_one/models/loyalty_card_balances.rb +1 -1
- data/lib/talon_one/models/loyalty_card_batch.rb +312 -0
- data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
- data/lib/talon_one/models/loyalty_program.rb +90 -27
- data/lib/talon_one/models/loyalty_program_balance.rb +2 -2
- data/lib/talon_one/models/loyalty_program_entity.rb +24 -4
- data/lib/talon_one/models/loyalty_program_transaction.rb +11 -0
- data/lib/talon_one/models/loyalty_tier.rb +24 -4
- data/lib/talon_one/models/management_key.rb +0 -1
- data/lib/talon_one/models/message_log_entry.rb +67 -7
- data/lib/talon_one/models/message_log_response.rb +3 -22
- data/lib/talon_one/models/model_return.rb +0 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +0 -1
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +0 -1
- data/lib/talon_one/models/new_additional_cost.rb +0 -1
- data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
- data/lib/talon_one/models/new_application.rb +14 -4
- data/lib/talon_one/models/new_application_api_key.rb +0 -1
- data/lib/talon_one/models/new_application_cif.rb +262 -0
- data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
- data/lib/talon_one/models/new_attribute.rb +2 -3
- data/lib/talon_one/models/new_audience.rb +0 -1
- data/lib/talon_one/models/new_base_notification.rb +1 -1
- data/lib/talon_one/models/new_campaign.rb +0 -1
- data/lib/talon_one/models/new_campaign_collection.rb +0 -1
- data/lib/talon_one/models/new_campaign_set.rb +0 -1
- data/lib/talon_one/models/new_campaign_store_budget.rb +283 -0
- data/lib/talon_one/models/new_campaign_store_budget_store_limit.rb +227 -0
- data/lib/talon_one/models/new_campaign_template.rb +10 -1
- data/lib/talon_one/models/new_catalog.rb +0 -1
- data/lib/talon_one/models/new_collection.rb +0 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +1 -2
- data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
- data/lib/talon_one/models/new_coupons.rb +1 -2
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -2
- data/lib/talon_one/models/new_custom_effect.rb +0 -1
- data/lib/talon_one/models/new_customer_session.rb +0 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +3 -3
- data/lib/talon_one/models/new_event.rb +0 -1
- data/lib/talon_one/models/new_event_type.rb +0 -1
- data/lib/talon_one/models/new_loyalty_program.rb +63 -22
- data/lib/talon_one/models/new_loyalty_tier.rb +2 -2
- data/lib/talon_one/models/new_management_key.rb +0 -1
- data/lib/talon_one/models/new_multiple_audiences_item.rb +0 -1
- data/lib/talon_one/models/new_notification_test.rb +2 -2
- data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
- data/lib/talon_one/models/new_referral.rb +1 -2
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -2
- data/lib/talon_one/models/new_revision_version.rb +352 -0
- data/lib/talon_one/models/new_role.rb +0 -1
- data/lib/talon_one/models/new_role_v2.rb +0 -1
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_store.rb +0 -1
- data/lib/talon_one/models/new_user.rb +0 -1
- data/lib/talon_one/models/new_webhook.rb +12 -3
- data/lib/talon_one/models/okta_event.rb +229 -0
- data/lib/talon_one/models/okta_event_payload.rb +212 -0
- data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
- data/lib/talon_one/models/okta_event_target.rb +243 -0
- data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +0 -1
- data/lib/talon_one/models/picklist.rb +0 -1
- data/lib/talon_one/models/product.rb +1 -1
- data/lib/talon_one/models/product_search_match.rb +237 -0
- data/lib/talon_one/models/product_sku_unit_analytics.rb +256 -0
- data/lib/talon_one/models/product_unit_analytics.rb +271 -0
- data/lib/talon_one/models/projected_tier.rb +232 -0
- data/lib/talon_one/models/referral.rb +1 -2
- data/lib/talon_one/models/referral_constraints.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
- data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
- data/lib/talon_one/models/revision.rb +318 -0
- data/lib/talon_one/models/revision_activation.rb +206 -0
- data/lib/talon_one/models/revision_version.rb +465 -0
- data/lib/talon_one/models/role.rb +0 -1
- data/lib/talon_one/models/role_assign.rb +0 -1
- data/lib/talon_one/models/role_v2.rb +0 -1
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +11 -0
- data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
- data/lib/talon_one/models/rule_failure_reason.rb +24 -4
- data/lib/talon_one/models/ruleset.rb +0 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_user.rb +237 -0
- data/lib/talon_one/models/scim_base_user_name.rb +208 -0
- data/lib/talon_one/models/scim_new_user.rb +242 -0
- data/lib/talon_one/models/scim_patch_operation.rb +267 -0
- data/lib/talon_one/models/scim_patch_request.rb +226 -0
- data/lib/talon_one/models/scim_resource.rb +228 -0
- data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
- data/lib/talon_one/models/scim_schema_resource.rb +239 -0
- data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
- data/lib/talon_one/models/scim_service_provider_config_response.rb +265 -0
- data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
- data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
- data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
- data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
- data/lib/talon_one/models/scim_service_provider_config_response_sort.rb +208 -0
- data/lib/talon_one/models/scim_user.rb +257 -0
- data/lib/talon_one/models/scim_users_list_response.rb +236 -0
- data/lib/talon_one/models/sso_config.rb +14 -4
- data/lib/talon_one/models/store.rb +1 -2
- data/lib/talon_one/models/strikethrough_debug_response.rb +221 -0
- data/lib/talon_one/models/summary_campaign_store_budget.rb +280 -0
- data/lib/talon_one/models/talang_attribute.rb +0 -1
- data/lib/talon_one/models/template_arg_def.rb +11 -2
- data/lib/talon_one/models/template_def.rb +0 -1
- data/lib/talon_one/models/template_limit_config.rb +0 -1
- data/lib/talon_one/models/tier.rb +12 -2
- data/lib/talon_one/models/transfer_loyalty_card.rb +25 -4
- data/lib/talon_one/models/update_achievement.rb +90 -4
- data/lib/talon_one/models/update_application.rb +24 -4
- data/lib/talon_one/models/update_application_cif.rb +237 -0
- data/lib/talon_one/models/update_campaign.rb +1 -1
- data/lib/talon_one/models/update_campaign_evaluation_group.rb +0 -1
- data/lib/talon_one/models/update_campaign_group.rb +0 -1
- data/lib/talon_one/models/update_campaign_template.rb +10 -1
- data/lib/talon_one/models/update_coupon.rb +1 -2
- data/lib/talon_one/models/update_coupon_batch.rb +1 -2
- data/lib/talon_one/models/update_loyalty_card.rb +15 -5
- data/lib/talon_one/models/update_loyalty_program.rb +63 -22
- data/lib/talon_one/models/update_loyalty_program_tier.rb +257 -0
- data/lib/talon_one/models/update_picklist.rb +0 -1
- data/lib/talon_one/models/update_referral.rb +1 -1
- data/lib/talon_one/models/update_referral_batch.rb +1 -1
- data/lib/talon_one/models/user.rb +14 -5
- data/lib/talon_one/models/value_map.rb +245 -0
- data/lib/talon_one/models/webhook.rb +12 -3
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +12 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +69 -15
- data/spec/api/integration_api_spec.rb +22 -7
- data/spec/api/management_api_spec.rb +284 -98
- data/spec/models/achievement_progress_spec.rb +6 -0
- data/spec/models/achievement_spec.rb +32 -0
- data/spec/models/additional_campaign_properties_spec.rb +7 -1
- data/spec/models/analytics_data_point_spec.rb +47 -0
- data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
- data/spec/models/analytics_product_sku_spec.rb +53 -0
- data/spec/models/analytics_product_spec.rb +59 -0
- data/spec/models/application_campaign_analytics_spec.rb +1 -19
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_cif_expression_spec.rb +71 -0
- data/spec/models/application_cif_spec.rb +89 -0
- data/spec/models/application_spec.rb +12 -0
- data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +26 -4
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/bulk_operation_on_campaigns_spec.rb +7 -1
- data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +53 -1
- data/spec/models/campaign_store_budget_spec.rb +65 -0
- data/spec/models/campaign_template_coupon_reservation_settings_spec.rb +47 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/campaign_versions_spec.rb +81 -0
- data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/coupon_deletion_filters_spec.rb +123 -0
- data/spec/models/coupon_deletion_job_spec.rb +107 -0
- data/spec/models/create_achievement_spec.rb +32 -0
- data/spec/models/customer_session_v2_spec.rb +6 -0
- data/spec/models/effect_entity_spec.rb +24 -0
- data/spec/models/effect_spec.rb +24 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/generate_campaign_description_spec.rb +47 -0
- data/spec/models/generate_campaign_tags_spec.rb +41 -0
- data/spec/models/generate_item_filter_description_spec.rb +41 -0
- data/spec/models/generate_loyalty_card_spec.rb +57 -0
- data/spec/models/generate_rule_title_rule_spec.rb +47 -0
- data/spec/models/generate_rule_title_spec.rb +47 -0
- data/spec/models/inline_response20021_spec.rb +6 -0
- data/spec/models/inline_response20022_spec.rb +2 -2
- data/spec/models/inline_response20024_spec.rb +0 -6
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +6 -0
- data/spec/models/inline_response20030_spec.rb +0 -6
- data/spec/models/inline_response20032_spec.rb +6 -0
- data/spec/models/inline_response20033_spec.rb +0 -6
- data/spec/models/inline_response20034_spec.rb +6 -0
- data/spec/models/inline_response20035_spec.rb +0 -6
- data/spec/models/inline_response20041_spec.rb +6 -0
- data/spec/models/inline_response20042_spec.rb +0 -6
- data/spec/models/inline_response20044_spec.rb +6 -0
- data/spec/models/inline_response20045_spec.rb +0 -6
- data/spec/models/limit_config_spec.rb +1 -1
- data/spec/models/list_campaign_store_budgets_spec.rb +59 -0
- data/spec/models/list_campaign_store_budgets_store_spec.rb +53 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
- data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_spec.rb +63 -0
- data/spec/models/loyalty_card_spec.rb +24 -0
- data/spec/models/loyalty_program_entity_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +38 -4
- data/spec/models/loyalty_tier_spec.rb +12 -0
- data/spec/models/message_log_entry_spec.rb +25 -1
- data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
- data/spec/models/new_application_cif_expression_spec.rb +53 -0
- data/spec/models/new_application_cif_spec.rb +71 -0
- data/spec/models/new_application_spec.rb +6 -0
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_campaign_store_budget_spec.rb +61 -0
- data/spec/models/new_campaign_store_budget_store_limit_spec.rb +47 -0
- data/spec/models/new_campaign_template_spec.rb +6 -0
- data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
- data/spec/models/new_loyalty_program_spec.rb +26 -4
- data/spec/models/new_notification_test_spec.rb +1 -1
- data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
- data/spec/models/new_revision_version_spec.rb +105 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/okta_event_payload_data_spec.rb +41 -0
- data/spec/models/okta_event_payload_spec.rb +41 -0
- data/spec/models/okta_event_spec.rb +47 -0
- data/spec/models/okta_event_target_spec.rb +53 -0
- data/spec/models/product_search_match_spec.rb +53 -0
- data/spec/models/product_sku_unit_analytics_spec.rb +59 -0
- data/spec/models/product_unit_analytics_spec.rb +65 -0
- data/spec/models/projected_tier_spec.rb +53 -0
- data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
- data/spec/models/reject_referral_effect_props_spec.rb +6 -0
- data/spec/models/revision_activation_spec.rb +41 -0
- data/spec/models/revision_spec.rb +95 -0
- data/spec/models/revision_version_spec.rb +153 -0
- data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
- data/spec/models/rule_failure_reason_spec.rb +12 -0
- data/spec/models/scim_base_user_name_spec.rb +41 -0
- data/spec/models/scim_base_user_spec.rb +59 -0
- data/spec/models/scim_new_user_spec.rb +59 -0
- data/spec/models/scim_patch_operation_spec.rb +57 -0
- data/spec/models/scim_patch_request_spec.rb +47 -0
- data/spec/models/scim_resource_spec.rb +53 -0
- data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
- data/spec/models/scim_schema_resource_spec.rb +59 -0
- data/spec/models/scim_schemas_list_response_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
- data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_sort_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_spec.rb +77 -0
- data/spec/models/scim_user_spec.rb +65 -0
- data/spec/models/scim_users_list_response_spec.rb +53 -0
- data/spec/models/sso_config_spec.rb +6 -0
- data/spec/models/strikethrough_debug_response_spec.rb +47 -0
- data/spec/models/summary_campaign_store_budget_spec.rb +61 -0
- data/spec/models/template_arg_def_spec.rb +6 -0
- data/spec/models/template_limit_config_spec.rb +1 -1
- data/spec/models/tier_spec.rb +6 -0
- data/spec/models/transfer_loyalty_card_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +32 -0
- data/spec/models/update_application_cif_spec.rb +59 -0
- data/spec/models/update_application_spec.rb +12 -0
- data/spec/models/update_campaign_template_spec.rb +6 -0
- data/spec/models/update_loyalty_card_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +26 -4
- data/spec/models/update_loyalty_program_tier_spec.rb +53 -0
- data/spec/models/user_spec.rb +6 -0
- data/spec/models/value_map_spec.rb +59 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +663 -6
@@ -19,9 +19,9 @@ module TalonOne
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
24
|
-
# @param body [
|
22
|
+
# Enable user by email address
|
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 [DeactivateUserRequest] body
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
27
27
|
def activate_user_by_email(body, opts = {})
|
@@ -29,9 +29,9 @@ module TalonOne
|
|
29
29
|
nil
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
33
|
-
#
|
34
|
-
# @param body [
|
32
|
+
# Enable user by email address
|
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 [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 = {})
|
@@ -581,6 +581,76 @@ module TalonOne
|
|
581
581
|
return data, status_code, headers
|
582
582
|
end
|
583
583
|
|
584
|
+
# Create loyalty cards
|
585
|
+
# Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
|
586
|
+
# @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.
|
587
|
+
# @param body [LoyaltyCardBatch] body
|
588
|
+
# @param [Hash] opts the optional parameters
|
589
|
+
# @return [LoyaltyCardBatchResponse]
|
590
|
+
def create_batch_loyalty_cards(loyalty_program_id, body, opts = {})
|
591
|
+
data, _status_code, _headers = create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts)
|
592
|
+
data
|
593
|
+
end
|
594
|
+
|
595
|
+
# Create loyalty cards
|
596
|
+
# Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code.
|
597
|
+
# @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.
|
598
|
+
# @param body [LoyaltyCardBatch] body
|
599
|
+
# @param [Hash] opts the optional parameters
|
600
|
+
# @return [Array<(LoyaltyCardBatchResponse, Integer, Hash)>] LoyaltyCardBatchResponse data, response status code and response headers
|
601
|
+
def create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, opts = {})
|
602
|
+
if @api_client.config.debugging
|
603
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.create_batch_loyalty_cards ...'
|
604
|
+
end
|
605
|
+
# verify the required parameter 'loyalty_program_id' is set
|
606
|
+
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
607
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.create_batch_loyalty_cards"
|
608
|
+
end
|
609
|
+
# verify the required parameter 'body' is set
|
610
|
+
if @api_client.config.client_side_validation && body.nil?
|
611
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_batch_loyalty_cards"
|
612
|
+
end
|
613
|
+
# resource path
|
614
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/batch'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
615
|
+
|
616
|
+
# query parameters
|
617
|
+
query_params = opts[:query_params] || {}
|
618
|
+
|
619
|
+
# header parameters
|
620
|
+
header_params = opts[:header_params] || {}
|
621
|
+
# HTTP header 'Accept' (if needed)
|
622
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
623
|
+
# HTTP header 'Content-Type'
|
624
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
625
|
+
|
626
|
+
# form parameters
|
627
|
+
form_params = opts[:form_params] || {}
|
628
|
+
|
629
|
+
# http body (model)
|
630
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
631
|
+
|
632
|
+
# return_type
|
633
|
+
return_type = opts[:return_type] || 'LoyaltyCardBatchResponse'
|
634
|
+
|
635
|
+
# auth_names
|
636
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
637
|
+
|
638
|
+
new_options = opts.merge(
|
639
|
+
:header_params => header_params,
|
640
|
+
:query_params => query_params,
|
641
|
+
:form_params => form_params,
|
642
|
+
:body => post_body,
|
643
|
+
:auth_names => auth_names,
|
644
|
+
:return_type => return_type
|
645
|
+
)
|
646
|
+
|
647
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
648
|
+
if @api_client.config.debugging
|
649
|
+
@api_client.config.logger.debug "API called: ManagementApi#create_batch_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
650
|
+
end
|
651
|
+
return data, status_code, headers
|
652
|
+
end
|
653
|
+
|
584
654
|
# Create campaign from campaign template
|
585
655
|
# Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.
|
586
656
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -882,6 +952,82 @@ module TalonOne
|
|
882
952
|
return data, status_code, headers
|
883
953
|
end
|
884
954
|
|
955
|
+
# Creates a coupon deletion job
|
956
|
+
# This endpoint handles creating a job to delete coupons asynchronously.
|
957
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
958
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
959
|
+
# @param body [NewCouponDeletionJob] body
|
960
|
+
# @param [Hash] opts the optional parameters
|
961
|
+
# @return [AsyncCouponDeletionJobResponse]
|
962
|
+
def create_coupons_deletion_job(application_id, campaign_id, body, opts = {})
|
963
|
+
data, _status_code, _headers = create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts)
|
964
|
+
data
|
965
|
+
end
|
966
|
+
|
967
|
+
# Creates a coupon deletion job
|
968
|
+
# This endpoint handles creating a job to delete coupons asynchronously.
|
969
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
970
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
971
|
+
# @param body [NewCouponDeletionJob] body
|
972
|
+
# @param [Hash] opts the optional parameters
|
973
|
+
# @return [Array<(AsyncCouponDeletionJobResponse, Integer, Hash)>] AsyncCouponDeletionJobResponse data, response status code and response headers
|
974
|
+
def create_coupons_deletion_job_with_http_info(application_id, campaign_id, body, opts = {})
|
975
|
+
if @api_client.config.debugging
|
976
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.create_coupons_deletion_job ...'
|
977
|
+
end
|
978
|
+
# verify the required parameter 'application_id' is set
|
979
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
980
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.create_coupons_deletion_job"
|
981
|
+
end
|
982
|
+
# verify the required parameter 'campaign_id' is set
|
983
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
984
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.create_coupons_deletion_job"
|
985
|
+
end
|
986
|
+
# verify the required parameter 'body' is set
|
987
|
+
if @api_client.config.client_side_validation && body.nil?
|
988
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.create_coupons_deletion_job"
|
989
|
+
end
|
990
|
+
# resource path
|
991
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
992
|
+
|
993
|
+
# query parameters
|
994
|
+
query_params = opts[:query_params] || {}
|
995
|
+
|
996
|
+
# header parameters
|
997
|
+
header_params = opts[:header_params] || {}
|
998
|
+
# HTTP header 'Accept' (if needed)
|
999
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1000
|
+
# HTTP header 'Content-Type'
|
1001
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1002
|
+
|
1003
|
+
# form parameters
|
1004
|
+
form_params = opts[:form_params] || {}
|
1005
|
+
|
1006
|
+
# http body (model)
|
1007
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
1008
|
+
|
1009
|
+
# return_type
|
1010
|
+
return_type = opts[:return_type] || 'AsyncCouponDeletionJobResponse'
|
1011
|
+
|
1012
|
+
# auth_names
|
1013
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
1014
|
+
|
1015
|
+
new_options = opts.merge(
|
1016
|
+
:header_params => header_params,
|
1017
|
+
:query_params => query_params,
|
1018
|
+
:form_params => form_params,
|
1019
|
+
:body => post_body,
|
1020
|
+
:auth_names => auth_names,
|
1021
|
+
:return_type => return_type
|
1022
|
+
)
|
1023
|
+
|
1024
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1025
|
+
if @api_client.config.debugging
|
1026
|
+
@api_client.config.logger.debug "API called: ManagementApi#create_coupons_deletion_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1027
|
+
end
|
1028
|
+
return data, status_code, headers
|
1029
|
+
end
|
1030
|
+
|
885
1031
|
# Create coupons for multiple recipients
|
886
1032
|
# Create coupons according to some pattern for up to 1000 recipients.
|
887
1033
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -1287,8 +1433,8 @@ module TalonOne
|
|
1287
1433
|
return data, status_code, headers
|
1288
1434
|
end
|
1289
1435
|
|
1290
|
-
#
|
1291
|
-
#
|
1436
|
+
# Disable user by email address
|
1437
|
+
# [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
1292
1438
|
# @param body [DeactivateUserRequest] body
|
1293
1439
|
# @param [Hash] opts the optional parameters
|
1294
1440
|
# @return [nil]
|
@@ -1297,8 +1443,8 @@ module TalonOne
|
|
1297
1443
|
nil
|
1298
1444
|
end
|
1299
1445
|
|
1300
|
-
#
|
1301
|
-
#
|
1446
|
+
# Disable user by email address
|
1447
|
+
# [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
1302
1448
|
# @param body [DeactivateUserRequest] body
|
1303
1449
|
# @param [Hash] opts the optional parameters
|
1304
1450
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1785,15 +1931,15 @@ module TalonOne
|
|
1785
1931
|
# @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.
|
1786
1932
|
# @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.
|
1787
1933
|
# @option opts [DateTime] :created_after 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.
|
1788
|
-
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1789
|
-
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1790
|
-
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1791
|
-
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1934
|
+
# @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.
|
1935
|
+
# @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.
|
1936
|
+
# @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.
|
1937
|
+
# @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.
|
1792
1938
|
# @option opts [String] :valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
1793
1939
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1794
1940
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
1795
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.
|
1796
|
-
# @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.
|
1797
1943
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
1798
1944
|
# @return [nil]
|
1799
1945
|
def delete_coupons(application_id, campaign_id, opts = {})
|
@@ -1809,15 +1955,15 @@ module TalonOne
|
|
1809
1955
|
# @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.
|
1810
1956
|
# @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.
|
1811
1957
|
# @option opts [DateTime] :created_after 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.
|
1812
|
-
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1813
|
-
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1814
|
-
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1815
|
-
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon
|
1958
|
+
# @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.
|
1959
|
+
# @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.
|
1960
|
+
# @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.
|
1961
|
+
# @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.
|
1816
1962
|
# @option opts [String] :valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
1817
1963
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1818
1964
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
1819
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.
|
1820
|
-
# @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.
|
1821
1967
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1822
1968
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1823
1969
|
def delete_coupons_with_http_info(application_id, campaign_id, opts = {})
|
@@ -2163,8 +2309,8 @@ module TalonOne
|
|
2163
2309
|
end
|
2164
2310
|
|
2165
2311
|
# Delete user by email address
|
2166
|
-
# Delete a specific user by their email address.
|
2167
|
-
# @param body [
|
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 [DeactivateUserRequest] body
|
2168
2314
|
# @param [Hash] opts the optional parameters
|
2169
2315
|
# @return [nil]
|
2170
2316
|
def delete_user_by_email(body, opts = {})
|
@@ -2173,8 +2319,8 @@ module TalonOne
|
|
2173
2319
|
end
|
2174
2320
|
|
2175
2321
|
# Delete user by email address
|
2176
|
-
# Delete a specific user by their email address.
|
2177
|
-
# @param body [
|
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 [DeactivateUserRequest] body
|
2178
2324
|
# @param [Hash] opts the optional parameters
|
2179
2325
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2180
2326
|
def delete_user_by_email_with_http_info(body, opts = {})
|
@@ -2278,6 +2424,74 @@ module TalonOne
|
|
2278
2424
|
return data, status_code, headers
|
2279
2425
|
end
|
2280
2426
|
|
2427
|
+
# Disconnect stores
|
2428
|
+
# Disconnect the stores linked to a specific campaign.
|
2429
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2430
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2431
|
+
# @param [Hash] opts the optional parameters
|
2432
|
+
# @return [nil]
|
2433
|
+
def disconnect_campaign_stores(application_id, campaign_id, opts = {})
|
2434
|
+
disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts)
|
2435
|
+
nil
|
2436
|
+
end
|
2437
|
+
|
2438
|
+
# Disconnect stores
|
2439
|
+
# Disconnect the stores linked to a specific campaign.
|
2440
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2441
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2442
|
+
# @param [Hash] opts the optional parameters
|
2443
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2444
|
+
def disconnect_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
|
2445
|
+
if @api_client.config.debugging
|
2446
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.disconnect_campaign_stores ...'
|
2447
|
+
end
|
2448
|
+
# verify the required parameter 'application_id' is set
|
2449
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
2450
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.disconnect_campaign_stores"
|
2451
|
+
end
|
2452
|
+
# verify the required parameter 'campaign_id' is set
|
2453
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
2454
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.disconnect_campaign_stores"
|
2455
|
+
end
|
2456
|
+
# resource path
|
2457
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
2458
|
+
|
2459
|
+
# query parameters
|
2460
|
+
query_params = opts[:query_params] || {}
|
2461
|
+
|
2462
|
+
# header parameters
|
2463
|
+
header_params = opts[:header_params] || {}
|
2464
|
+
# HTTP header 'Accept' (if needed)
|
2465
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2466
|
+
|
2467
|
+
# form parameters
|
2468
|
+
form_params = opts[:form_params] || {}
|
2469
|
+
|
2470
|
+
# http body (model)
|
2471
|
+
post_body = opts[:body]
|
2472
|
+
|
2473
|
+
# return_type
|
2474
|
+
return_type = opts[:return_type]
|
2475
|
+
|
2476
|
+
# auth_names
|
2477
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
2478
|
+
|
2479
|
+
new_options = opts.merge(
|
2480
|
+
:header_params => header_params,
|
2481
|
+
:query_params => query_params,
|
2482
|
+
:form_params => form_params,
|
2483
|
+
:body => post_body,
|
2484
|
+
:auth_names => auth_names,
|
2485
|
+
:return_type => return_type
|
2486
|
+
)
|
2487
|
+
|
2488
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
2489
|
+
if @api_client.config.debugging
|
2490
|
+
@api_client.config.logger.debug "API called: ManagementApi#disconnect_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2491
|
+
end
|
2492
|
+
return data, status_code, headers
|
2493
|
+
end
|
2494
|
+
|
2281
2495
|
# Export account-level collection's items
|
2282
2496
|
# Download a CSV file containing items from a given account-level collection. **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/).
|
2283
2497
|
# @param collection_id [Integer] The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
@@ -2476,6 +2690,74 @@ module TalonOne
|
|
2476
2690
|
return data, status_code, headers
|
2477
2691
|
end
|
2478
2692
|
|
2693
|
+
# Export stores
|
2694
|
+
# Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
2695
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2696
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2697
|
+
# @param [Hash] opts the optional parameters
|
2698
|
+
# @return [String]
|
2699
|
+
def export_campaign_stores(application_id, campaign_id, opts = {})
|
2700
|
+
data, _status_code, _headers = export_campaign_stores_with_http_info(application_id, campaign_id, opts)
|
2701
|
+
data
|
2702
|
+
end
|
2703
|
+
|
2704
|
+
# Export stores
|
2705
|
+
# Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
2706
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2707
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2708
|
+
# @param [Hash] opts the optional parameters
|
2709
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
2710
|
+
def export_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
|
2711
|
+
if @api_client.config.debugging
|
2712
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.export_campaign_stores ...'
|
2713
|
+
end
|
2714
|
+
# verify the required parameter 'application_id' is set
|
2715
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
2716
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.export_campaign_stores"
|
2717
|
+
end
|
2718
|
+
# verify the required parameter 'campaign_id' is set
|
2719
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
2720
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.export_campaign_stores"
|
2721
|
+
end
|
2722
|
+
# resource path
|
2723
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/export'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
2724
|
+
|
2725
|
+
# query parameters
|
2726
|
+
query_params = opts[:query_params] || {}
|
2727
|
+
|
2728
|
+
# header parameters
|
2729
|
+
header_params = opts[:header_params] || {}
|
2730
|
+
# HTTP header 'Accept' (if needed)
|
2731
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
|
2732
|
+
|
2733
|
+
# form parameters
|
2734
|
+
form_params = opts[:form_params] || {}
|
2735
|
+
|
2736
|
+
# http body (model)
|
2737
|
+
post_body = opts[:body]
|
2738
|
+
|
2739
|
+
# return_type
|
2740
|
+
return_type = opts[:return_type] || 'String'
|
2741
|
+
|
2742
|
+
# auth_names
|
2743
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
2744
|
+
|
2745
|
+
new_options = opts.merge(
|
2746
|
+
:header_params => header_params,
|
2747
|
+
:query_params => query_params,
|
2748
|
+
:form_params => form_params,
|
2749
|
+
:body => post_body,
|
2750
|
+
:auth_names => auth_names,
|
2751
|
+
:return_type => return_type
|
2752
|
+
)
|
2753
|
+
|
2754
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2755
|
+
if @api_client.config.debugging
|
2756
|
+
@api_client.config.logger.debug "API called: ManagementApi#export_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2757
|
+
end
|
2758
|
+
return data, status_code, headers
|
2759
|
+
end
|
2760
|
+
|
2479
2761
|
# Export campaign-level collection's items
|
2480
2762
|
# Download a CSV file containing items from a given campaign-level collection. **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/).
|
2481
2763
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -2551,10 +2833,10 @@ module TalonOne
|
|
2551
2833
|
end
|
2552
2834
|
|
2553
2835
|
# Export coupons
|
2554
|
-
# 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.
|
2555
2837
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2556
2838
|
# @param [Hash] opts the optional parameters
|
2557
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2839
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2558
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.
|
2559
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.
|
2560
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.
|
@@ -2566,7 +2848,7 @@ module TalonOne
|
|
2566
2848
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
2567
2849
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
2568
2850
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2569
|
-
# @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.
|
2851
|
+
# @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.
|
2570
2852
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false)
|
2571
2853
|
# @return [String]
|
2572
2854
|
def export_coupons(application_id, opts = {})
|
@@ -2575,10 +2857,10 @@ module TalonOne
|
|
2575
2857
|
end
|
2576
2858
|
|
2577
2859
|
# Export coupons
|
2578
|
-
# 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.
|
2579
2861
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2580
2862
|
# @param [Hash] opts the optional parameters
|
2581
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2863
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2582
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.
|
2583
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.
|
2584
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.
|
@@ -2590,7 +2872,7 @@ module TalonOne
|
|
2590
2872
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
2591
2873
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
2592
2874
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2593
|
-
# @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.
|
2875
|
+
# @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.
|
2594
2876
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
2595
2877
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
2596
2878
|
def export_coupons_with_http_info(application_id, opts = {})
|
@@ -2613,7 +2895,7 @@ module TalonOne
|
|
2613
2895
|
if @api_client.config.client_side_validation && opts[:'date_format'] && !allowable_values.include?(opts[:'date_format'])
|
2614
2896
|
fail ArgumentError, "invalid value for \"date_format\", must be one of #{allowable_values}"
|
2615
2897
|
end
|
2616
|
-
allowable_values = ["enabled", "disabled", "archived", "
|
2898
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
2617
2899
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
2618
2900
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
2619
2901
|
end
|
@@ -2756,7 +3038,7 @@ module TalonOne
|
|
2756
3038
|
end
|
2757
3039
|
|
2758
3040
|
# Export customers' tier data
|
2759
|
-
# Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `
|
3041
|
+
# Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.
|
2760
3042
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
2761
3043
|
# @param [Hash] opts the optional parameters
|
2762
3044
|
# @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
|
@@ -2768,7 +3050,7 @@ module TalonOne
|
|
2768
3050
|
end
|
2769
3051
|
|
2770
3052
|
# Export customers' tier data
|
2771
|
-
# Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `
|
3053
|
+
# Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.
|
2772
3054
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
2773
3055
|
# @param [Hash] opts the optional parameters
|
2774
3056
|
# @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
|
@@ -2827,9 +3109,9 @@ module TalonOne
|
|
2827
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.
|
2828
3110
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2829
3111
|
# @param [Hash] opts the optional parameters
|
2830
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2831
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2832
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
3112
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
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
|
+
# @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.
|
2833
3115
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2834
3116
|
# @return [String]
|
2835
3117
|
def export_effects(application_id, opts = {})
|
@@ -2841,9 +3123,9 @@ module TalonOne
|
|
2841
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.
|
2842
3124
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2843
3125
|
# @param [Hash] opts the optional parameters
|
2844
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
2845
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
2846
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string
|
3126
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
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
|
+
# @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.
|
2847
3129
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
2848
3130
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
2849
3131
|
def export_effects_with_http_info(application_id, opts = {})
|
@@ -3189,44 +3471,116 @@ module TalonOne
|
|
3189
3471
|
return data, status_code, headers
|
3190
3472
|
end
|
3191
3473
|
|
3192
|
-
# Export
|
3193
|
-
# Download a CSV file containing
|
3194
|
-
# @param
|
3195
|
-
# @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.
|
3196
|
-
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3197
|
-
# @param integration_id [String] The identifier of the profile.
|
3474
|
+
# Export loyalty cards
|
3475
|
+
# Download a CSV file containing the loyalty cards from a specified loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
|
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.
|
3198
3477
|
# @param [Hash] opts the optional parameters
|
3478
|
+
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
3199
3479
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3200
3480
|
# @return [String]
|
3201
|
-
def
|
3202
|
-
data, _status_code, _headers =
|
3481
|
+
def export_loyalty_cards(loyalty_program_id, opts = {})
|
3482
|
+
data, _status_code, _headers = export_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
3203
3483
|
data
|
3204
3484
|
end
|
3205
3485
|
|
3206
|
-
# Export
|
3207
|
-
# Download a CSV file containing
|
3208
|
-
# @param
|
3209
|
-
# @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.
|
3210
|
-
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3211
|
-
# @param integration_id [String] The identifier of the profile.
|
3486
|
+
# Export loyalty cards
|
3487
|
+
# Download a CSV file containing the loyalty cards from a specified loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in.
|
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.
|
3212
3489
|
# @param [Hash] opts the optional parameters
|
3490
|
+
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
3213
3491
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3214
3492
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
3215
|
-
def
|
3493
|
+
def export_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
3216
3494
|
if @api_client.config.debugging
|
3217
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.
|
3218
|
-
end
|
3219
|
-
# verify the required parameter 'range_start' is set
|
3220
|
-
if @api_client.config.client_side_validation && range_start.nil?
|
3221
|
-
fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
|
3222
|
-
end
|
3223
|
-
# verify the required parameter 'range_end' is set
|
3224
|
-
if @api_client.config.client_side_validation && range_end.nil?
|
3225
|
-
fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
|
3495
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_cards ...'
|
3226
3496
|
end
|
3227
3497
|
# verify the required parameter 'loyalty_program_id' is set
|
3228
3498
|
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
3229
|
-
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.
|
3499
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_cards"
|
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
|
3505
|
+
# resource path
|
3506
|
+
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/cards/export'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
3507
|
+
|
3508
|
+
# query parameters
|
3509
|
+
query_params = opts[:query_params] || {}
|
3510
|
+
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
3511
|
+
query_params[:'dateFormat'] = opts[:'date_format'] if !opts[:'date_format'].nil?
|
3512
|
+
|
3513
|
+
# header parameters
|
3514
|
+
header_params = opts[:header_params] || {}
|
3515
|
+
# HTTP header 'Accept' (if needed)
|
3516
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
|
3517
|
+
|
3518
|
+
# form parameters
|
3519
|
+
form_params = opts[:form_params] || {}
|
3520
|
+
|
3521
|
+
# http body (model)
|
3522
|
+
post_body = opts[:body]
|
3523
|
+
|
3524
|
+
# return_type
|
3525
|
+
return_type = opts[:return_type] || 'String'
|
3526
|
+
|
3527
|
+
# auth_names
|
3528
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
3529
|
+
|
3530
|
+
new_options = opts.merge(
|
3531
|
+
:header_params => header_params,
|
3532
|
+
:query_params => query_params,
|
3533
|
+
:form_params => form_params,
|
3534
|
+
:body => post_body,
|
3535
|
+
:auth_names => auth_names,
|
3536
|
+
:return_type => return_type
|
3537
|
+
)
|
3538
|
+
|
3539
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3540
|
+
if @api_client.config.debugging
|
3541
|
+
@api_client.config.logger.debug "API called: ManagementApi#export_loyalty_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3542
|
+
end
|
3543
|
+
return data, status_code, headers
|
3544
|
+
end
|
3545
|
+
|
3546
|
+
# Export customer's transaction logs
|
3547
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
|
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.
|
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.
|
3550
|
+
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3551
|
+
# @param integration_id [String] The identifier of the profile.
|
3552
|
+
# @param [Hash] opts the optional parameters
|
3553
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3554
|
+
# @return [String]
|
3555
|
+
def export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, opts = {})
|
3556
|
+
data, _status_code, _headers = export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts)
|
3557
|
+
data
|
3558
|
+
end
|
3559
|
+
|
3560
|
+
# Export customer's transaction logs
|
3561
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
|
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.
|
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.
|
3564
|
+
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
3565
|
+
# @param integration_id [String] The identifier of the profile.
|
3566
|
+
# @param [Hash] opts the optional parameters
|
3567
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
3568
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
3569
|
+
def export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, opts = {})
|
3570
|
+
if @api_client.config.debugging
|
3571
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.export_loyalty_ledger ...'
|
3572
|
+
end
|
3573
|
+
# verify the required parameter 'range_start' is set
|
3574
|
+
if @api_client.config.client_side_validation && range_start.nil?
|
3575
|
+
fail ArgumentError, "Missing the required parameter 'range_start' when calling ManagementApi.export_loyalty_ledger"
|
3576
|
+
end
|
3577
|
+
# verify the required parameter 'range_end' is set
|
3578
|
+
if @api_client.config.client_side_validation && range_end.nil?
|
3579
|
+
fail ArgumentError, "Missing the required parameter 'range_end' when calling ManagementApi.export_loyalty_ledger"
|
3580
|
+
end
|
3581
|
+
# verify the required parameter 'loyalty_program_id' is set
|
3582
|
+
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
3583
|
+
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.export_loyalty_ledger"
|
3230
3584
|
end
|
3231
3585
|
# verify the required parameter 'integration_id' is set
|
3232
3586
|
if @api_client.config.client_side_validation && integration_id.nil?
|
@@ -3350,7 +3704,7 @@ module TalonOne
|
|
3350
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.
|
3351
3705
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3352
3706
|
# @param [Hash] opts the optional parameters
|
3353
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3707
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3354
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.
|
3355
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.
|
3356
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.
|
@@ -3367,7 +3721,7 @@ module TalonOne
|
|
3367
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.
|
3368
3722
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
3369
3723
|
# @param [Hash] opts the optional parameters
|
3370
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
3724
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
3371
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.
|
3372
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.
|
3373
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.
|
@@ -3879,7 +4233,7 @@ module TalonOne
|
|
3879
4233
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
3880
4234
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3881
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.
|
3882
|
-
# @return [
|
4236
|
+
# @return [InlineResponse20035]
|
3883
4237
|
def get_additional_costs(opts = {})
|
3884
4238
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
3885
4239
|
data
|
@@ -3891,7 +4245,7 @@ module TalonOne
|
|
3891
4245
|
# @option opts [Integer] :page_size The number of items in the response.
|
3892
4246
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3893
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.
|
3894
|
-
# @return [Array<(
|
4248
|
+
# @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
|
3895
4249
|
def get_additional_costs_with_http_info(opts = {})
|
3896
4250
|
if @api_client.config.debugging
|
3897
4251
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_additional_costs ...'
|
@@ -3925,7 +4279,7 @@ module TalonOne
|
|
3925
4279
|
post_body = opts[:body]
|
3926
4280
|
|
3927
4281
|
# return_type
|
3928
|
-
return_type = opts[:return_type] || '
|
4282
|
+
return_type = opts[:return_type] || 'InlineResponse20035'
|
3929
4283
|
|
3930
4284
|
# auth_names
|
3931
4285
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -3946,102 +4300,6 @@ module TalonOne
|
|
3946
4300
|
return data, status_code, headers
|
3947
4301
|
end
|
3948
4302
|
|
3949
|
-
# List access logs
|
3950
|
-
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
3951
|
-
# @param [Hash] opts the optional parameters
|
3952
|
-
# @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.
|
3953
|
-
# @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.
|
3954
|
-
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
3955
|
-
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
3956
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
3957
|
-
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
3958
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3959
|
-
# @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.
|
3960
|
-
# @return [InlineResponse20020]
|
3961
|
-
def get_all_access_logs(opts = {})
|
3962
|
-
data, _status_code, _headers = get_all_access_logs_with_http_info(opts)
|
3963
|
-
data
|
3964
|
-
end
|
3965
|
-
|
3966
|
-
# List access logs
|
3967
|
-
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
3968
|
-
# @param [Hash] opts the optional parameters
|
3969
|
-
# @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.
|
3970
|
-
# @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.
|
3971
|
-
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
3972
|
-
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
3973
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
3974
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
3975
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3976
|
-
# @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.
|
3977
|
-
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
3978
|
-
def get_all_access_logs_with_http_info(opts = {})
|
3979
|
-
if @api_client.config.debugging
|
3980
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.get_all_access_logs ...'
|
3981
|
-
end
|
3982
|
-
allowable_values = ["get", "put", "post", "delete", "patch"]
|
3983
|
-
if @api_client.config.client_side_validation && opts[:'method'] && !allowable_values.include?(opts[:'method'])
|
3984
|
-
fail ArgumentError, "invalid value for \"method\", must be one of #{allowable_values}"
|
3985
|
-
end
|
3986
|
-
allowable_values = ["success", "error"]
|
3987
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
3988
|
-
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
3989
|
-
end
|
3990
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
3991
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_all_access_logs, must be smaller than or equal to 1000.'
|
3992
|
-
end
|
3993
|
-
|
3994
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
3995
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_all_access_logs, must be greater than or equal to 1.'
|
3996
|
-
end
|
3997
|
-
|
3998
|
-
# resource path
|
3999
|
-
local_var_path = '/v1/access_logs'
|
4000
|
-
|
4001
|
-
# query parameters
|
4002
|
-
query_params = opts[:query_params] || {}
|
4003
|
-
query_params[:'rangeStart'] = opts[:'range_start'] if !opts[:'range_start'].nil?
|
4004
|
-
query_params[:'rangeEnd'] = opts[:'range_end'] if !opts[:'range_end'].nil?
|
4005
|
-
query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
|
4006
|
-
query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil?
|
4007
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
4008
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
4009
|
-
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
4010
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
4011
|
-
|
4012
|
-
# header parameters
|
4013
|
-
header_params = opts[:header_params] || {}
|
4014
|
-
# HTTP header 'Accept' (if needed)
|
4015
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4016
|
-
|
4017
|
-
# form parameters
|
4018
|
-
form_params = opts[:form_params] || {}
|
4019
|
-
|
4020
|
-
# http body (model)
|
4021
|
-
post_body = opts[:body]
|
4022
|
-
|
4023
|
-
# return_type
|
4024
|
-
return_type = opts[:return_type] || 'InlineResponse20020'
|
4025
|
-
|
4026
|
-
# auth_names
|
4027
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
4028
|
-
|
4029
|
-
new_options = opts.merge(
|
4030
|
-
:header_params => header_params,
|
4031
|
-
:query_params => query_params,
|
4032
|
-
:form_params => form_params,
|
4033
|
-
:body => post_body,
|
4034
|
-
:auth_names => auth_names,
|
4035
|
-
:return_type => return_type
|
4036
|
-
)
|
4037
|
-
|
4038
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4039
|
-
if @api_client.config.debugging
|
4040
|
-
@api_client.config.logger.debug "API called: ManagementApi#get_all_access_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4041
|
-
end
|
4042
|
-
return data, status_code, headers
|
4043
|
-
end
|
4044
|
-
|
4045
4303
|
# Get Application
|
4046
4304
|
# Get the application specified by the ID.
|
4047
4305
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -4105,7 +4363,7 @@ module TalonOne
|
|
4105
4363
|
end
|
4106
4364
|
|
4107
4365
|
# Get Application health
|
4108
|
-
# 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).
|
4109
4367
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
4110
4368
|
# @param [Hash] opts the optional parameters
|
4111
4369
|
# @return [ApplicationApiHealth]
|
@@ -4115,7 +4373,7 @@ module TalonOne
|
|
4115
4373
|
end
|
4116
4374
|
|
4117
4375
|
# Get Application health
|
4118
|
-
# 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).
|
4119
4377
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
4120
4378
|
# @param [Hash] opts the optional parameters
|
4121
4379
|
# @return [Array<(ApplicationApiHealth, Integer, Hash)>] ApplicationApiHealth data, response status code and response headers
|
@@ -4243,7 +4501,7 @@ module TalonOne
|
|
4243
4501
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4244
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.
|
4245
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.
|
4246
|
-
# @return [
|
4504
|
+
# @return [InlineResponse20032]
|
4247
4505
|
def get_application_customer_friends(application_id, integration_id, opts = {})
|
4248
4506
|
data, _status_code, _headers = get_application_customer_friends_with_http_info(application_id, integration_id, opts)
|
4249
4507
|
data
|
@@ -4258,7 +4516,7 @@ module TalonOne
|
|
4258
4516
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4259
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.
|
4260
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.
|
4261
|
-
# @return [Array<(
|
4519
|
+
# @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
|
4262
4520
|
def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
|
4263
4521
|
if @api_client.config.debugging
|
4264
4522
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customer_friends ...'
|
@@ -4301,7 +4559,7 @@ module TalonOne
|
|
4301
4559
|
post_body = opts[:body]
|
4302
4560
|
|
4303
4561
|
# return_type
|
4304
|
-
return_type = opts[:return_type] || '
|
4562
|
+
return_type = opts[:return_type] || 'InlineResponse20032'
|
4305
4563
|
|
4306
4564
|
# auth_names
|
4307
4565
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4330,7 +4588,7 @@ module TalonOne
|
|
4330
4588
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4331
4589
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4332
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.
|
4333
|
-
# @return [
|
4591
|
+
# @return [InlineResponse20021]
|
4334
4592
|
def get_application_customers(application_id, opts = {})
|
4335
4593
|
data, _status_code, _headers = get_application_customers_with_http_info(application_id, opts)
|
4336
4594
|
data
|
@@ -4344,7 +4602,7 @@ module TalonOne
|
|
4344
4602
|
# @option opts [Integer] :page_size The number of items in the response.
|
4345
4603
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4346
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.
|
4347
|
-
# @return [Array<(
|
4605
|
+
# @return [Array<(InlineResponse20021, Integer, Hash)>] InlineResponse20021 data, response status code and response headers
|
4348
4606
|
def get_application_customers_with_http_info(application_id, opts = {})
|
4349
4607
|
if @api_client.config.debugging
|
4350
4608
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers ...'
|
@@ -4383,7 +4641,7 @@ module TalonOne
|
|
4383
4641
|
post_body = opts[:body]
|
4384
4642
|
|
4385
4643
|
# return_type
|
4386
|
-
return_type = opts[:return_type] || '
|
4644
|
+
return_type = opts[:return_type] || 'InlineResponse20021'
|
4387
4645
|
|
4388
4646
|
# auth_names
|
4389
4647
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4412,7 +4670,7 @@ module TalonOne
|
|
4412
4670
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4413
4671
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4414
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.
|
4415
|
-
# @return [
|
4673
|
+
# @return [InlineResponse20022]
|
4416
4674
|
def get_application_customers_by_attributes(application_id, body, opts = {})
|
4417
4675
|
data, _status_code, _headers = get_application_customers_by_attributes_with_http_info(application_id, body, opts)
|
4418
4676
|
data
|
@@ -4426,7 +4684,7 @@ module TalonOne
|
|
4426
4684
|
# @option opts [Integer] :page_size The number of items in the response.
|
4427
4685
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4428
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.
|
4429
|
-
# @return [Array<(
|
4687
|
+
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
4430
4688
|
def get_application_customers_by_attributes_with_http_info(application_id, body, opts = {})
|
4431
4689
|
if @api_client.config.debugging
|
4432
4690
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_customers_by_attributes ...'
|
@@ -4470,7 +4728,7 @@ module TalonOne
|
|
4470
4728
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
4471
4729
|
|
4472
4730
|
# return_type
|
4473
|
-
return_type = opts[:return_type] || '
|
4731
|
+
return_type = opts[:return_type] || 'InlineResponse20022'
|
4474
4732
|
|
4475
4733
|
# auth_names
|
4476
4734
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4498,7 +4756,7 @@ module TalonOne
|
|
4498
4756
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4499
4757
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4500
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.
|
4501
|
-
# @return [
|
4759
|
+
# @return [InlineResponse20028]
|
4502
4760
|
def get_application_event_types(application_id, opts = {})
|
4503
4761
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
4504
4762
|
data
|
@@ -4511,7 +4769,7 @@ module TalonOne
|
|
4511
4769
|
# @option opts [Integer] :page_size The number of items in the response.
|
4512
4770
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4513
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.
|
4514
|
-
# @return [Array<(
|
4772
|
+
# @return [Array<(InlineResponse20028, Integer, Hash)>] InlineResponse20028 data, response status code and response headers
|
4515
4773
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
4516
4774
|
if @api_client.config.debugging
|
4517
4775
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_event_types ...'
|
@@ -4549,7 +4807,7 @@ module TalonOne
|
|
4549
4807
|
post_body = opts[:body]
|
4550
4808
|
|
4551
4809
|
# return_type
|
4552
|
-
return_type = opts[:return_type] || '
|
4810
|
+
return_type = opts[:return_type] || 'InlineResponse20028'
|
4553
4811
|
|
4554
4812
|
# auth_names
|
4555
4813
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4588,7 +4846,7 @@ module TalonOne
|
|
4588
4846
|
# @option opts [String] :referral_code Referral code
|
4589
4847
|
# @option opts [String] :rule_query Rule name filter for events
|
4590
4848
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4591
|
-
# @return [
|
4849
|
+
# @return [InlineResponse20027]
|
4592
4850
|
def get_application_events_without_total_count(application_id, opts = {})
|
4593
4851
|
data, _status_code, _headers = get_application_events_without_total_count_with_http_info(application_id, opts)
|
4594
4852
|
data
|
@@ -4612,7 +4870,7 @@ module TalonOne
|
|
4612
4870
|
# @option opts [String] :referral_code Referral code
|
4613
4871
|
# @option opts [String] :rule_query Rule name filter for events
|
4614
4872
|
# @option opts [String] :campaign_query Campaign name filter for events
|
4615
|
-
# @return [Array<(
|
4873
|
+
# @return [Array<(InlineResponse20027, Integer, Hash)>] InlineResponse20027 data, response status code and response headers
|
4616
4874
|
def get_application_events_without_total_count_with_http_info(application_id, opts = {})
|
4617
4875
|
if @api_client.config.debugging
|
4618
4876
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_events_without_total_count ...'
|
@@ -4669,7 +4927,7 @@ module TalonOne
|
|
4669
4927
|
post_body = opts[:body]
|
4670
4928
|
|
4671
4929
|
# return_type
|
4672
|
-
return_type = opts[:return_type] || '
|
4930
|
+
return_type = opts[:return_type] || 'InlineResponse20027'
|
4673
4931
|
|
4674
4932
|
# auth_names
|
4675
4933
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -4771,9 +5029,9 @@ module TalonOne
|
|
4771
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.
|
4772
5030
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
4773
5031
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
4774
|
-
# @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.
|
4775
5033
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
4776
|
-
# @return [
|
5034
|
+
# @return [InlineResponse20026]
|
4777
5035
|
def get_application_sessions(application_id, opts = {})
|
4778
5036
|
data, _status_code, _headers = get_application_sessions_with_http_info(application_id, opts)
|
4779
5037
|
data
|
@@ -4792,9 +5050,9 @@ module TalonOne
|
|
4792
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.
|
4793
5051
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
4794
5052
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
4795
|
-
# @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.
|
4796
5054
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
4797
|
-
# @return [Array<(
|
5055
|
+
# @return [Array<(InlineResponse20026, Integer, Hash)>] InlineResponse20026 data, response status code and response headers
|
4798
5056
|
def get_application_sessions_with_http_info(application_id, opts = {})
|
4799
5057
|
if @api_client.config.debugging
|
4800
5058
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_application_sessions ...'
|
@@ -4844,7 +5102,7 @@ module TalonOne
|
|
4844
5102
|
post_body = opts[:body]
|
4845
5103
|
|
4846
5104
|
# return_type
|
4847
|
-
return_type = opts[:return_type] || '
|
5105
|
+
return_type = opts[:return_type] || 'InlineResponse20026'
|
4848
5106
|
|
4849
5107
|
# auth_names
|
4850
5108
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5007,7 +5265,7 @@ module TalonOne
|
|
5007
5265
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5008
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.
|
5009
5267
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5010
|
-
# @return [
|
5268
|
+
# @return [InlineResponse20033]
|
5011
5269
|
def get_attributes(opts = {})
|
5012
5270
|
data, _status_code, _headers = get_attributes_with_http_info(opts)
|
5013
5271
|
data
|
@@ -5020,7 +5278,7 @@ module TalonOne
|
|
5020
5278
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5021
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.
|
5022
5280
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5023
|
-
# @return [Array<(
|
5281
|
+
# @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
|
5024
5282
|
def get_attributes_with_http_info(opts = {})
|
5025
5283
|
if @api_client.config.debugging
|
5026
5284
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_attributes ...'
|
@@ -5055,7 +5313,7 @@ module TalonOne
|
|
5055
5313
|
post_body = opts[:body]
|
5056
5314
|
|
5057
5315
|
# return_type
|
5058
|
-
return_type = opts[:return_type] || '
|
5316
|
+
return_type = opts[:return_type] || 'InlineResponse20033'
|
5059
5317
|
|
5060
5318
|
# auth_names
|
5061
5319
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5084,7 +5342,7 @@ module TalonOne
|
|
5084
5342
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5085
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.
|
5086
5344
|
# @option opts [String] :profile_query The filter to select a profile.
|
5087
|
-
# @return [
|
5345
|
+
# @return [InlineResponse20031]
|
5088
5346
|
def get_audience_memberships(audience_id, opts = {})
|
5089
5347
|
data, _status_code, _headers = get_audience_memberships_with_http_info(audience_id, opts)
|
5090
5348
|
data
|
@@ -5098,7 +5356,7 @@ module TalonOne
|
|
5098
5356
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5099
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.
|
5100
5358
|
# @option opts [String] :profile_query The filter to select a profile.
|
5101
|
-
# @return [Array<(
|
5359
|
+
# @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
|
5102
5360
|
def get_audience_memberships_with_http_info(audience_id, opts = {})
|
5103
5361
|
if @api_client.config.debugging
|
5104
5362
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audience_memberships ...'
|
@@ -5137,7 +5395,7 @@ module TalonOne
|
|
5137
5395
|
post_body = opts[:body]
|
5138
5396
|
|
5139
5397
|
# return_type
|
5140
|
-
return_type = opts[:return_type] || '
|
5398
|
+
return_type = opts[:return_type] || 'InlineResponse20031'
|
5141
5399
|
|
5142
5400
|
# auth_names
|
5143
5401
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5165,7 +5423,7 @@ module TalonOne
|
|
5165
5423
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5166
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.
|
5167
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.
|
5168
|
-
# @return [
|
5426
|
+
# @return [InlineResponse20029]
|
5169
5427
|
def get_audiences(opts = {})
|
5170
5428
|
data, _status_code, _headers = get_audiences_with_http_info(opts)
|
5171
5429
|
data
|
@@ -5178,7 +5436,7 @@ module TalonOne
|
|
5178
5436
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5179
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.
|
5180
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.
|
5181
|
-
# @return [Array<(
|
5439
|
+
# @return [Array<(InlineResponse20029, Integer, Hash)>] InlineResponse20029 data, response status code and response headers
|
5182
5440
|
def get_audiences_with_http_info(opts = {})
|
5183
5441
|
if @api_client.config.debugging
|
5184
5442
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences ...'
|
@@ -5213,7 +5471,7 @@ module TalonOne
|
|
5213
5471
|
post_body = opts[:body]
|
5214
5472
|
|
5215
5473
|
# return_type
|
5216
|
-
return_type = opts[:return_type] || '
|
5474
|
+
return_type = opts[:return_type] || 'InlineResponse20029'
|
5217
5475
|
|
5218
5476
|
# auth_names
|
5219
5477
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5239,7 +5497,7 @@ module TalonOne
|
|
5239
5497
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5240
5498
|
# @param [Hash] opts the optional parameters
|
5241
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.
|
5242
|
-
# @return [
|
5500
|
+
# @return [InlineResponse20030]
|
5243
5501
|
def get_audiences_analytics(audience_ids, opts = {})
|
5244
5502
|
data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
|
5245
5503
|
data
|
@@ -5250,7 +5508,7 @@ module TalonOne
|
|
5250
5508
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5251
5509
|
# @param [Hash] opts the optional parameters
|
5252
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.
|
5253
|
-
# @return [Array<(
|
5511
|
+
# @return [Array<(InlineResponse20030, Integer, Hash)>] InlineResponse20030 data, response status code and response headers
|
5254
5512
|
def get_audiences_analytics_with_http_info(audience_ids, opts = {})
|
5255
5513
|
if @api_client.config.debugging
|
5256
5514
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_audiences_analytics ...'
|
@@ -5279,7 +5537,7 @@ module TalonOne
|
|
5279
5537
|
post_body = opts[:body]
|
5280
5538
|
|
5281
5539
|
# return_type
|
5282
|
-
return_type = opts[:return_type] || '
|
5540
|
+
return_type = opts[:return_type] || 'InlineResponse20030'
|
5283
5541
|
|
5284
5542
|
# auth_names
|
5285
5543
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5376,7 +5634,7 @@ module TalonOne
|
|
5376
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.
|
5377
5635
|
# @param [Hash] opts the optional parameters
|
5378
5636
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5379
|
-
# @return [
|
5637
|
+
# @return [InlineResponse20020]
|
5380
5638
|
def get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts = {})
|
5381
5639
|
data, _status_code, _headers = get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts)
|
5382
5640
|
data
|
@@ -5390,7 +5648,7 @@ module TalonOne
|
|
5390
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.
|
5391
5649
|
# @param [Hash] opts the optional parameters
|
5392
5650
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
5393
|
-
# @return [Array<(
|
5651
|
+
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
5394
5652
|
def get_campaign_analytics_with_http_info(application_id, campaign_id, range_start, range_end, opts = {})
|
5395
5653
|
if @api_client.config.debugging
|
5396
5654
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_campaign_analytics ...'
|
@@ -5436,7 +5694,7 @@ module TalonOne
|
|
5436
5694
|
post_body = opts[:body]
|
5437
5695
|
|
5438
5696
|
# return_type
|
5439
|
-
return_type = opts[:return_type] || '
|
5697
|
+
return_type = opts[:return_type] || 'InlineResponse20020'
|
5440
5698
|
|
5441
5699
|
# auth_names
|
5442
5700
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -5465,7 +5723,7 @@ module TalonOne
|
|
5465
5723
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5466
5724
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5467
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.
|
5468
|
-
# @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.
|
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.
|
5469
5727
|
# @return [InlineResponse2006]
|
5470
5728
|
def get_campaign_by_attributes(application_id, body, opts = {})
|
5471
5729
|
data, _status_code, _headers = get_campaign_by_attributes_with_http_info(application_id, body, opts)
|
@@ -5480,7 +5738,7 @@ module TalonOne
|
|
5480
5738
|
# @option opts [Integer] :page_size The number of items in the response.
|
5481
5739
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5482
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.
|
5483
|
-
# @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.
|
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.
|
5484
5742
|
# @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
|
5485
5743
|
def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
|
5486
5744
|
if @api_client.config.debugging
|
@@ -5502,7 +5760,7 @@ module TalonOne
|
|
5502
5760
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_by_attributes, must be greater than or equal to 1.'
|
5503
5761
|
end
|
5504
5762
|
|
5505
|
-
allowable_values = ["enabled", "disabled", "archived", "
|
5763
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
5506
5764
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
5507
5765
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
5508
5766
|
end
|
@@ -5725,7 +5983,7 @@ module TalonOne
|
|
5725
5983
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaign_templates, must be greater than or equal to 1.'
|
5726
5984
|
end
|
5727
5985
|
|
5728
|
-
allowable_values = ["
|
5986
|
+
allowable_values = ["draft", "enabled", "disabled"]
|
5729
5987
|
if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
|
5730
5988
|
fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
|
5731
5989
|
end
|
@@ -5782,13 +6040,13 @@ module TalonOne
|
|
5782
6040
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5783
6041
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5784
6042
|
# @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.
|
5785
|
-
# @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.
|
6043
|
+
# @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.
|
5786
6044
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
5787
6045
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
5788
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.
|
5789
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.
|
5790
6048
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
5791
|
-
# @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.
|
5792
6050
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
5793
6051
|
# @return [InlineResponse2006]
|
5794
6052
|
def get_campaigns(application_id, opts = {})
|
@@ -5803,13 +6061,13 @@ module TalonOne
|
|
5803
6061
|
# @option opts [Integer] :page_size The number of items in the response.
|
5804
6062
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5805
6063
|
# @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.
|
5806
|
-
# @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.
|
6064
|
+
# @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.
|
5807
6065
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
5808
6066
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
5809
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.
|
5810
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.
|
5811
6069
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
5812
|
-
# @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.
|
5813
6071
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
5814
6072
|
# @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
|
5815
6073
|
def get_campaigns_with_http_info(application_id, opts = {})
|
@@ -5828,7 +6086,7 @@ module TalonOne
|
|
5828
6086
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.get_campaigns, must be greater than or equal to 1.'
|
5829
6087
|
end
|
5830
6088
|
|
5831
|
-
allowable_values = ["enabled", "disabled", "archived", "
|
6089
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
5832
6090
|
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
5833
6091
|
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
5834
6092
|
end
|
@@ -5896,7 +6154,7 @@ module TalonOne
|
|
5896
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.
|
5897
6155
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
5898
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.
|
5899
|
-
# @return [
|
6157
|
+
# @return [InlineResponse20041]
|
5900
6158
|
def get_changes(opts = {})
|
5901
6159
|
data, _status_code, _headers = get_changes_with_http_info(opts)
|
5902
6160
|
data
|
@@ -5916,7 +6174,7 @@ module TalonOne
|
|
5916
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.
|
5917
6175
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
5918
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.
|
5919
|
-
# @return [Array<(
|
6177
|
+
# @return [Array<(InlineResponse20041, Integer, Hash)>] InlineResponse20041 data, response status code and response headers
|
5920
6178
|
def get_changes_with_http_info(opts = {})
|
5921
6179
|
if @api_client.config.debugging
|
5922
6180
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_changes ...'
|
@@ -5958,7 +6216,7 @@ module TalonOne
|
|
5958
6216
|
post_body = opts[:body]
|
5959
6217
|
|
5960
6218
|
# return_type
|
5961
|
-
return_type = opts[:return_type] || '
|
6219
|
+
return_type = opts[:return_type] || 'InlineResponse20041'
|
5962
6220
|
|
5963
6221
|
# auth_names
|
5964
6222
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6142,10 +6400,16 @@ module TalonOne
|
|
6142
6400
|
# @option opts [DateTime] :created_after 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.
|
6143
6401
|
# @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.
|
6144
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`.
|
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.
|
6145
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.
|
6146
|
-
# @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.
|
6147
6406
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
6148
|
-
# @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)
|
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.
|
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.
|
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.
|
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.
|
6412
|
+
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data. (default to false)
|
6149
6413
|
# @return [InlineResponse2009]
|
6150
6414
|
def get_coupons_without_total_count(application_id, campaign_id, opts = {})
|
6151
6415
|
data, _status_code, _headers = get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts)
|
@@ -6165,10 +6429,16 @@ module TalonOne
|
|
6165
6429
|
# @option opts [DateTime] :created_after 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.
|
6166
6430
|
# @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.
|
6167
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`.
|
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.
|
6168
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.
|
6169
|
-
# @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.
|
6170
6435
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
6171
|
-
# @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.
|
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.
|
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.
|
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.
|
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.
|
6441
|
+
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
6172
6442
|
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
6173
6443
|
def get_coupons_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
6174
6444
|
if @api_client.config.debugging
|
@@ -6198,6 +6468,10 @@ module TalonOne
|
|
6198
6468
|
if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
|
6199
6469
|
fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
|
6200
6470
|
end
|
6471
|
+
allowable_values = ["true", "false"]
|
6472
|
+
if @api_client.config.client_side_validation && opts[:'redeemed'] && !allowable_values.include?(opts[:'redeemed'])
|
6473
|
+
fail ArgumentError, "invalid value for \"redeemed\", must be one of #{allowable_values}"
|
6474
|
+
end
|
6201
6475
|
# resource path
|
6202
6476
|
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
6203
6477
|
|
@@ -6211,10 +6485,16 @@ module TalonOne
|
|
6211
6485
|
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
6212
6486
|
query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
|
6213
6487
|
query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
|
6488
|
+
query_params[:'redeemed'] = opts[:'redeemed'] if !opts[:'redeemed'].nil?
|
6214
6489
|
query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
|
6215
6490
|
query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
|
6216
6491
|
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
6217
6492
|
query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
|
6493
|
+
query_params[:'expiresBefore'] = opts[:'expires_before'] if !opts[:'expires_before'].nil?
|
6494
|
+
query_params[:'expiresAfter'] = opts[:'expires_after'] if !opts[:'expires_after'].nil?
|
6495
|
+
query_params[:'startsBefore'] = opts[:'starts_before'] if !opts[:'starts_before'].nil?
|
6496
|
+
query_params[:'startsAfter'] = opts[:'starts_after'] if !opts[:'starts_after'].nil?
|
6497
|
+
query_params[:'valuesOnly'] = opts[:'values_only'] if !opts[:'values_only'].nil?
|
6218
6498
|
|
6219
6499
|
# header parameters
|
6220
6500
|
header_params = opts[:header_params] || {}
|
@@ -6354,11 +6634,11 @@ module TalonOne
|
|
6354
6634
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6355
6635
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6356
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.
|
6357
|
-
# @option opts [String] :name Only return reports matching the customer name
|
6637
|
+
# @option opts [String] :name Only return reports matching the customer name.
|
6358
6638
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6359
|
-
# @option opts [String] :campaign_name Only return reports matching the
|
6360
|
-
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
6361
|
-
# @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 [InlineResponse20025]
|
6362
6642
|
def get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts = {})
|
6363
6643
|
data, _status_code, _headers = get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts)
|
6364
6644
|
data
|
@@ -6373,11 +6653,11 @@ module TalonOne
|
|
6373
6653
|
# @option opts [Integer] :page_size The number of items in the response.
|
6374
6654
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6375
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.
|
6376
|
-
# @option opts [String] :name Only return reports matching the customer name
|
6656
|
+
# @option opts [String] :name Only return reports matching the customer name.
|
6377
6657
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6378
|
-
# @option opts [String] :campaign_name Only return reports matching the
|
6379
|
-
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
6380
|
-
# @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<(InlineResponse20025, Integer, Hash)>] InlineResponse20025 data, response status code and response headers
|
6381
6661
|
def get_customer_activity_reports_without_total_count_with_http_info(range_start, range_end, application_id, opts = {})
|
6382
6662
|
if @api_client.config.debugging
|
6383
6663
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_activity_reports_without_total_count ...'
|
@@ -6429,7 +6709,7 @@ module TalonOne
|
|
6429
6709
|
post_body = opts[:body]
|
6430
6710
|
|
6431
6711
|
# return_type
|
6432
|
-
return_type = opts[:return_type] || '
|
6712
|
+
return_type = opts[:return_type] || 'InlineResponse20025'
|
6433
6713
|
|
6434
6714
|
# auth_names
|
6435
6715
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6606,7 +6886,7 @@ module TalonOne
|
|
6606
6886
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6607
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.
|
6608
6888
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6609
|
-
# @return [
|
6889
|
+
# @return [InlineResponse20046]
|
6610
6890
|
def get_customer_profile_achievement_progress(application_id, integration_id, opts = {})
|
6611
6891
|
data, _status_code, _headers = get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts)
|
6612
6892
|
data
|
@@ -6621,7 +6901,7 @@ module TalonOne
|
|
6621
6901
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6622
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.
|
6623
6903
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
6624
|
-
# @return [Array<(
|
6904
|
+
# @return [Array<(InlineResponse20046, Integer, Hash)>] InlineResponse20046 data, response status code and response headers
|
6625
6905
|
def get_customer_profile_achievement_progress_with_http_info(application_id, integration_id, opts = {})
|
6626
6906
|
if @api_client.config.debugging
|
6627
6907
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profile_achievement_progress ...'
|
@@ -6664,7 +6944,7 @@ module TalonOne
|
|
6664
6944
|
post_body = opts[:body]
|
6665
6945
|
|
6666
6946
|
# return_type
|
6667
|
-
return_type = opts[:return_type] || '
|
6947
|
+
return_type = opts[:return_type] || 'InlineResponse20046'
|
6668
6948
|
|
6669
6949
|
# auth_names
|
6670
6950
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6690,8 +6970,8 @@ module TalonOne
|
|
6690
6970
|
# @param [Hash] opts the optional parameters
|
6691
6971
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6692
6972
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6693
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
6694
|
-
# @return [
|
6973
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
6974
|
+
# @return [InlineResponse20024]
|
6695
6975
|
def get_customer_profiles(opts = {})
|
6696
6976
|
data, _status_code, _headers = get_customer_profiles_with_http_info(opts)
|
6697
6977
|
data
|
@@ -6702,8 +6982,8 @@ module TalonOne
|
|
6702
6982
|
# @param [Hash] opts the optional parameters
|
6703
6983
|
# @option opts [Integer] :page_size The number of items in the response.
|
6704
6984
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6705
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
6706
|
-
# @return [Array<(
|
6985
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
6986
|
+
# @return [Array<(InlineResponse20024, Integer, Hash)>] InlineResponse20024 data, response status code and response headers
|
6707
6987
|
def get_customer_profiles_with_http_info(opts = {})
|
6708
6988
|
if @api_client.config.debugging
|
6709
6989
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customer_profiles ...'
|
@@ -6737,7 +7017,7 @@ module TalonOne
|
|
6737
7017
|
post_body = opts[:body]
|
6738
7018
|
|
6739
7019
|
# return_type
|
6740
|
-
return_type = opts[:return_type] || '
|
7020
|
+
return_type = opts[:return_type] || 'InlineResponse20024'
|
6741
7021
|
|
6742
7022
|
# auth_names
|
6743
7023
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6764,8 +7044,8 @@ module TalonOne
|
|
6764
7044
|
# @param [Hash] opts the optional parameters
|
6765
7045
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6766
7046
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6767
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
6768
|
-
# @return [
|
7047
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer. (default to false)
|
7048
|
+
# @return [InlineResponse20023]
|
6769
7049
|
def get_customers_by_attributes(body, opts = {})
|
6770
7050
|
data, _status_code, _headers = get_customers_by_attributes_with_http_info(body, opts)
|
6771
7051
|
data
|
@@ -6777,8 +7057,8 @@ module TalonOne
|
|
6777
7057
|
# @param [Hash] opts the optional parameters
|
6778
7058
|
# @option opts [Integer] :page_size The number of items in the response.
|
6779
7059
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6780
|
-
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or
|
6781
|
-
# @return [Array<(
|
7060
|
+
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
7061
|
+
# @return [Array<(InlineResponse20023, Integer, Hash)>] InlineResponse20023 data, response status code and response headers
|
6782
7062
|
def get_customers_by_attributes_with_http_info(body, opts = {})
|
6783
7063
|
if @api_client.config.debugging
|
6784
7064
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_customers_by_attributes ...'
|
@@ -6818,7 +7098,7 @@ module TalonOne
|
|
6818
7098
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
6819
7099
|
|
6820
7100
|
# return_type
|
6821
|
-
return_type = opts[:return_type] || '
|
7101
|
+
return_type = opts[:return_type] || 'InlineResponse20023'
|
6822
7102
|
|
6823
7103
|
# auth_names
|
6824
7104
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6847,7 +7127,7 @@ module TalonOne
|
|
6847
7127
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6848
7128
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6849
7129
|
# @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.
|
6850
|
-
# @return [
|
7130
|
+
# @return [InlineResponse20039]
|
6851
7131
|
def get_event_types(opts = {})
|
6852
7132
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
6853
7133
|
data
|
@@ -6861,7 +7141,7 @@ module TalonOne
|
|
6861
7141
|
# @option opts [Integer] :page_size The number of items in the response.
|
6862
7142
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6863
7143
|
# @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.
|
6864
|
-
# @return [Array<(
|
7144
|
+
# @return [Array<(InlineResponse20039, Integer, Hash)>] InlineResponse20039 data, response status code and response headers
|
6865
7145
|
def get_event_types_with_http_info(opts = {})
|
6866
7146
|
if @api_client.config.debugging
|
6867
7147
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_event_types ...'
|
@@ -6897,7 +7177,7 @@ module TalonOne
|
|
6897
7177
|
post_body = opts[:body]
|
6898
7178
|
|
6899
7179
|
# return_type
|
6900
|
-
return_type = opts[:return_type] || '
|
7180
|
+
return_type = opts[:return_type] || 'InlineResponse20039'
|
6901
7181
|
|
6902
7182
|
# auth_names
|
6903
7183
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -6926,7 +7206,7 @@ module TalonOne
|
|
6926
7206
|
# @option opts [Float] :application_id Filter results by Application ID.
|
6927
7207
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
6928
7208
|
# @option opts [String] :entity The name of the entity type that was exported.
|
6929
|
-
# @return [
|
7209
|
+
# @return [InlineResponse20042]
|
6930
7210
|
def get_exports(opts = {})
|
6931
7211
|
data, _status_code, _headers = get_exports_with_http_info(opts)
|
6932
7212
|
data
|
@@ -6940,7 +7220,7 @@ module TalonOne
|
|
6940
7220
|
# @option opts [Float] :application_id Filter results by Application ID.
|
6941
7221
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
6942
7222
|
# @option opts [String] :entity The name of the entity type that was exported.
|
6943
|
-
# @return [Array<(
|
7223
|
+
# @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
|
6944
7224
|
def get_exports_with_http_info(opts = {})
|
6945
7225
|
if @api_client.config.debugging
|
6946
7226
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_exports ...'
|
@@ -6980,7 +7260,7 @@ module TalonOne
|
|
6980
7260
|
post_body = opts[:body]
|
6981
7261
|
|
6982
7262
|
# return_type
|
6983
|
-
return_type = opts[:return_type] || '
|
7263
|
+
return_type = opts[:return_type] || 'InlineResponse20042'
|
6984
7264
|
|
6985
7265
|
# auth_names
|
6986
7266
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -7175,8 +7455,9 @@ module TalonOne
|
|
7175
7455
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7176
7456
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7177
7457
|
# @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.
|
7178
|
-
# @option opts [String] :identifier
|
7179
|
-
# @option opts [Integer] :profile_id Filter by
|
7458
|
+
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7459
|
+
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7460
|
+
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7180
7461
|
# @return [InlineResponse20015]
|
7181
7462
|
def get_loyalty_cards(loyalty_program_id, opts = {})
|
7182
7463
|
data, _status_code, _headers = get_loyalty_cards_with_http_info(loyalty_program_id, opts)
|
@@ -7190,8 +7471,9 @@ module TalonOne
|
|
7190
7471
|
# @option opts [Integer] :page_size The number of items in the response.
|
7191
7472
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7192
7473
|
# @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.
|
7193
|
-
# @option opts [String] :identifier
|
7194
|
-
# @option opts [Integer] :profile_id Filter by
|
7474
|
+
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7475
|
+
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7476
|
+
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
7195
7477
|
# @return [Array<(InlineResponse20015, Integer, Hash)>] InlineResponse20015 data, response status code and response headers
|
7196
7478
|
def get_loyalty_cards_with_http_info(loyalty_program_id, opts = {})
|
7197
7479
|
if @api_client.config.debugging
|
@@ -7227,6 +7509,7 @@ module TalonOne
|
|
7227
7509
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
7228
7510
|
query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
|
7229
7511
|
query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
|
7512
|
+
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
7230
7513
|
|
7231
7514
|
# header parameters
|
7232
7515
|
header_params = opts[:header_params] || {}
|
@@ -7614,7 +7897,7 @@ module TalonOne
|
|
7614
7897
|
# @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.
|
7615
7898
|
# @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.
|
7616
7899
|
# @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`.
|
7617
|
-
# @option opts [String] :advocate Filter results by match with a profile
|
7900
|
+
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
7618
7901
|
# @return [InlineResponse20010]
|
7619
7902
|
def get_referrals_without_total_count(application_id, campaign_id, opts = {})
|
7620
7903
|
data, _status_code, _headers = get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts)
|
@@ -7634,7 +7917,7 @@ module TalonOne
|
|
7634
7917
|
# @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.
|
7635
7918
|
# @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.
|
7636
7919
|
# @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`.
|
7637
|
-
# @option opts [String] :advocate Filter results by match with a profile
|
7920
|
+
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
7638
7921
|
# @return [Array<(InlineResponse20010, Integer, Hash)>] InlineResponse20010 data, response status code and response headers
|
7639
7922
|
def get_referrals_without_total_count_with_http_info(application_id, campaign_id, opts = {})
|
7640
7923
|
if @api_client.config.debugging
|
@@ -8069,7 +8352,7 @@ module TalonOne
|
|
8069
8352
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8070
8353
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8071
8354
|
# @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.
|
8072
|
-
# @return [
|
8355
|
+
# @return [InlineResponse20040]
|
8073
8356
|
def get_users(opts = {})
|
8074
8357
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
8075
8358
|
data
|
@@ -8081,7 +8364,7 @@ module TalonOne
|
|
8081
8364
|
# @option opts [Integer] :page_size The number of items in the response.
|
8082
8365
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8083
8366
|
# @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.
|
8084
|
-
# @return [Array<(
|
8367
|
+
# @return [Array<(InlineResponse20040, Integer, Hash)>] InlineResponse20040 data, response status code and response headers
|
8085
8368
|
def get_users_with_http_info(opts = {})
|
8086
8369
|
if @api_client.config.debugging
|
8087
8370
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_users ...'
|
@@ -8115,7 +8398,7 @@ module TalonOne
|
|
8115
8398
|
post_body = opts[:body]
|
8116
8399
|
|
8117
8400
|
# return_type
|
8118
|
-
return_type = opts[:return_type] || '
|
8401
|
+
return_type = opts[:return_type] || 'InlineResponse20040'
|
8119
8402
|
|
8120
8403
|
# auth_names
|
8121
8404
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8205,12 +8488,12 @@ module TalonOne
|
|
8205
8488
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8206
8489
|
# @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.
|
8207
8490
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8208
|
-
# @option opts [Float] :webhook_id Filter results by
|
8491
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8209
8492
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8210
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8493
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8211
8494
|
# @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.
|
8212
8495
|
# @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.
|
8213
|
-
# @return [
|
8496
|
+
# @return [InlineResponse20037]
|
8214
8497
|
def get_webhook_activation_logs(opts = {})
|
8215
8498
|
data, _status_code, _headers = get_webhook_activation_logs_with_http_info(opts)
|
8216
8499
|
data
|
@@ -8223,12 +8506,12 @@ module TalonOne
|
|
8223
8506
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8224
8507
|
# @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.
|
8225
8508
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8226
|
-
# @option opts [Float] :webhook_id Filter results by
|
8509
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8227
8510
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8228
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8511
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8229
8512
|
# @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.
|
8230
8513
|
# @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.
|
8231
|
-
# @return [Array<(
|
8514
|
+
# @return [Array<(InlineResponse20037, Integer, Hash)>] InlineResponse20037 data, response status code and response headers
|
8232
8515
|
def get_webhook_activation_logs_with_http_info(opts = {})
|
8233
8516
|
if @api_client.config.debugging
|
8234
8517
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_activation_logs ...'
|
@@ -8268,7 +8551,7 @@ module TalonOne
|
|
8268
8551
|
post_body = opts[:body]
|
8269
8552
|
|
8270
8553
|
# return_type
|
8271
|
-
return_type = opts[:return_type] || '
|
8554
|
+
return_type = opts[:return_type] || 'InlineResponse20037'
|
8272
8555
|
|
8273
8556
|
# auth_names
|
8274
8557
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8296,13 +8579,13 @@ module TalonOne
|
|
8296
8579
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8297
8580
|
# @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.
|
8298
8581
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8299
|
-
# @option opts [Float] :webhook_id Filter results by
|
8582
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8300
8583
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8301
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8584
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8302
8585
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8303
8586
|
# @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.
|
8304
8587
|
# @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.
|
8305
|
-
# @return [
|
8588
|
+
# @return [InlineResponse20038]
|
8306
8589
|
def get_webhook_logs(opts = {})
|
8307
8590
|
data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
|
8308
8591
|
data
|
@@ -8315,13 +8598,13 @@ module TalonOne
|
|
8315
8598
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8316
8599
|
# @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.
|
8317
8600
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8318
|
-
# @option opts [Float] :webhook_id Filter results by
|
8601
|
+
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8319
8602
|
# @option opts [Float] :application_id Filter results by Application ID.
|
8320
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
8603
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8321
8604
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
8322
8605
|
# @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.
|
8323
8606
|
# @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.
|
8324
|
-
# @return [Array<(
|
8607
|
+
# @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
|
8325
8608
|
def get_webhook_logs_with_http_info(opts = {})
|
8326
8609
|
if @api_client.config.debugging
|
8327
8610
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhook_logs ...'
|
@@ -8366,7 +8649,7 @@ module TalonOne
|
|
8366
8649
|
post_body = opts[:body]
|
8367
8650
|
|
8368
8651
|
# return_type
|
8369
|
-
return_type = opts[:return_type] || '
|
8652
|
+
return_type = opts[:return_type] || 'InlineResponse20038'
|
8370
8653
|
|
8371
8654
|
# auth_names
|
8372
8655
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8390,7 +8673,7 @@ module TalonOne
|
|
8390
8673
|
# List webhooks
|
8391
8674
|
# List all webhooks.
|
8392
8675
|
# @param [Hash] opts the optional parameters
|
8393
|
-
# @option opts [String] :application_ids
|
8676
|
+
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
8394
8677
|
# @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.
|
8395
8678
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8396
8679
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
@@ -8398,7 +8681,7 @@ module TalonOne
|
|
8398
8681
|
# @option opts [String] :visibility Filter results by visibility.
|
8399
8682
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8400
8683
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8401
|
-
# @return [
|
8684
|
+
# @return [InlineResponse20036]
|
8402
8685
|
def get_webhooks(opts = {})
|
8403
8686
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
8404
8687
|
data
|
@@ -8407,7 +8690,7 @@ module TalonOne
|
|
8407
8690
|
# List webhooks
|
8408
8691
|
# List all webhooks.
|
8409
8692
|
# @param [Hash] opts the optional parameters
|
8410
|
-
# @option opts [String] :application_ids
|
8693
|
+
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
8411
8694
|
# @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.
|
8412
8695
|
# @option opts [Integer] :page_size The number of items in the response.
|
8413
8696
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
@@ -8415,7 +8698,7 @@ module TalonOne
|
|
8415
8698
|
# @option opts [String] :visibility Filter results by visibility.
|
8416
8699
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
8417
8700
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
8418
|
-
# @return [Array<(
|
8701
|
+
# @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
|
8419
8702
|
def get_webhooks_with_http_info(opts = {})
|
8420
8703
|
if @api_client.config.debugging
|
8421
8704
|
@api_client.config.logger.debug 'Calling API: ManagementApi.get_webhooks ...'
|
@@ -8462,7 +8745,7 @@ module TalonOne
|
|
8462
8745
|
post_body = opts[:body]
|
8463
8746
|
|
8464
8747
|
# return_type
|
8465
|
-
return_type = opts[:return_type] || '
|
8748
|
+
return_type = opts[:return_type] || 'InlineResponse20036'
|
8466
8749
|
|
8467
8750
|
# auth_names
|
8468
8751
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -8684,6 +8967,79 @@ module TalonOne
|
|
8684
8967
|
return data, status_code, headers
|
8685
8968
|
end
|
8686
8969
|
|
8970
|
+
# Import stores
|
8971
|
+
# Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
8972
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
8973
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8974
|
+
# @param [Hash] opts the optional parameters
|
8975
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
8976
|
+
# @return [Import]
|
8977
|
+
def import_campaign_stores(application_id, campaign_id, opts = {})
|
8978
|
+
data, _status_code, _headers = import_campaign_stores_with_http_info(application_id, campaign_id, opts)
|
8979
|
+
data
|
8980
|
+
end
|
8981
|
+
|
8982
|
+
# Import stores
|
8983
|
+
# Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
8984
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
8985
|
+
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8986
|
+
# @param [Hash] opts the optional parameters
|
8987
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
8988
|
+
# @return [Array<(Import, Integer, Hash)>] Import data, response status code and response headers
|
8989
|
+
def import_campaign_stores_with_http_info(application_id, campaign_id, opts = {})
|
8990
|
+
if @api_client.config.debugging
|
8991
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.import_campaign_stores ...'
|
8992
|
+
end
|
8993
|
+
# verify the required parameter 'application_id' is set
|
8994
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
8995
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.import_campaign_stores"
|
8996
|
+
end
|
8997
|
+
# verify the required parameter 'campaign_id' is set
|
8998
|
+
if @api_client.config.client_side_validation && campaign_id.nil?
|
8999
|
+
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling ManagementApi.import_campaign_stores"
|
9000
|
+
end
|
9001
|
+
# resource path
|
9002
|
+
local_var_path = '/v1/applications/{applicationId}/campaigns/{campaignId}/stores/import'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
|
9003
|
+
|
9004
|
+
# query parameters
|
9005
|
+
query_params = opts[:query_params] || {}
|
9006
|
+
|
9007
|
+
# header parameters
|
9008
|
+
header_params = opts[:header_params] || {}
|
9009
|
+
# HTTP header 'Accept' (if needed)
|
9010
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9011
|
+
# HTTP header 'Content-Type'
|
9012
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
9013
|
+
|
9014
|
+
# form parameters
|
9015
|
+
form_params = opts[:form_params] || {}
|
9016
|
+
form_params['upFile'] = opts[:'up_file'] if !opts[:'up_file'].nil?
|
9017
|
+
|
9018
|
+
# http body (model)
|
9019
|
+
post_body = opts[:body]
|
9020
|
+
|
9021
|
+
# return_type
|
9022
|
+
return_type = opts[:return_type] || 'Import'
|
9023
|
+
|
9024
|
+
# auth_names
|
9025
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
9026
|
+
|
9027
|
+
new_options = opts.merge(
|
9028
|
+
:header_params => header_params,
|
9029
|
+
:query_params => query_params,
|
9030
|
+
:form_params => form_params,
|
9031
|
+
:body => post_body,
|
9032
|
+
:auth_names => auth_names,
|
9033
|
+
:return_type => return_type
|
9034
|
+
)
|
9035
|
+
|
9036
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9037
|
+
if @api_client.config.debugging
|
9038
|
+
@api_client.config.logger.debug "API called: ManagementApi#import_campaign_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9039
|
+
end
|
9040
|
+
return data, status_code, headers
|
9041
|
+
end
|
9042
|
+
|
8687
9043
|
# Import data into existing campaign-level collection
|
8688
9044
|
# Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
8689
9045
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -8840,7 +9196,7 @@ module TalonOne
|
|
8840
9196
|
end
|
8841
9197
|
|
8842
9198
|
# Import loyalty cards
|
8843
|
-
# 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 ```
|
9199
|
+
# 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 ```
|
8844
9200
|
# @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.
|
8845
9201
|
# @param [Hash] opts the optional parameters
|
8846
9202
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -8851,7 +9207,7 @@ module TalonOne
|
|
8851
9207
|
end
|
8852
9208
|
|
8853
9209
|
# Import loyalty cards
|
8854
|
-
# 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 ```
|
9210
|
+
# 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 ```
|
8855
9211
|
# @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.
|
8856
9212
|
# @param [Hash] opts the optional parameters
|
8857
9213
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -8907,7 +9263,7 @@ module TalonOne
|
|
8907
9263
|
end
|
8908
9264
|
|
8909
9265
|
# Import customers into loyalty tiers
|
8910
|
-
# Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
9266
|
+
# Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
8911
9267
|
# @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.
|
8912
9268
|
# @param [Hash] opts the optional parameters
|
8913
9269
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -8918,7 +9274,7 @@ module TalonOne
|
|
8918
9274
|
end
|
8919
9275
|
|
8920
9276
|
# Import customers into loyalty tiers
|
8921
|
-
# Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
9277
|
+
# Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
8922
9278
|
# @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.
|
8923
9279
|
# @param [Hash] opts the optional parameters
|
8924
9280
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -8974,7 +9330,7 @@ module TalonOne
|
|
8974
9330
|
end
|
8975
9331
|
|
8976
9332
|
# Import loyalty points
|
8977
|
-
# 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 ```
|
9333
|
+
# 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 ```
|
8978
9334
|
# @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.
|
8979
9335
|
# @param [Hash] opts the optional parameters
|
8980
9336
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -8985,7 +9341,7 @@ module TalonOne
|
|
8985
9341
|
end
|
8986
9342
|
|
8987
9343
|
# Import loyalty points
|
8988
|
-
# 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 ```
|
9344
|
+
# 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 ```
|
8989
9345
|
# @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.
|
8990
9346
|
# @param [Hash] opts the optional parameters
|
8991
9347
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
@@ -9181,7 +9537,7 @@ module TalonOne
|
|
9181
9537
|
end
|
9182
9538
|
|
9183
9539
|
# Invite user from identity provider
|
9184
|
-
# Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
|
9540
|
+
# [Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.
|
9185
9541
|
# @param body [NewExternalInvitation] body
|
9186
9542
|
# @param [Hash] opts the optional parameters
|
9187
9543
|
# @return [nil]
|
@@ -9191,7 +9547,7 @@ module TalonOne
|
|
9191
9547
|
end
|
9192
9548
|
|
9193
9549
|
# Invite user from identity provider
|
9194
|
-
# Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
|
9550
|
+
# [Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address.
|
9195
9551
|
# @param body [NewExternalInvitation] body
|
9196
9552
|
# @param [Hash] opts the optional parameters
|
9197
9553
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -9329,7 +9685,7 @@ module TalonOne
|
|
9329
9685
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
9330
9686
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9331
9687
|
# @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.
|
9332
|
-
# @return [
|
9688
|
+
# @return [InlineResponse20045]
|
9333
9689
|
def list_achievements(application_id, campaign_id, opts = {})
|
9334
9690
|
data, _status_code, _headers = list_achievements_with_http_info(application_id, campaign_id, opts)
|
9335
9691
|
data
|
@@ -9343,7 +9699,7 @@ module TalonOne
|
|
9343
9699
|
# @option opts [Integer] :page_size The number of items in the response.
|
9344
9700
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9345
9701
|
# @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.
|
9346
|
-
# @return [Array<(
|
9702
|
+
# @return [Array<(InlineResponse20045, Integer, Hash)>] InlineResponse20045 data, response status code and response headers
|
9347
9703
|
def list_achievements_with_http_info(application_id, campaign_id, opts = {})
|
9348
9704
|
if @api_client.config.debugging
|
9349
9705
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_achievements ...'
|
@@ -9385,7 +9741,7 @@ module TalonOne
|
|
9385
9741
|
post_body = opts[:body]
|
9386
9742
|
|
9387
9743
|
# return_type
|
9388
|
-
return_type = opts[:return_type] || '
|
9744
|
+
return_type = opts[:return_type] || 'InlineResponse20045'
|
9389
9745
|
|
9390
9746
|
# auth_names
|
9391
9747
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9409,7 +9765,7 @@ module TalonOne
|
|
9409
9765
|
# List roles
|
9410
9766
|
# List all roles.
|
9411
9767
|
# @param [Hash] opts the optional parameters
|
9412
|
-
# @return [
|
9768
|
+
# @return [InlineResponse20043]
|
9413
9769
|
def list_all_roles_v2(opts = {})
|
9414
9770
|
data, _status_code, _headers = list_all_roles_v2_with_http_info(opts)
|
9415
9771
|
data
|
@@ -9418,7 +9774,7 @@ module TalonOne
|
|
9418
9774
|
# List roles
|
9419
9775
|
# List all roles.
|
9420
9776
|
# @param [Hash] opts the optional parameters
|
9421
|
-
# @return [Array<(
|
9777
|
+
# @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
|
9422
9778
|
def list_all_roles_v2_with_http_info(opts = {})
|
9423
9779
|
if @api_client.config.debugging
|
9424
9780
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_all_roles_v2 ...'
|
@@ -9441,7 +9797,7 @@ module TalonOne
|
|
9441
9797
|
post_body = opts[:body]
|
9442
9798
|
|
9443
9799
|
# return_type
|
9444
|
-
return_type = opts[:return_type] || '
|
9800
|
+
return_type = opts[:return_type] || 'InlineResponse20043'
|
9445
9801
|
|
9446
9802
|
# auth_names
|
9447
9803
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9471,7 +9827,7 @@ module TalonOne
|
|
9471
9827
|
# @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.
|
9472
9828
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9473
9829
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9474
|
-
# @return [
|
9830
|
+
# @return [InlineResponse20034]
|
9475
9831
|
def list_catalog_items(catalog_id, opts = {})
|
9476
9832
|
data, _status_code, _headers = list_catalog_items_with_http_info(catalog_id, opts)
|
9477
9833
|
data
|
@@ -9486,7 +9842,7 @@ module TalonOne
|
|
9486
9842
|
# @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.
|
9487
9843
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
9488
9844
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
9489
|
-
# @return [Array<(
|
9845
|
+
# @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
|
9490
9846
|
def list_catalog_items_with_http_info(catalog_id, opts = {})
|
9491
9847
|
if @api_client.config.debugging
|
9492
9848
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_catalog_items ...'
|
@@ -9526,7 +9882,7 @@ module TalonOne
|
|
9526
9882
|
post_body = opts[:body]
|
9527
9883
|
|
9528
9884
|
# return_type
|
9529
|
-
return_type = opts[:return_type] || '
|
9885
|
+
return_type = opts[:return_type] || 'InlineResponse20034'
|
9530
9886
|
|
9531
9887
|
# auth_names
|
9532
9888
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9731,11 +10087,11 @@ module TalonOne
|
|
9731
10087
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9732
10088
|
# @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.
|
9733
10089
|
# @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.
|
9734
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
10090
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
9735
10091
|
# @option opts [String] :name The name of the store.
|
9736
10092
|
# @option opts [String] :integration_id The integration ID of the store.
|
9737
10093
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
9738
|
-
# @return [
|
10094
|
+
# @return [InlineResponse20044]
|
9739
10095
|
def list_stores(application_id, opts = {})
|
9740
10096
|
data, _status_code, _headers = list_stores_with_http_info(application_id, opts)
|
9741
10097
|
data
|
@@ -9749,11 +10105,11 @@ module TalonOne
|
|
9749
10105
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9750
10106
|
# @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.
|
9751
10107
|
# @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.
|
9752
|
-
# @option opts [Float] :campaign_id Filter results by campaign.
|
10108
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
9753
10109
|
# @option opts [String] :name The name of the store.
|
9754
10110
|
# @option opts [String] :integration_id The integration ID of the store.
|
9755
10111
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
9756
|
-
# @return [Array<(
|
10112
|
+
# @return [Array<(InlineResponse20044, Integer, Hash)>] InlineResponse20044 data, response status code and response headers
|
9757
10113
|
def list_stores_with_http_info(application_id, opts = {})
|
9758
10114
|
if @api_client.config.debugging
|
9759
10115
|
@api_client.config.logger.debug 'Calling API: ManagementApi.list_stores ...'
|
@@ -9796,7 +10152,7 @@ module TalonOne
|
|
9796
10152
|
post_body = opts[:body]
|
9797
10153
|
|
9798
10154
|
# return_type
|
9799
|
-
return_type = opts[:return_type] || '
|
10155
|
+
return_type = opts[:return_type] || 'InlineResponse20044'
|
9800
10156
|
|
9801
10157
|
# auth_names
|
9802
10158
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -9885,6 +10241,60 @@ module TalonOne
|
|
9885
10241
|
return data, status_code, headers
|
9886
10242
|
end
|
9887
10243
|
|
10244
|
+
# Validate Okta API ownership
|
10245
|
+
# Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
10246
|
+
# @param [Hash] opts the optional parameters
|
10247
|
+
# @return [nil]
|
10248
|
+
def okta_event_handler_challenge(opts = {})
|
10249
|
+
okta_event_handler_challenge_with_http_info(opts)
|
10250
|
+
nil
|
10251
|
+
end
|
10252
|
+
|
10253
|
+
# Validate Okta API ownership
|
10254
|
+
# Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
10255
|
+
# @param [Hash] opts the optional parameters
|
10256
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
10257
|
+
def okta_event_handler_challenge_with_http_info(opts = {})
|
10258
|
+
if @api_client.config.debugging
|
10259
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.okta_event_handler_challenge ...'
|
10260
|
+
end
|
10261
|
+
# resource path
|
10262
|
+
local_var_path = '/v1/provisioning/okta'
|
10263
|
+
|
10264
|
+
# query parameters
|
10265
|
+
query_params = opts[:query_params] || {}
|
10266
|
+
|
10267
|
+
# header parameters
|
10268
|
+
header_params = opts[:header_params] || {}
|
10269
|
+
|
10270
|
+
# form parameters
|
10271
|
+
form_params = opts[:form_params] || {}
|
10272
|
+
|
10273
|
+
# http body (model)
|
10274
|
+
post_body = opts[:body]
|
10275
|
+
|
10276
|
+
# return_type
|
10277
|
+
return_type = opts[:return_type]
|
10278
|
+
|
10279
|
+
# auth_names
|
10280
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10281
|
+
|
10282
|
+
new_options = opts.merge(
|
10283
|
+
:header_params => header_params,
|
10284
|
+
:query_params => query_params,
|
10285
|
+
:form_params => form_params,
|
10286
|
+
:body => post_body,
|
10287
|
+
:auth_names => auth_names,
|
10288
|
+
:return_type => return_type
|
10289
|
+
)
|
10290
|
+
|
10291
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10292
|
+
if @api_client.config.debugging
|
10293
|
+
@api_client.config.logger.debug "API called: ManagementApi#okta_event_handler_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10294
|
+
end
|
10295
|
+
return data, status_code, headers
|
10296
|
+
end
|
10297
|
+
|
9888
10298
|
# Create notification about added or deducted loyalty points
|
9889
10299
|
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
9890
10300
|
# @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.
|
@@ -10235,99 +10645,34 @@ module TalonOne
|
|
10235
10645
|
return data, status_code, headers
|
10236
10646
|
end
|
10237
10647
|
|
10238
|
-
#
|
10239
|
-
#
|
10240
|
-
# @param
|
10241
|
-
# @param body [Object] body
|
10648
|
+
# Create SCIM user
|
10649
|
+
# Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10650
|
+
# @param body [ScimNewUser] body
|
10242
10651
|
# @param [Hash] opts the optional parameters
|
10243
|
-
# @
|
10244
|
-
|
10245
|
-
|
10246
|
-
# @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.
|
10247
|
-
# @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.
|
10248
|
-
# @option opts [DateTime] :created_after 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.
|
10249
|
-
# @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.
|
10250
|
-
# @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`.
|
10251
|
-
# @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.
|
10252
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
10253
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
10254
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
10255
|
-
# @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. - `draft`: Campaigns that are drafts.
|
10256
|
-
# @return [InlineResponse2009]
|
10257
|
-
def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
|
10258
|
-
data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
|
10652
|
+
# @return [ScimUser]
|
10653
|
+
def scim_create_user(body, opts = {})
|
10654
|
+
data, _status_code, _headers = scim_create_user_with_http_info(body, opts)
|
10259
10655
|
data
|
10260
10656
|
end
|
10261
10657
|
|
10262
|
-
#
|
10263
|
-
#
|
10264
|
-
# @param
|
10265
|
-
# @param body [Object] body
|
10658
|
+
# Create SCIM user
|
10659
|
+
# Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10660
|
+
# @param body [ScimNewUser] body
|
10266
10661
|
# @param [Hash] opts the optional parameters
|
10267
|
-
# @
|
10268
|
-
|
10269
|
-
# @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.
|
10270
|
-
# @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.
|
10271
|
-
# @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.
|
10272
|
-
# @option opts [DateTime] :created_after 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.
|
10273
|
-
# @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.
|
10274
|
-
# @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`.
|
10275
|
-
# @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.
|
10276
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
10277
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
10278
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
10279
|
-
# @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. - `draft`: Campaigns that are drafts.
|
10280
|
-
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
10281
|
-
def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
|
10662
|
+
# @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
|
10663
|
+
def scim_create_user_with_http_info(body, opts = {})
|
10282
10664
|
if @api_client.config.debugging
|
10283
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.
|
10284
|
-
end
|
10285
|
-
# verify the required parameter 'application_id' is set
|
10286
|
-
if @api_client.config.client_side_validation && application_id.nil?
|
10287
|
-
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count"
|
10665
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_create_user ...'
|
10288
10666
|
end
|
10289
10667
|
# verify the required parameter 'body' is set
|
10290
10668
|
if @api_client.config.client_side_validation && body.nil?
|
10291
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.
|
10292
|
-
end
|
10293
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
10294
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be smaller than or equal to 1000.'
|
10295
|
-
end
|
10296
|
-
|
10297
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
10298
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be greater than or equal to 1.'
|
10299
|
-
end
|
10300
|
-
|
10301
|
-
allowable_values = ["expired", "validNow", "validFuture"]
|
10302
|
-
if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
|
10303
|
-
fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
|
10304
|
-
end
|
10305
|
-
allowable_values = ["true", "false"]
|
10306
|
-
if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
|
10307
|
-
fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
|
10308
|
-
end
|
10309
|
-
allowable_values = ["enabled", "disabled", "archived", "draft", "scheduled", "running", "expired"]
|
10310
|
-
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
10311
|
-
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
10669
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_create_user"
|
10312
10670
|
end
|
10313
10671
|
# resource path
|
10314
|
-
local_var_path = '/v1/
|
10672
|
+
local_var_path = '/v1/provisioning/scim/Users'
|
10315
10673
|
|
10316
10674
|
# query parameters
|
10317
10675
|
query_params = opts[:query_params] || {}
|
10318
|
-
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
10319
|
-
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
10320
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
10321
|
-
query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
|
10322
|
-
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
10323
|
-
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
10324
|
-
query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
|
10325
|
-
query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
|
10326
|
-
query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
|
10327
|
-
query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
|
10328
|
-
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
10329
|
-
query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
|
10330
|
-
query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?
|
10331
10676
|
|
10332
10677
|
# header parameters
|
10333
10678
|
header_params = opts[:header_params] || {}
|
@@ -10343,7 +10688,7 @@ module TalonOne
|
|
10343
10688
|
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
10344
10689
|
|
10345
10690
|
# return_type
|
10346
|
-
return_type = opts[:return_type] || '
|
10691
|
+
return_type = opts[:return_type] || 'ScimUser'
|
10347
10692
|
|
10348
10693
|
# auth_names
|
10349
10694
|
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
@@ -10359,7 +10704,622 @@ module TalonOne
|
|
10359
10704
|
|
10360
10705
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10361
10706
|
if @api_client.config.debugging
|
10362
|
-
@api_client.config.logger.debug "API called: ManagementApi#
|
10707
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10708
|
+
end
|
10709
|
+
return data, status_code, headers
|
10710
|
+
end
|
10711
|
+
|
10712
|
+
# Delete SCIM user
|
10713
|
+
# Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10714
|
+
# @param user_id [Integer] The ID of the user.
|
10715
|
+
# @param [Hash] opts the optional parameters
|
10716
|
+
# @return [nil]
|
10717
|
+
def scim_delete_user(user_id, opts = {})
|
10718
|
+
scim_delete_user_with_http_info(user_id, opts)
|
10719
|
+
nil
|
10720
|
+
end
|
10721
|
+
|
10722
|
+
# Delete SCIM user
|
10723
|
+
# Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10724
|
+
# @param user_id [Integer] The ID of the user.
|
10725
|
+
# @param [Hash] opts the optional parameters
|
10726
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
10727
|
+
def scim_delete_user_with_http_info(user_id, opts = {})
|
10728
|
+
if @api_client.config.debugging
|
10729
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_delete_user ...'
|
10730
|
+
end
|
10731
|
+
# verify the required parameter 'user_id' is set
|
10732
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
10733
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_delete_user"
|
10734
|
+
end
|
10735
|
+
# resource path
|
10736
|
+
local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
10737
|
+
|
10738
|
+
# query parameters
|
10739
|
+
query_params = opts[:query_params] || {}
|
10740
|
+
|
10741
|
+
# header parameters
|
10742
|
+
header_params = opts[:header_params] || {}
|
10743
|
+
|
10744
|
+
# form parameters
|
10745
|
+
form_params = opts[:form_params] || {}
|
10746
|
+
|
10747
|
+
# http body (model)
|
10748
|
+
post_body = opts[:body]
|
10749
|
+
|
10750
|
+
# return_type
|
10751
|
+
return_type = opts[:return_type]
|
10752
|
+
|
10753
|
+
# auth_names
|
10754
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10755
|
+
|
10756
|
+
new_options = opts.merge(
|
10757
|
+
:header_params => header_params,
|
10758
|
+
:query_params => query_params,
|
10759
|
+
:form_params => form_params,
|
10760
|
+
:body => post_body,
|
10761
|
+
:auth_names => auth_names,
|
10762
|
+
:return_type => return_type
|
10763
|
+
)
|
10764
|
+
|
10765
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
10766
|
+
if @api_client.config.debugging
|
10767
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10768
|
+
end
|
10769
|
+
return data, status_code, headers
|
10770
|
+
end
|
10771
|
+
|
10772
|
+
# List supported SCIM resource types
|
10773
|
+
# Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
10774
|
+
# @param [Hash] opts the optional parameters
|
10775
|
+
# @return [ScimResourceTypesListResponse]
|
10776
|
+
def scim_get_resource_types(opts = {})
|
10777
|
+
data, _status_code, _headers = scim_get_resource_types_with_http_info(opts)
|
10778
|
+
data
|
10779
|
+
end
|
10780
|
+
|
10781
|
+
# List supported SCIM resource types
|
10782
|
+
# Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
10783
|
+
# @param [Hash] opts the optional parameters
|
10784
|
+
# @return [Array<(ScimResourceTypesListResponse, Integer, Hash)>] ScimResourceTypesListResponse data, response status code and response headers
|
10785
|
+
def scim_get_resource_types_with_http_info(opts = {})
|
10786
|
+
if @api_client.config.debugging
|
10787
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_resource_types ...'
|
10788
|
+
end
|
10789
|
+
# resource path
|
10790
|
+
local_var_path = '/v1/provisioning/scim/ResourceTypes'
|
10791
|
+
|
10792
|
+
# query parameters
|
10793
|
+
query_params = opts[:query_params] || {}
|
10794
|
+
|
10795
|
+
# header parameters
|
10796
|
+
header_params = opts[:header_params] || {}
|
10797
|
+
# HTTP header 'Accept' (if needed)
|
10798
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10799
|
+
|
10800
|
+
# form parameters
|
10801
|
+
form_params = opts[:form_params] || {}
|
10802
|
+
|
10803
|
+
# http body (model)
|
10804
|
+
post_body = opts[:body]
|
10805
|
+
|
10806
|
+
# return_type
|
10807
|
+
return_type = opts[:return_type] || 'ScimResourceTypesListResponse'
|
10808
|
+
|
10809
|
+
# auth_names
|
10810
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10811
|
+
|
10812
|
+
new_options = opts.merge(
|
10813
|
+
:header_params => header_params,
|
10814
|
+
:query_params => query_params,
|
10815
|
+
:form_params => form_params,
|
10816
|
+
:body => post_body,
|
10817
|
+
:auth_names => auth_names,
|
10818
|
+
:return_type => return_type
|
10819
|
+
)
|
10820
|
+
|
10821
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10822
|
+
if @api_client.config.debugging
|
10823
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_resource_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10824
|
+
end
|
10825
|
+
return data, status_code, headers
|
10826
|
+
end
|
10827
|
+
|
10828
|
+
# List supported SCIM schemas
|
10829
|
+
# Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.
|
10830
|
+
# @param [Hash] opts the optional parameters
|
10831
|
+
# @return [ScimSchemasListResponse]
|
10832
|
+
def scim_get_schemas(opts = {})
|
10833
|
+
data, _status_code, _headers = scim_get_schemas_with_http_info(opts)
|
10834
|
+
data
|
10835
|
+
end
|
10836
|
+
|
10837
|
+
# List supported SCIM schemas
|
10838
|
+
# Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.
|
10839
|
+
# @param [Hash] opts the optional parameters
|
10840
|
+
# @return [Array<(ScimSchemasListResponse, Integer, Hash)>] ScimSchemasListResponse data, response status code and response headers
|
10841
|
+
def scim_get_schemas_with_http_info(opts = {})
|
10842
|
+
if @api_client.config.debugging
|
10843
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_schemas ...'
|
10844
|
+
end
|
10845
|
+
# resource path
|
10846
|
+
local_var_path = '/v1/provisioning/scim/Schemas'
|
10847
|
+
|
10848
|
+
# query parameters
|
10849
|
+
query_params = opts[:query_params] || {}
|
10850
|
+
|
10851
|
+
# header parameters
|
10852
|
+
header_params = opts[:header_params] || {}
|
10853
|
+
# HTTP header 'Accept' (if needed)
|
10854
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10855
|
+
|
10856
|
+
# form parameters
|
10857
|
+
form_params = opts[:form_params] || {}
|
10858
|
+
|
10859
|
+
# http body (model)
|
10860
|
+
post_body = opts[:body]
|
10861
|
+
|
10862
|
+
# return_type
|
10863
|
+
return_type = opts[:return_type] || 'ScimSchemasListResponse'
|
10864
|
+
|
10865
|
+
# auth_names
|
10866
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10867
|
+
|
10868
|
+
new_options = opts.merge(
|
10869
|
+
:header_params => header_params,
|
10870
|
+
:query_params => query_params,
|
10871
|
+
:form_params => form_params,
|
10872
|
+
:body => post_body,
|
10873
|
+
:auth_names => auth_names,
|
10874
|
+
:return_type => return_type
|
10875
|
+
)
|
10876
|
+
|
10877
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10878
|
+
if @api_client.config.debugging
|
10879
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10880
|
+
end
|
10881
|
+
return data, status_code, headers
|
10882
|
+
end
|
10883
|
+
|
10884
|
+
# Get SCIM service provider configuration
|
10885
|
+
# Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.
|
10886
|
+
# @param [Hash] opts the optional parameters
|
10887
|
+
# @return [ScimServiceProviderConfigResponse]
|
10888
|
+
def scim_get_service_provider_config(opts = {})
|
10889
|
+
data, _status_code, _headers = scim_get_service_provider_config_with_http_info(opts)
|
10890
|
+
data
|
10891
|
+
end
|
10892
|
+
|
10893
|
+
# Get SCIM service provider configuration
|
10894
|
+
# Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.
|
10895
|
+
# @param [Hash] opts the optional parameters
|
10896
|
+
# @return [Array<(ScimServiceProviderConfigResponse, Integer, Hash)>] ScimServiceProviderConfigResponse data, response status code and response headers
|
10897
|
+
def scim_get_service_provider_config_with_http_info(opts = {})
|
10898
|
+
if @api_client.config.debugging
|
10899
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_service_provider_config ...'
|
10900
|
+
end
|
10901
|
+
# resource path
|
10902
|
+
local_var_path = '/v1/provisioning/scim/ServiceProviderConfig'
|
10903
|
+
|
10904
|
+
# query parameters
|
10905
|
+
query_params = opts[:query_params] || {}
|
10906
|
+
|
10907
|
+
# header parameters
|
10908
|
+
header_params = opts[:header_params] || {}
|
10909
|
+
# HTTP header 'Accept' (if needed)
|
10910
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10911
|
+
|
10912
|
+
# form parameters
|
10913
|
+
form_params = opts[:form_params] || {}
|
10914
|
+
|
10915
|
+
# http body (model)
|
10916
|
+
post_body = opts[:body]
|
10917
|
+
|
10918
|
+
# return_type
|
10919
|
+
return_type = opts[:return_type] || 'ScimServiceProviderConfigResponse'
|
10920
|
+
|
10921
|
+
# auth_names
|
10922
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10923
|
+
|
10924
|
+
new_options = opts.merge(
|
10925
|
+
:header_params => header_params,
|
10926
|
+
:query_params => query_params,
|
10927
|
+
:form_params => form_params,
|
10928
|
+
:body => post_body,
|
10929
|
+
:auth_names => auth_names,
|
10930
|
+
:return_type => return_type
|
10931
|
+
)
|
10932
|
+
|
10933
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10934
|
+
if @api_client.config.debugging
|
10935
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_service_provider_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10936
|
+
end
|
10937
|
+
return data, status_code, headers
|
10938
|
+
end
|
10939
|
+
|
10940
|
+
# Get SCIM user
|
10941
|
+
# Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10942
|
+
# @param user_id [Integer] The ID of the user.
|
10943
|
+
# @param [Hash] opts the optional parameters
|
10944
|
+
# @return [ScimUser]
|
10945
|
+
def scim_get_user(user_id, opts = {})
|
10946
|
+
data, _status_code, _headers = scim_get_user_with_http_info(user_id, opts)
|
10947
|
+
data
|
10948
|
+
end
|
10949
|
+
|
10950
|
+
# Get SCIM user
|
10951
|
+
# Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
10952
|
+
# @param user_id [Integer] The ID of the user.
|
10953
|
+
# @param [Hash] opts the optional parameters
|
10954
|
+
# @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
|
10955
|
+
def scim_get_user_with_http_info(user_id, opts = {})
|
10956
|
+
if @api_client.config.debugging
|
10957
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_user ...'
|
10958
|
+
end
|
10959
|
+
# verify the required parameter 'user_id' is set
|
10960
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
10961
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_get_user"
|
10962
|
+
end
|
10963
|
+
# resource path
|
10964
|
+
local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
10965
|
+
|
10966
|
+
# query parameters
|
10967
|
+
query_params = opts[:query_params] || {}
|
10968
|
+
|
10969
|
+
# header parameters
|
10970
|
+
header_params = opts[:header_params] || {}
|
10971
|
+
# HTTP header 'Accept' (if needed)
|
10972
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10973
|
+
|
10974
|
+
# form parameters
|
10975
|
+
form_params = opts[:form_params] || {}
|
10976
|
+
|
10977
|
+
# http body (model)
|
10978
|
+
post_body = opts[:body]
|
10979
|
+
|
10980
|
+
# return_type
|
10981
|
+
return_type = opts[:return_type] || 'ScimUser'
|
10982
|
+
|
10983
|
+
# auth_names
|
10984
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10985
|
+
|
10986
|
+
new_options = opts.merge(
|
10987
|
+
:header_params => header_params,
|
10988
|
+
:query_params => query_params,
|
10989
|
+
:form_params => form_params,
|
10990
|
+
:body => post_body,
|
10991
|
+
:auth_names => auth_names,
|
10992
|
+
:return_type => return_type
|
10993
|
+
)
|
10994
|
+
|
10995
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10996
|
+
if @api_client.config.debugging
|
10997
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10998
|
+
end
|
10999
|
+
return data, status_code, headers
|
11000
|
+
end
|
11001
|
+
|
11002
|
+
# List SCIM users
|
11003
|
+
# Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
|
11004
|
+
# @param [Hash] opts the optional parameters
|
11005
|
+
# @return [ScimUsersListResponse]
|
11006
|
+
def scim_get_users(opts = {})
|
11007
|
+
data, _status_code, _headers = scim_get_users_with_http_info(opts)
|
11008
|
+
data
|
11009
|
+
end
|
11010
|
+
|
11011
|
+
# List SCIM users
|
11012
|
+
# Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.
|
11013
|
+
# @param [Hash] opts the optional parameters
|
11014
|
+
# @return [Array<(ScimUsersListResponse, Integer, Hash)>] ScimUsersListResponse data, response status code and response headers
|
11015
|
+
def scim_get_users_with_http_info(opts = {})
|
11016
|
+
if @api_client.config.debugging
|
11017
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_get_users ...'
|
11018
|
+
end
|
11019
|
+
# resource path
|
11020
|
+
local_var_path = '/v1/provisioning/scim/Users'
|
11021
|
+
|
11022
|
+
# query parameters
|
11023
|
+
query_params = opts[:query_params] || {}
|
11024
|
+
|
11025
|
+
# header parameters
|
11026
|
+
header_params = opts[:header_params] || {}
|
11027
|
+
# HTTP header 'Accept' (if needed)
|
11028
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11029
|
+
|
11030
|
+
# form parameters
|
11031
|
+
form_params = opts[:form_params] || {}
|
11032
|
+
|
11033
|
+
# http body (model)
|
11034
|
+
post_body = opts[:body]
|
11035
|
+
|
11036
|
+
# return_type
|
11037
|
+
return_type = opts[:return_type] || 'ScimUsersListResponse'
|
11038
|
+
|
11039
|
+
# auth_names
|
11040
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
11041
|
+
|
11042
|
+
new_options = opts.merge(
|
11043
|
+
:header_params => header_params,
|
11044
|
+
:query_params => query_params,
|
11045
|
+
:form_params => form_params,
|
11046
|
+
:body => post_body,
|
11047
|
+
:auth_names => auth_names,
|
11048
|
+
:return_type => return_type
|
11049
|
+
)
|
11050
|
+
|
11051
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
11052
|
+
if @api_client.config.debugging
|
11053
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11054
|
+
end
|
11055
|
+
return data, status_code, headers
|
11056
|
+
end
|
11057
|
+
|
11058
|
+
# Update SCIM user attributes
|
11059
|
+
# Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
11060
|
+
# @param user_id [Integer] The ID of the user.
|
11061
|
+
# @param body [ScimPatchRequest] body
|
11062
|
+
# @param [Hash] opts the optional parameters
|
11063
|
+
# @return [ScimUser]
|
11064
|
+
def scim_patch_user(user_id, body, opts = {})
|
11065
|
+
data, _status_code, _headers = scim_patch_user_with_http_info(user_id, body, opts)
|
11066
|
+
data
|
11067
|
+
end
|
11068
|
+
|
11069
|
+
# Update SCIM user attributes
|
11070
|
+
# Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
11071
|
+
# @param user_id [Integer] The ID of the user.
|
11072
|
+
# @param body [ScimPatchRequest] body
|
11073
|
+
# @param [Hash] opts the optional parameters
|
11074
|
+
# @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
|
11075
|
+
def scim_patch_user_with_http_info(user_id, body, opts = {})
|
11076
|
+
if @api_client.config.debugging
|
11077
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_patch_user ...'
|
11078
|
+
end
|
11079
|
+
# verify the required parameter 'user_id' is set
|
11080
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
11081
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_patch_user"
|
11082
|
+
end
|
11083
|
+
# verify the required parameter 'body' is set
|
11084
|
+
if @api_client.config.client_side_validation && body.nil?
|
11085
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_patch_user"
|
11086
|
+
end
|
11087
|
+
# resource path
|
11088
|
+
local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
11089
|
+
|
11090
|
+
# query parameters
|
11091
|
+
query_params = opts[:query_params] || {}
|
11092
|
+
|
11093
|
+
# header parameters
|
11094
|
+
header_params = opts[:header_params] || {}
|
11095
|
+
# HTTP header 'Accept' (if needed)
|
11096
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11097
|
+
# HTTP header 'Content-Type'
|
11098
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
11099
|
+
|
11100
|
+
# form parameters
|
11101
|
+
form_params = opts[:form_params] || {}
|
11102
|
+
|
11103
|
+
# http body (model)
|
11104
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11105
|
+
|
11106
|
+
# return_type
|
11107
|
+
return_type = opts[:return_type] || 'ScimUser'
|
11108
|
+
|
11109
|
+
# auth_names
|
11110
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
11111
|
+
|
11112
|
+
new_options = opts.merge(
|
11113
|
+
:header_params => header_params,
|
11114
|
+
:query_params => query_params,
|
11115
|
+
:form_params => form_params,
|
11116
|
+
:body => post_body,
|
11117
|
+
:auth_names => auth_names,
|
11118
|
+
:return_type => return_type
|
11119
|
+
)
|
11120
|
+
|
11121
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
11122
|
+
if @api_client.config.debugging
|
11123
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_patch_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11124
|
+
end
|
11125
|
+
return data, status_code, headers
|
11126
|
+
end
|
11127
|
+
|
11128
|
+
# Update SCIM user
|
11129
|
+
# Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
11130
|
+
# @param user_id [Integer] The ID of the user.
|
11131
|
+
# @param body [ScimNewUser] body
|
11132
|
+
# @param [Hash] opts the optional parameters
|
11133
|
+
# @return [ScimUser]
|
11134
|
+
def scim_replace_user_attributes(user_id, body, opts = {})
|
11135
|
+
data, _status_code, _headers = scim_replace_user_attributes_with_http_info(user_id, body, opts)
|
11136
|
+
data
|
11137
|
+
end
|
11138
|
+
|
11139
|
+
# Update SCIM user
|
11140
|
+
# Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
11141
|
+
# @param user_id [Integer] The ID of the user.
|
11142
|
+
# @param body [ScimNewUser] body
|
11143
|
+
# @param [Hash] opts the optional parameters
|
11144
|
+
# @return [Array<(ScimUser, Integer, Hash)>] ScimUser data, response status code and response headers
|
11145
|
+
def scim_replace_user_attributes_with_http_info(user_id, body, opts = {})
|
11146
|
+
if @api_client.config.debugging
|
11147
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.scim_replace_user_attributes ...'
|
11148
|
+
end
|
11149
|
+
# verify the required parameter 'user_id' is set
|
11150
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
11151
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ManagementApi.scim_replace_user_attributes"
|
11152
|
+
end
|
11153
|
+
# verify the required parameter 'body' is set
|
11154
|
+
if @api_client.config.client_side_validation && body.nil?
|
11155
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.scim_replace_user_attributes"
|
11156
|
+
end
|
11157
|
+
# resource path
|
11158
|
+
local_var_path = '/v1/provisioning/scim/Users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
11159
|
+
|
11160
|
+
# query parameters
|
11161
|
+
query_params = opts[:query_params] || {}
|
11162
|
+
|
11163
|
+
# header parameters
|
11164
|
+
header_params = opts[:header_params] || {}
|
11165
|
+
# HTTP header 'Accept' (if needed)
|
11166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11167
|
+
# HTTP header 'Content-Type'
|
11168
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
11169
|
+
|
11170
|
+
# form parameters
|
11171
|
+
form_params = opts[:form_params] || {}
|
11172
|
+
|
11173
|
+
# http body (model)
|
11174
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11175
|
+
|
11176
|
+
# return_type
|
11177
|
+
return_type = opts[:return_type] || 'ScimUser'
|
11178
|
+
|
11179
|
+
# auth_names
|
11180
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
11181
|
+
|
11182
|
+
new_options = opts.merge(
|
11183
|
+
:header_params => header_params,
|
11184
|
+
:query_params => query_params,
|
11185
|
+
:form_params => form_params,
|
11186
|
+
:body => post_body,
|
11187
|
+
:auth_names => auth_names,
|
11188
|
+
:return_type => return_type
|
11189
|
+
)
|
11190
|
+
|
11191
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
11192
|
+
if @api_client.config.debugging
|
11193
|
+
@api_client.config.logger.debug "API called: ManagementApi#scim_replace_user_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11194
|
+
end
|
11195
|
+
return data, status_code, headers
|
11196
|
+
end
|
11197
|
+
|
11198
|
+
# List coupons that match the given attributes (without total count)
|
11199
|
+
# List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
|
11200
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11201
|
+
# @param body [Object] body
|
11202
|
+
# @param [Hash] opts the optional parameters
|
11203
|
+
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
11204
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11205
|
+
# @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.
|
11206
|
+
# @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.
|
11207
|
+
# @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.
|
11208
|
+
# @option opts [DateTime] :created_after 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.
|
11209
|
+
# @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.
|
11210
|
+
# @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`.
|
11211
|
+
# @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.
|
11212
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11213
|
+
# @option opts [String] :batch_id Filter results by batches of coupons
|
11214
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
11215
|
+
# @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.
|
11216
|
+
# @return [InlineResponse2009]
|
11217
|
+
def search_coupons_advanced_application_wide_without_total_count(application_id, body, opts = {})
|
11218
|
+
data, _status_code, _headers = search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts)
|
11219
|
+
data
|
11220
|
+
end
|
11221
|
+
|
11222
|
+
# List coupons that match the given attributes (without total count)
|
11223
|
+
# List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
|
11224
|
+
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11225
|
+
# @param body [Object] body
|
11226
|
+
# @param [Hash] opts the optional parameters
|
11227
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
11228
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11229
|
+
# @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.
|
11230
|
+
# @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.
|
11231
|
+
# @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.
|
11232
|
+
# @option opts [DateTime] :created_after 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.
|
11233
|
+
# @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.
|
11234
|
+
# @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`.
|
11235
|
+
# @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.
|
11236
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11237
|
+
# @option opts [String] :batch_id Filter results by batches of coupons
|
11238
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
11239
|
+
# @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.
|
11240
|
+
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
11241
|
+
def search_coupons_advanced_application_wide_without_total_count_with_http_info(application_id, body, opts = {})
|
11242
|
+
if @api_client.config.debugging
|
11243
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.search_coupons_advanced_application_wide_without_total_count ...'
|
11244
|
+
end
|
11245
|
+
# verify the required parameter 'application_id' is set
|
11246
|
+
if @api_client.config.client_side_validation && application_id.nil?
|
11247
|
+
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count"
|
11248
|
+
end
|
11249
|
+
# verify the required parameter 'body' is set
|
11250
|
+
if @api_client.config.client_side_validation && body.nil?
|
11251
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count"
|
11252
|
+
end
|
11253
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
11254
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be smaller than or equal to 1000.'
|
11255
|
+
end
|
11256
|
+
|
11257
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
11258
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManagementApi.search_coupons_advanced_application_wide_without_total_count, must be greater than or equal to 1.'
|
11259
|
+
end
|
11260
|
+
|
11261
|
+
allowable_values = ["expired", "validNow", "validFuture"]
|
11262
|
+
if @api_client.config.client_side_validation && opts[:'valid'] && !allowable_values.include?(opts[:'valid'])
|
11263
|
+
fail ArgumentError, "invalid value for \"valid\", must be one of #{allowable_values}"
|
11264
|
+
end
|
11265
|
+
allowable_values = ["true", "false"]
|
11266
|
+
if @api_client.config.client_side_validation && opts[:'usable'] && !allowable_values.include?(opts[:'usable'])
|
11267
|
+
fail ArgumentError, "invalid value for \"usable\", must be one of #{allowable_values}"
|
11268
|
+
end
|
11269
|
+
allowable_values = ["enabled", "disabled", "archived", "scheduled", "running", "expired", "staged"]
|
11270
|
+
if @api_client.config.client_side_validation && opts[:'campaign_state'] && !allowable_values.include?(opts[:'campaign_state'])
|
11271
|
+
fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{allowable_values}"
|
11272
|
+
end
|
11273
|
+
# resource path
|
11274
|
+
local_var_path = '/v1/applications/{applicationId}/coupons_search_advanced/no_total'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
|
11275
|
+
|
11276
|
+
# query parameters
|
11277
|
+
query_params = opts[:query_params] || {}
|
11278
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
11279
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
11280
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
11281
|
+
query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
|
11282
|
+
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
11283
|
+
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
11284
|
+
query_params[:'valid'] = opts[:'valid'] if !opts[:'valid'].nil?
|
11285
|
+
query_params[:'usable'] = opts[:'usable'] if !opts[:'usable'].nil?
|
11286
|
+
query_params[:'referralId'] = opts[:'referral_id'] if !opts[:'referral_id'].nil?
|
11287
|
+
query_params[:'recipientIntegrationId'] = opts[:'recipient_integration_id'] if !opts[:'recipient_integration_id'].nil?
|
11288
|
+
query_params[:'batchId'] = opts[:'batch_id'] if !opts[:'batch_id'].nil?
|
11289
|
+
query_params[:'exactMatch'] = opts[:'exact_match'] if !opts[:'exact_match'].nil?
|
11290
|
+
query_params[:'campaignState'] = opts[:'campaign_state'] if !opts[:'campaign_state'].nil?
|
11291
|
+
|
11292
|
+
# header parameters
|
11293
|
+
header_params = opts[:header_params] || {}
|
11294
|
+
# HTTP header 'Accept' (if needed)
|
11295
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11296
|
+
# HTTP header 'Content-Type'
|
11297
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
11298
|
+
|
11299
|
+
# form parameters
|
11300
|
+
form_params = opts[:form_params] || {}
|
11301
|
+
|
11302
|
+
# http body (model)
|
11303
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
11304
|
+
|
11305
|
+
# return_type
|
11306
|
+
return_type = opts[:return_type] || 'InlineResponse2009'
|
11307
|
+
|
11308
|
+
# auth_names
|
11309
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
11310
|
+
|
11311
|
+
new_options = opts.merge(
|
11312
|
+
:header_params => header_params,
|
11313
|
+
:query_params => query_params,
|
11314
|
+
:form_params => form_params,
|
11315
|
+
:body => post_body,
|
11316
|
+
:auth_names => auth_names,
|
11317
|
+
:return_type => return_type
|
11318
|
+
)
|
11319
|
+
|
11320
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
11321
|
+
if @api_client.config.debugging
|
11322
|
+
@api_client.config.logger.debug "API called: ManagementApi#search_coupons_advanced_application_wide_without_total_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10363
11323
|
end
|
10364
11324
|
return data, status_code, headers
|
10365
11325
|
end
|
@@ -10379,8 +11339,8 @@ module TalonOne
|
|
10379
11339
|
# @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.
|
10380
11340
|
# @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`.
|
10381
11341
|
# @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.
|
10382
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
10383
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code (default to false)
|
11342
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11343
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code. (default to false)
|
10384
11344
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
10385
11345
|
# @return [InlineResponse2009]
|
10386
11346
|
def search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts = {})
|
@@ -10403,8 +11363,8 @@ module TalonOne
|
|
10403
11363
|
# @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.
|
10404
11364
|
# @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`.
|
10405
11365
|
# @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.
|
10406
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile
|
10407
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
11366
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
11367
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
10408
11368
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
10409
11369
|
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
10410
11370
|
def search_coupons_advanced_without_total_count_with_http_info(application_id, campaign_id, body, opts = {})
|
@@ -10865,7 +11825,7 @@ module TalonOne
|
|
10865
11825
|
end
|
10866
11826
|
|
10867
11827
|
# Update campaign
|
10868
|
-
# Update the given campaign.
|
11828
|
+
# 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.
|
10869
11829
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10870
11830
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
10871
11831
|
# @param body [UpdateCampaign] body
|
@@ -10877,7 +11837,7 @@ module TalonOne
|
|
10877
11837
|
end
|
10878
11838
|
|
10879
11839
|
# Update campaign
|
10880
|
-
# Update the given campaign.
|
11840
|
+
# 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.
|
10881
11841
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10882
11842
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
10883
11843
|
# @param body [UpdateCampaign] body
|
@@ -11023,7 +11983,7 @@ module TalonOne
|
|
11023
11983
|
end
|
11024
11984
|
|
11025
11985
|
# Update coupon
|
11026
|
-
# Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint
|
11986
|
+
# 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>
|
11027
11987
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11028
11988
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11029
11989
|
# @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.
|
@@ -11036,7 +11996,7 @@ module TalonOne
|
|
11036
11996
|
end
|
11037
11997
|
|
11038
11998
|
# Update coupon
|
11039
|
-
# Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\">Important</p> <p>With this PUT endpoint
|
11999
|
+
# 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>
|
11040
12000
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11041
12001
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11042
12002
|
# @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.
|
@@ -11105,7 +12065,7 @@ module TalonOne
|
|
11105
12065
|
end
|
11106
12066
|
|
11107
12067
|
# Update coupons
|
11108
|
-
# Update all coupons
|
12068
|
+
# 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).
|
11109
12069
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11110
12070
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11111
12071
|
# @param body [UpdateCouponBatch] body
|
@@ -11117,7 +12077,7 @@ module TalonOne
|
|
11117
12077
|
end
|
11118
12078
|
|
11119
12079
|
# Update coupons
|
11120
|
-
# Update all coupons
|
12080
|
+
# 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).
|
11121
12081
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
11122
12082
|
# @param campaign_id [Integer] The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
11123
12083
|
# @param body [UpdateCouponBatch] body
|