From 8211ea0f99584ad0b8cd8c871c2ed3a7d622be63 Mon Sep 17 00:00:00 2001 From: saurabhkmr Date: Thu, 3 Nov 2016 17:46:09 +0530 Subject: [PATCH 001/150] Csharp proxy support --- .../main/resources/csharp/ApiClient.mustache | 15 ++++++++++++++- .../resources/csharp/Configuration.mustache | 18 ++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache index 33b631280c2..9316de0443f 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache @@ -178,7 +178,20 @@ namespace {{packageName}}.Client // set user agent RestClient.UserAgent = Configuration.UserAgent; - InterceptRequest(request); + if(!String.IsNullOrEmpty(Configuration.ProxyUrl)){ + + IWebProxy proxy = new WebProxy(Configuration.ProxyUrl, true); + if (!String.IsNullOrEmpty(Configuration.ProxyUsername)) + { + var credential = new NetworkCredential(Configuration.ProxyUsername, Configuration.ProxyPassword); + proxy.Credentials = credential; + } + } + + RestClient.Proxy=proxy; + + +InterceptRequest(request); {{^supportsUWP}} var response = RestClient.Execute(request); {{/supportsUWP}} diff --git a/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache b/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache index 108b85e48f8..fd1ea2472a1 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache @@ -200,6 +200,24 @@ namespace {{packageName}}.Client /// The password. public String Password { get; set; } + /// + /// Gets or sets the proxyurl (HTTP basic authentication). + /// + /// The proxyurl. + public String ProxyUrl { get; set; } + + /// + /// Gets or sets the proxy username (HTTP basic authentication). + /// + /// The proxy username. + public String ProxyUsername { get; set; } + + /// + /// Gets or sets the proxy password (HTTP basic authentication). + /// + /// The proxy password. + public String ProxyPassword { get; set; } + /// /// Gets or sets the access token for OAuth2 authentication. /// From 3db3534403554bab24b78933dde392122b9ef995 Mon Sep 17 00:00:00 2001 From: saurabhkmr Date: Wed, 16 Nov 2016 18:15:00 +0530 Subject: [PATCH 002/150] c sharp changes for serialization and network error --- .../src/main/resources/CsharpDotNet2/model.mustache | 1 + .../src/main/resources/aspnetcore/model.mustache | 1 + .../src/main/resources/csharp/ApiClient.mustache | 3 +-- .../src/main/resources/csharp/Configuration.mustache | 4 ++++ .../src/main/resources/csharp/modelGeneric.mustache | 1 + 5 files changed, 8 insertions(+), 2 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache b/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache index 3e6e32320e7..743c359f91b 100644 --- a/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache +++ b/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache @@ -12,6 +12,7 @@ namespace {{packageName}}.Model { /// /// {{description}} /// + [Serializable] [DataContract] public class {{classname}}{{#parent}} : {{{parent}}}{{/parent}} { {{#vars}} diff --git a/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache b/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache index 58325e8fe24..77e323dfdd3 100644 --- a/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache +++ b/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache @@ -17,6 +17,7 @@ namespace {{packageName}}.Models /// {{description}} /// [DataContract] + [Serializable] public partial class {{classname}} : {{#parent}}{{{parent}}}, {{/parent}} IEquatable<{{classname}}> { /// diff --git a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache index 9316de0443f..137b079efc9 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache @@ -190,8 +190,7 @@ namespace {{packageName}}.Client RestClient.Proxy=proxy; - -InterceptRequest(request); + InterceptRequest(request); {{^supportsUWP}} var response = RestClient.Execute(request); {{/supportsUWP}} diff --git a/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache b/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache index fd1ea2472a1..166d94deb9e 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/Configuration.mustache @@ -85,6 +85,10 @@ namespace {{packageName}}.Client /// public static readonly ExceptionFactory DefaultExceptionFactory = (methodName, response) => { + if (response.ErrorException is WebException && (response.ErrorException as WebException).Status == WebExceptionStatus.NameResolutionFailure) + { + return new ApiException(523, String.Format("Error calling {0}: {1}", methodName, response.ErrorMessage), response.ErrorMessage); + } int status = (int) response.StatusCode; if (status >= 400) return new ApiException(status, String.Format("Error calling {0}: {1}", methodName, response.Content), response.Content); if (status == 0) return new ApiException(status, String.Format("Error calling {0}: {1}", methodName, response.ErrorMessage), response.ErrorMessage); diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache index 8f0ec47a1fa..228dbe79bf0 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache @@ -2,6 +2,7 @@ /// {{#description}}{{.}}{{/description}}{{^description}}{{classname}}{{/description}} /// [DataContract] + [Serializable] {{#generatePropertyChanged}} [ImplementPropertyChanged] {{/generatePropertyChanged}} From dcc167a0db4a145bccbec8770891be428ceff55e Mon Sep 17 00:00:00 2001 From: saurabhkmr Date: Fri, 18 Nov 2016 15:06:18 +0530 Subject: [PATCH 003/150] removing not required Serialization --- .../src/main/resources/CsharpDotNet2/model.mustache | 1 - .../src/main/resources/aspnetcore/model.mustache | 1 - .../src/main/resources/csharp/modelGeneric.mustache | 6 +++--- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache b/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache index 743c359f91b..3e6e32320e7 100644 --- a/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache +++ b/modules/swagger-codegen/src/main/resources/CsharpDotNet2/model.mustache @@ -12,7 +12,6 @@ namespace {{packageName}}.Model { /// /// {{description}} /// - [Serializable] [DataContract] public class {{classname}}{{#parent}} : {{{parent}}}{{/parent}} { {{#vars}} diff --git a/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache b/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache index 77e323dfdd3..58325e8fe24 100644 --- a/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache +++ b/modules/swagger-codegen/src/main/resources/aspnetcore/model.mustache @@ -17,7 +17,6 @@ namespace {{packageName}}.Models /// {{description}} /// [DataContract] - [Serializable] public partial class {{classname}} : {{#parent}}{{{parent}}}, {{/parent}} IEquatable<{{classname}}> { /// diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache index 228dbe79bf0..c351241ece7 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache @@ -1,8 +1,8 @@ /// /// {{#description}}{{.}}{{/description}}{{^description}}{{classname}}{{/description}} /// - [DataContract] [Serializable] + [DataContract] {{#generatePropertyChanged}} [ImplementPropertyChanged] {{/generatePropertyChanged}} @@ -85,7 +85,7 @@ this.{{name}} = {{name}}; {{/isReadOnly}} {{/vars}} } - + {{#vars}} {{^isEnum}} /// @@ -110,7 +110,7 @@ this.{{name}} = {{name}}; sb.Append("}\n"); return sb.ToString(); } - + /// /// Returns the JSON string presentation of the object /// From 0715858251b165ba7271afb42ff31820091644eb Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 18 Nov 2016 17:08:20 +0530 Subject: [PATCH 004/150] removing IValidatableObject, ValidationResult, ValidationContext --- .../resources/csharp/modelGeneric.mustache | 38 +------------------ 1 file changed, 2 insertions(+), 36 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache index c351241ece7..f5023b955b5 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/modelGeneric.mustache @@ -6,7 +6,7 @@ {{#generatePropertyChanged}} [ImplementPropertyChanged] {{/generatePropertyChanged}} - public partial class {{classname}} : {{#parent}}{{{parent}}}, {{/parent}} IEquatable<{{classname}}>, IValidatableObject + public partial class {{classname}} : {{#parent}}{{{parent}}}, {{/parent}} IEquatable<{{classname}}> { {{#vars}} {{#isEnum}} @@ -189,39 +189,5 @@ this.{{name}} = {{name}}; } {{/generatePropertyChanged}} - public IEnumerable Validate(ValidationContext validationContext) - { {{#vars}}{{#hasValidation}}{{#maxLength}} - // {{{name}}} ({{{datatype}}}) maxLength - if(this.{{{name}}} != null && this.{{{name}}}.Length > {{maxLength}}) - { - yield return new ValidationResult("Invalid value for {{{name}}}, length must be less than {{maxLength}}.", new [] { "{{{name}}}" }); - } -{{/maxLength}}{{#minLength}} - // {{{name}}} ({{{datatype}}}) minLength - if(this.{{{name}}} != null && this.{{{name}}}.Length < {{minLength}}) - { - yield return new ValidationResult("Invalid value for {{{name}}}, length must be greater than {{minLength}}.", new [] { "{{{name}}}" }); - } -{{/minLength}}{{#maximum}} - // {{{name}}} ({{{datatype}}}) maximum - if(this.{{{name}}} > ({{{datatype}}}){{maximum}}) - { - yield return new ValidationResult("Invalid value for {{{name}}}, must be a value less than or equal to {{maximum}}.", new [] { "{{{name}}}" }); - } -{{/maximum}}{{#minimum}} - // {{{name}}} ({{{datatype}}}) minimum - if(this.{{{name}}} < ({{{datatype}}}){{minimum}}) - { - yield return new ValidationResult("Invalid value for {{{name}}}, must be a value greater than or equal to {{minimum}}.", new [] { "{{{name}}}" }); - } -{{/minimum}}{{#pattern}} - // {{{name}}} ({{{datatype}}}) pattern - Regex regex{{{name}}} = new Regex(@"{{vendorExtensions.x-regex}}"{{#vendorExtensions.x-modifiers}}{{#-first}}, {{/-first}}RegexOptions.{{.}}{{^-last}} | {{/-last}}{{/vendorExtensions.x-modifiers}}); - if (false == regex{{{name}}}.Match(this.{{{name}}}).Success) - { - yield return new ValidationResult("Invalid value for {{{name}}}, must match a pattern of {{pattern}}.", new [] { "{{{name}}}" }); - } -{{/pattern}}{{/hasValidation}}{{/vars}} - yield break; - } + } From 4b398379dbdc6c956acc8e710b0e65133ae32a73 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 18 Nov 2016 18:44:23 +0530 Subject: [PATCH 005/150] changing the port of jetty --- modules/swagger-generator/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/swagger-generator/pom.xml b/modules/swagger-generator/pom.xml index c44e4c2afd0..ce59eb2f773 100644 --- a/modules/swagger-generator/pom.xml +++ b/modules/swagger-generator/pom.xml @@ -77,7 +77,7 @@ 8079 stopit - 8080 + 8083 60000 From b5dcc50840d803ccae82d01f74f393476c1a15e7 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 12:57:01 +0530 Subject: [PATCH 006/150] wagon ssh version to alpha 2 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 14183730254..5a33e3fe68c 100644 --- a/pom.xml +++ b/pom.xml @@ -55,7 +55,7 @@ org.apache.maven.wagon wagon-ssh-external - 1.0-alpha-6 + 1.0-alpha-2 org.apache.maven.wagon From f5d6fb4325f6ee965ff5673c6b271c3226831d8c Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 13:58:40 +0530 Subject: [PATCH 007/150] Revert "wagon ssh version to alpha 2" This reverts commit b5dcc50840d803ccae82d01f74f393476c1a15e7. --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 5a33e3fe68c..14183730254 100644 --- a/pom.xml +++ b/pom.xml @@ -55,7 +55,7 @@ org.apache.maven.wagon wagon-ssh-external - 1.0-alpha-2 + 1.0-alpha-6 org.apache.maven.wagon From b24f959de317ec326ff00908550023f26763976f Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 16:35:51 +0530 Subject: [PATCH 008/150] added script to generate swagger sdk --- swagger_sdk_gen.sh | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 swagger_sdk_gen.sh diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh new file mode 100644 index 00000000000..37629bd3ec7 --- /dev/null +++ b/swagger_sdk_gen.sh @@ -0,0 +1,27 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi +echo "GENERATING SDK" +if [ "$Client" = "c#" ] +then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i http://newapi.nightly.capillary.in/swagger.json \ + -l csharp\ + -DtargetFramework=v$Version \ + -o samples/client/intouch_api/csharp_client/c#_$BUILD_NUMBER + tar cvzf samples/client/intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/csharp_client/c#_$BUILD_NUMBER/ . +elif [ "$Client" = "php" ] +then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i http://newapi.nightly.capillary.in/swagger.json \ + -l php \ + -o samples/client/intouch_api/php_client/php_$BUILD_NUMBER + tar cvzf samples/client/intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/php_client/php_$BUILD_NUMBER/ . +elif [ "$Client" = "nodejs" ] +then mkdir -p samples/client/intouch_api/nodejs_client + curl http://newapi.nightly.capillary.in/swagger.json > swagger.json + npm install swagger-js-codegen + cd swagger-js-codegen + node ../nodejs_sdk_gen > ../samples/client/intouch_api/nodejs_client/node_client/node_$BUILD_NUMBER + tar cvzf /samples/client/intouch_api/nodejs_client/node_client/node_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/nodejs_client/node_client/node_$BUILD_NUMBER/ . +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" \ No newline at end of file From f6bf7301ddd3a1315e35fbe3eb6785a071b77c57 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 16:42:26 +0530 Subject: [PATCH 009/150] added swagger nodejs codegen module --- .gitmodules | 3 +++ swagger-js-codegen | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 swagger-js-codegen diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000000..9ec50069494 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "swagger-js-codegen"] + path = swagger-js-codegen + url = https://github.com/wcandillon/swagger-js-codegen.git diff --git a/swagger-js-codegen b/swagger-js-codegen new file mode 160000 index 00000000000..8d753e3ffec --- /dev/null +++ b/swagger-js-codegen @@ -0,0 +1 @@ +Subproject commit 8d753e3ffecaca9820882c5200b1b3746f2aca0d From 330e5e49cc3f145a48f8d1934a057f0f8f3e0a21 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 16:53:11 +0530 Subject: [PATCH 010/150] code to generate nodejs swagger client --- nodejs_sdk_gen | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 nodejs_sdk_gen diff --git a/nodejs_sdk_gen b/nodejs_sdk_gen new file mode 100644 index 00000000000..f9bfd993c04 --- /dev/null +++ b/nodejs_sdk_gen @@ -0,0 +1,6 @@ +var fs = require('fs'); +var CodeGen = require('swagger-js-codegen').CodeGen; +var file = '../swagger.json'; +var swagger = JSON.parse(fs.readFileSync(file, 'UTF-8')); +var nodejsSourceCode = CodeGen.getNodeCode({ className: 'Test', swagger: swagger }); +console.log(nodejsSourceCode); \ No newline at end of file From 0446223fc74dbf42c665b441bcc5313d298c8819 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 22 Nov 2016 17:00:21 +0530 Subject: [PATCH 011/150] script to gen swagger client --- swagger_sdk_gen.sh | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 37629bd3ec7..4914805cd31 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -16,12 +16,11 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o samples/client/intouch_api/php_client/php_$BUILD_NUMBER tar cvzf samples/client/intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/php_client/php_$BUILD_NUMBER/ . elif [ "$Client" = "nodejs" ] -then mkdir -p samples/client/intouch_api/nodejs_client +then mkdir -p samples/client/intouch_api/nodejs_client/ curl http://newapi.nightly.capillary.in/swagger.json > swagger.json npm install swagger-js-codegen cd swagger-js-codegen - node ../nodejs_sdk_gen > ../samples/client/intouch_api/nodejs_client/node_client/node_$BUILD_NUMBER - tar cvzf /samples/client/intouch_api/nodejs_client/node_client/node_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/nodejs_client/node_client/node_$BUILD_NUMBER/ . + node ../nodejs_sdk_gen > ../samples/client/intouch_api/nodejs_client/node_$BUILD_NUMBER else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" \ No newline at end of file From e5a693fc14d377f2e45502901bcf8effff86f0b0 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 5 Dec 2016 16:38:52 +0530 Subject: [PATCH 012/150] added java client --- swagger_sdk_gen.sh | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 4914805cd31..3b9088c75c8 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -2,7 +2,13 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi echo "GENERATING SDK" -if [ "$Client" = "c#" ] +if [ "$Client" = "java" ] +then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i http://newapi.nightly.capillary.in/swagger.json \ + -l java \ + -o samples/client/intouch_api/java_client/java_$BUILD_NUMBER + tar cvzf samples/client/intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/java_client/java_$BUILD_NUMBER/ . +elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l csharp\ From 9f27463e4a9652d88e85839a75d6094e59ad9189 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 13 Dec 2016 15:26:33 +0530 Subject: [PATCH 013/150] added artifact version in java client --- swagger_sdk_gen.sh | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 3b9088c75c8..5c57cf39fe5 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,32 +1,34 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi +curl -k "http://newapi.nightly.capillary.in/version.json" -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l java \ - -o samples/client/intouch_api/java_client/java_$BUILD_NUMBER - tar cvzf samples/client/intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/java_client/java_$BUILD_NUMBER/ . + -o intouch_api/java_client/java_$BUILD_NUMBER \ + -c config.json + tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l csharp\ -DtargetFramework=v$Version \ - -o samples/client/intouch_api/csharp_client/c#_$BUILD_NUMBER - tar cvzf samples/client/intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/csharp_client/c#_$BUILD_NUMBER/ . + -o intouch_api/csharp_client/c#_$BUILD_NUMBER + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#_$BUILD_NUMBER/ . elif [ "$Client" = "php" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l php \ - -o samples/client/intouch_api/php_client/php_$BUILD_NUMBER - tar cvzf samples/client/intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./samples/client/intouch_api/php_client/php_$BUILD_NUMBER/ . + -o intouch_api/php_client/php_$BUILD_NUMBER + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php_$BUILD_NUMBER/ . elif [ "$Client" = "nodejs" ] -then mkdir -p samples/client/intouch_api/nodejs_client/ +then mkdir -p intouch_api/nodejs_client/ curl http://newapi.nightly.capillary.in/swagger.json > swagger.json npm install swagger-js-codegen cd swagger-js-codegen - node ../nodejs_sdk_gen > ../samples/client/intouch_api/nodejs_client/node_$BUILD_NUMBER + node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER else " no client is selected" fi -echo "SWAGGER SDK SUCCESSFULLY GENERATED" \ No newline at end of file +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From e37e0204e0006588bac91cdbffda8b53d36569df Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 15 Dec 2016 15:35:23 +0530 Subject: [PATCH 014/150] added java8 --- swagger_sdk_gen.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 5c57cf39fe5..a877f119048 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -7,6 +7,7 @@ if [ "$Client" = "java" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l java \ + -DdateLibrary=java8 \ -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . From b63f3a80e5b284663a0b85ca7ffa05eda78ba3d7 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 15 Dec 2016 16:18:23 +0530 Subject: [PATCH 015/150] sdk jar --- swagger_sdk_gen.sh | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index a877f119048..77e07457b62 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,6 +11,12 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . + cd intouch_api/java_client/java_$BUILD_NUMBER + mvn3 clean package -Dmaven.test.skip=true + pwd + $file = `ls swagger-java-c*` + echo $file + elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ From 553f6d67497468ffcd141884e4076c4c244b3b17 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 15 Dec 2016 16:32:15 +0530 Subject: [PATCH 016/150] sdk jar --- swagger_sdk_gen.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 77e07457b62..03ce98b1f0b 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -13,6 +13,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . cd intouch_api/java_client/java_$BUILD_NUMBER mvn3 clean package -Dmaven.test.skip=true + cd target pwd $file = `ls swagger-java-c*` echo $file From 882f2782fc1d3da1334264d6bde7b3771a3366d1 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 15 Dec 2016 17:27:12 +0530 Subject: [PATCH 017/150] added maven repo --- .../Java/libraries/okhttp-gson/pom.mustache | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache index 698c1a97f94..3d93091ab2c 100644 --- a/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache +++ b/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache @@ -161,4 +161,18 @@ 4.12 UTF-8 + + + capillarymavenrepo + Capillary Maven Repo + scp://capillary@mvnrepo.capillary.co.in/data/mvn/releases + default + + + capillarymavensnapshotrepo + Capillary Maven Snapshot Repo + scp://capillary@mvnrepo.capillary.co.in/data/mvn/snapshots + default + + \ No newline at end of file From 15fb2b05c5ea44b21ae327569f3bb564f556e75a Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 15 Dec 2016 17:28:41 +0530 Subject: [PATCH 018/150] added maven repo --- swagger_sdk_gen.sh | 7 ------- 1 file changed, 7 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 03ce98b1f0b..a877f119048 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,13 +11,6 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . - cd intouch_api/java_client/java_$BUILD_NUMBER - mvn3 clean package -Dmaven.test.skip=true - cd target - pwd - $file = `ls swagger-java-c*` - echo $file - elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ From 918d462e63a2b9d0c321c294b17ca4854f94b7bf Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 16 Dec 2016 12:47:57 +0530 Subject: [PATCH 019/150] added mvn deploy --- swagger_sdk_gen.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index a877f119048..ee3f30fe89d 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,6 +11,8 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . + cd intouch_api/java_client/java_$BUILD_NUMBER + mvn clean deploy:deploy-file -DpomFile=pom.xml elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ From c6f93c805b63b630426c590cb61c85e289c94cfe Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 16 Dec 2016 13:03:45 +0530 Subject: [PATCH 020/150] mvn deploy --- swagger_sdk_gen.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index ee3f30fe89d..5c78d4b8bb3 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,8 +11,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . - cd intouch_api/java_client/java_$BUILD_NUMBER - mvn clean deploy:deploy-file -DpomFile=pom.xml + mvn clean deploy -f intouch_api/java_client/java_$BUILD_NUMBER/pom.xml elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ From 2fa43e3f9a8ed5c7dfedaf79fb4e00ce2dfd95ab Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 16 Dec 2016 13:09:00 +0530 Subject: [PATCH 021/150] mvn deploy --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 5c78d4b8bb3..2c665bf96eb 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,7 +11,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -o intouch_api/java_client/java_$BUILD_NUMBER \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . - mvn clean deploy -f intouch_api/java_client/java_$BUILD_NUMBER/pom.xml + mvn3 clean deploy -f intouch_api/java_client/java_$BUILD_NUMBER/pom.xml elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ From c42187959e10310d3786839ef6415007f926e465 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 16 Dec 2016 13:20:39 +0530 Subject: [PATCH 022/150] added wagon ssh to java client pom --- .../main/resources/Java/libraries/okhttp-gson/pom.mustache | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache index 3d93091ab2c..9593df769f9 100644 --- a/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache +++ b/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache @@ -102,6 +102,13 @@ 2.10.4 + + + org.apache.maven.wagon + wagon-ssh + 2.9 + + From 33bc6e79a7a250d25f71f6596b20df7e8049cca7 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 16 Dec 2016 16:22:46 +0530 Subject: [PATCH 023/150] removed build number --- swagger_sdk_gen.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 2c665bf96eb..06036f8f934 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -8,23 +8,23 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera -i http://newapi.nightly.capillary.in/swagger.json \ -l java \ -DdateLibrary=java8 \ - -o intouch_api/java_client/java_$BUILD_NUMBER \ + -o intouch_api/java_client/java \ -c config.json - tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java_$BUILD_NUMBER/ . - mvn3 clean deploy -f intouch_api/java_client/java_$BUILD_NUMBER/pom.xml + tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + mvn3 clean deploy -f intouch_api/java_client/java/pom.xml elif [ "$Client" = "c#" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l csharp\ -DtargetFramework=v$Version \ - -o intouch_api/csharp_client/c#_$BUILD_NUMBER - tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#_$BUILD_NUMBER/ . + -o intouch_api/csharp_client/c# + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . elif [ "$Client" = "php" ] then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l php \ - -o intouch_api/php_client/php_$BUILD_NUMBER - tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php_$BUILD_NUMBER/ . + -o intouch_api/php_client/php + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . elif [ "$Client" = "nodejs" ] then mkdir -p intouch_api/nodejs_client/ curl http://newapi.nightly.capillary.in/swagger.json > swagger.json From f933d16eb91dbcc5e1d656b8dc421d7f3bda24df Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Fri, 23 Dec 2016 11:16:36 +0530 Subject: [PATCH 024/150] restrict skip overwriting --- swagger_sdk_gen.sh | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 06036f8f934..10e760a0ae3 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -4,7 +4,9 @@ fi curl -k "http://newapi.nightly.capillary.in/version.json" -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] -then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ +then + rm -rf intouch_api/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l java \ -DdateLibrary=java8 \ @@ -13,20 +15,23 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar genera tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml elif [ "$Client" = "c#" ] -then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ +then rm -rf intouch_api/csharp_client/c# + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l csharp\ -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . elif [ "$Client" = "php" ] -then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ +then rm -rf intouch_api/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i http://newapi.nightly.capillary.in/swagger.json \ -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . elif [ "$Client" = "nodejs" ] -then mkdir -p intouch_api/nodejs_client/ +then rm -rf intouch_api/nodejs_client + mkdir -p intouch_api/nodejs_client/ curl http://newapi.nightly.capillary.in/swagger.json > swagger.json npm install swagger-js-codegen cd swagger-js-codegen From 097ea7729754a0740631e05cafc28874fd45eac6 Mon Sep 17 00:00:00 2001 From: bhavesh1888 Date: Fri, 30 Dec 2016 12:52:52 +0530 Subject: [PATCH 025/150] swagger php changes for tempalte --- .../src/main/resources/php/.php_cs | 4 +-- .../src/main/resources/php/ApiClient.mustache | 12 ++++---- .../resources/php/ObjectSerializer.mustache | 23 ++++++++------- .../src/main/resources/php/api.mustache | 14 +++++----- .../main/resources/php/configuration.mustache | 6 ++-- .../main/resources/php/model_enum.mustache | 4 +-- .../main/resources/php/model_generic.mustache | 28 +++++++++---------- 7 files changed, 47 insertions(+), 44 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/php/.php_cs b/modules/swagger-codegen/src/main/resources/php/.php_cs index 6b8e23c818a..c06f4a27403 100644 --- a/modules/swagger-codegen/src/main/resources/php/.php_cs +++ b/modules/swagger-codegen/src/main/resources/php/.php_cs @@ -4,13 +4,13 @@ return Symfony\CS\Config::create() ->level(Symfony\CS\FixerInterface::PSR2_LEVEL) ->setUsingCache(true) ->fixers( - [ + array( 'ordered_use', 'phpdoc_order', 'short_array_syntax', 'strict', 'strict_param' - ] + ) ) ->finder( Symfony\CS\Finder\DefaultFinder::create() diff --git a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache index effdbedb7f8..c6c7392f452 100644 --- a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache @@ -129,7 +129,7 @@ class ApiClient */ public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType = null, $endpointPath = null) { - $headers = []; + $headers = array(); // construct the http header $headerParams = array_merge( @@ -238,7 +238,7 @@ class ApiClient } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) { // return raw body if response is a file if ($responseType === '\SplFileObject' || $responseType === 'string') { - return [$http_body, $response_info['http_code'], $http_header]; + return array($http_body, $response_info['http_code'], $http_header); } $data = json_decode($http_body); @@ -258,7 +258,7 @@ class ApiClient $data ); } - return [$data, $response_info['http_code'], $http_header]; + return array($data, $response_info['http_code'], $http_header); } /** @@ -307,7 +307,7 @@ class ApiClient protected function httpParseHeaders($raw_headers) { // ref/credit: http://php.net/manual/en/function.http-parse-headers.php#112986 - $headers = []; + $headers = array(); $key = ''; foreach (explode("\n", $raw_headers) as $h) { @@ -317,9 +317,9 @@ class ApiClient if (!isset($headers[$h[0]])) { $headers[$h[0]] = trim($h[1]); } elseif (is_array($headers[$h[0]])) { - $headers[$h[0]] = array_merge($headers[$h[0]], [trim($h[1])]); + $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1]))); } else { - $headers[$h[0]] = array_merge([$headers[$h[0]]], [trim($h[1])]); + $headers[$h[0]] = array_merge([$headers[$h[0]]], array(trim($h[1]))); } $key = $h[0]; diff --git a/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache b/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache index 7208e4c7784..d0a9a758dad 100644 --- a/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache @@ -50,11 +50,13 @@ class ObjectSerializer } return $data; } elseif (is_object($data)) { - $values = []; + $values = array(); foreach (array_keys($data::swaggerTypes()) as $property) { - $getter = $data::getters()[$property]; + $dataGetters = $data::getters(); + $getter = $dataGetters[$property]; if ($data->$getter() !== null) { - $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($data->$getter()); + $dataAttrMap = $data::attributeMap(); + $values[$dataAttrMap[$property]] = self::sanitizeForSerialization($data->$getter()); } } return (object)$values; @@ -212,7 +214,7 @@ class ObjectSerializer return null; } elseif (substr($class, 0, 4) === 'map[') { // for associative array e.g. map[string,int] $inner = substr($class, 4, -1); - $deserialized = []; + $deserialized = array(); if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; @@ -223,7 +225,7 @@ class ObjectSerializer return $deserialized; } elseif (strcasecmp(substr($class, -2), '[]') === 0) { $subClass = substr($class, 0, -2); - $values = []; + $values = array(); foreach ($data as $key => $value) { $values[] = self::deserialize($value, $subClass, null, $discriminator); } @@ -243,7 +245,7 @@ class ObjectSerializer } else { return null; } - } elseif (in_array($class, [{{&primitives}}], true)) { + } elseif (in_array($class, array({{&primitives}}), true)) { settype($data, $class); return $data; } elseif ($class === '\SplFileObject') { @@ -271,13 +273,14 @@ class ObjectSerializer } $instance = new $class(); foreach ($instance::swaggerTypes() as $property => $type) { - $propertySetter = $instance::setters()[$property]; - - if (!isset($propertySetter) || !isset($data->{$instance::attributeMap()[$property]})) { + $instSetters = $instance::setters(); + $propertySetter = $instSetters[$property]; + $instAttrMap = $instance::attributeMap(); + if (!isset($propertySetter) || !isset($data->{$instAttrMap[$property]})) { continue; } - $propertyValue = $data->{$instance::attributeMap()[$property]}; + $propertyValue = $data->{$instAttrMap[$property]}; if (isset($propertyValue)) { $instance->$propertySetter(self::deserialize($propertyValue, $type, null, $discriminator)); } diff --git a/modules/swagger-codegen/src/main/resources/php/api.mustache b/modules/swagger-codegen/src/main/resources/php/api.mustache index 26583a6f3d1..14921374518 100644 --- a/modules/swagger-codegen/src/main/resources/php/api.mustache +++ b/modules/swagger-codegen/src/main/resources/php/api.mustache @@ -168,14 +168,14 @@ use \{{invokerPackage}}\ObjectSerializer; // parse inputs $resourcePath = "{{path}}"; $httpBody = ''; - $queryParams = []; - $headerParams = []; - $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept([{{#produces}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/produces}}]); + $queryParams = array(); + $headerParams = array(); + $formParams = array(); + $_header_accept = $this->apiClient->selectHeaderAccept(array({{#produces}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/produces}})); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([{{#consumes}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/consumes}}]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array({{#consumes}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/consumes}})); {{#queryParams}} // query params @@ -286,10 +286,10 @@ use \{{invokerPackage}}\ObjectSerializer; ); {{#returnType}} - return [$this->apiClient->getSerializer()->deserialize($response, '{{returnType}}', $httpHeader{{#discriminator}}, '{{discriminator}}'{{/discriminator}}), $statusCode, $httpHeader]; + return array($this->apiClient->getSerializer()->deserialize($response, '{{returnType}}', $httpHeader{{#discriminator}}, '{{discriminator}}'{{/discriminator}}), $statusCode, $httpHeader); {{/returnType}} {{^returnType}} - return [null, $statusCode, $httpHeader]; + return array(null, $statusCode, $httpHeader); {{/returnType}} } catch (ApiException $e) { switch ($e->getCode()) { diff --git a/modules/swagger-codegen/src/main/resources/php/configuration.mustache b/modules/swagger-codegen/src/main/resources/php/configuration.mustache index bae256b3bd3..1853b88719d 100644 --- a/modules/swagger-codegen/src/main/resources/php/configuration.mustache +++ b/modules/swagger-codegen/src/main/resources/php/configuration.mustache @@ -38,14 +38,14 @@ class Configuration * * @var string[] */ - protected $apiKeys = []; + protected $apiKeys = array(); /** * Associate array to store API prefix (e.g. Bearer) * * @var string[] */ - protected $apiKeyPrefixes = []; + protected $apiKeyPrefixes = array(); /** * Access token for OAuth @@ -73,7 +73,7 @@ class Configuration * * @var array */ - protected $defaultHeaders = []; + protected $defaultHeaders = array(); /** * The host diff --git a/modules/swagger-codegen/src/main/resources/php/model_enum.mustache b/modules/swagger-codegen/src/main/resources/php/model_enum.mustache index c9250081b82..8287a875a70 100644 --- a/modules/swagger-codegen/src/main/resources/php/model_enum.mustache +++ b/modules/swagger-codegen/src/main/resources/php/model_enum.mustache @@ -9,10 +9,10 @@ class {{classname}} { */ public function {{getter}}AllowableValues() { - return [ + return array( {{#allowableValues}}{{#enumVars}}self::{{datatypeWithEnum}}_{{{name}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}} - ]; + ); } {{/isEnum}}{{/vars}} } \ No newline at end of file diff --git a/modules/swagger-codegen/src/main/resources/php/model_generic.mustache b/modules/swagger-codegen/src/main/resources/php/model_generic.mustache index 1e221b78377..e09a7507e12 100644 --- a/modules/swagger-codegen/src/main/resources/php/model_generic.mustache +++ b/modules/swagger-codegen/src/main/resources/php/model_generic.mustache @@ -10,10 +10,10 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple * Array of property to type mappings. Used for (de)serialization * @var string[] */ - protected static $swaggerTypes = [ + protected static $swaggerTypes = array( {{#vars}}'{{name}}' => '{{{datatype}}}'{{#hasMore}}, {{/hasMore}}{{/vars}} - ]; + ); public static function swaggerTypes() { @@ -24,30 +24,30 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple * Array of attributes where the key is the local name, and the value is the original name * @var string[] */ - protected static $attributeMap = [ + protected static $attributeMap = array( {{#vars}}'{{name}}' => '{{baseName}}'{{#hasMore}}, {{/hasMore}}{{/vars}} - ]; + ); /** * Array of attributes to setter functions (for deserialization of responses) * @var string[] */ - protected static $setters = [ + protected static $setters = array( {{#vars}}'{{name}}' => '{{setter}}'{{#hasMore}}, {{/hasMore}}{{/vars}} - ]; + ); /** * Array of attributes to getter functions (for serialization of requests) * @var string[] */ - protected static $getters = [ + protected static $getters = array( {{#vars}}'{{name}}' => '{{getter}}'{{#hasMore}}, {{/hasMore}}{{/vars}} - ]; + ); public static function attributeMap() { @@ -74,10 +74,10 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple */ public function {{getter}}AllowableValues() { - return [ + return array( {{#allowableValues}}{{#enumVars}}self::{{enumName}}_{{{name}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}} - ]; + ); } {{/isEnum}}{{/vars}} @@ -85,7 +85,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple * Associative array for storing property values * @var mixed[] */ - protected $container = []; + protected $container = array(); /** * Constructor @@ -115,7 +115,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple */ public function listInvalidProperties() { - $invalid_properties = []; + $invalid_properties = array(); {{#vars}} {{#required}} if ($this->container['{{name}}'] === null) { @@ -124,7 +124,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple {{/required}} {{#isEnum}} {{^isContainer}} - $allowed_values = [{{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}]; + $allowed_values = array({{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}); if (!in_array($this->container['{{name}}'], $allowed_values)) { $invalid_properties[] = "invalid value for '{{name}}', must be one of #{allowed_values}."; } @@ -195,7 +195,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple {{/required}} {{#isEnum}} {{^isContainer}} - $allowed_values = [{{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}]; + $allowed_values = array({{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}); if (!in_array($this->container['{{name}}'], $allowed_values)) { return false; } From 8c01ad0769a7d67e4eb21b3594b184fd3a44be16 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 23 Jan 2017 17:04:35 +0530 Subject: [PATCH 026/150] mvn clean --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 10e760a0ae3..981e8d5214e 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,5 +1,5 @@ if $Build_Codegen ; then - mvn3 clean package -Dmaven.test.skip=true + mvn3 clean package -Dmaven.test.skip=true -Dmaven.clean.failOnError=false fi curl -k "http://newapi.nightly.capillary.in/version.json" -o config.json echo "GENERATING SDK" From ed4ed84ab444870fec2eb3e6347918b0ce15992f Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 24 Jan 2017 14:16:33 +0530 Subject: [PATCH 027/150] removed mvn clean failOnError --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 981e8d5214e..10e760a0ae3 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,5 +1,5 @@ if $Build_Codegen ; then - mvn3 clean package -Dmaven.test.skip=true -Dmaven.clean.failOnError=false + mvn3 clean package -Dmaven.test.skip=true fi curl -k "http://newapi.nightly.capillary.in/version.json" -o config.json echo "GENERATING SDK" From 754cfd491732ed91a91243ccee5553c7d0ef290d Mon Sep 17 00:00:00 2001 From: Bhanu Date: Mon, 5 Jun 2017 18:06:17 +0530 Subject: [PATCH 028/150] php sdk debianizing --- swagger_sdk_gen.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 10e760a0ae3..1eec01d42cb 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -29,6 +29,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -s dir -t deb -n swagger-php-sdk -v $BUILD_NUMBER -C ./intouch_api/php_client/php/ --deb-no-default-config-files elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ From 28b0c598e191edd8f41ec7d80747c156aeac4ca6 Mon Sep 17 00:00:00 2001 From: Bhanu Date: Wed, 7 Jun 2017 10:52:21 +0530 Subject: [PATCH 029/150] php sdk debianizing install dir change --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 1eec01d42cb..448dd23b84c 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -29,7 +29,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -s dir -t deb -n swagger-php-sdk -v $BUILD_NUMBER -C ./intouch_api/php_client/php/ --deb-no-default-config-files + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ From 85e326f89fb1ccf48358ba5caf7c26a36b6c6527 Mon Sep 17 00:00:00 2001 From: Bhanu Date: Wed, 7 Jun 2017 11:09:41 +0530 Subject: [PATCH 030/150] Revert "php sdk debianizing install dir change" This reverts commit 28b0c598e191edd8f41ec7d80747c156aeac4ca6. --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 448dd23b84c..1eec01d42cb 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -29,7 +29,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" + fpm -s dir -t deb -n swagger-php-sdk -v $BUILD_NUMBER -C ./intouch_api/php_client/php/ --deb-no-default-config-files elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ From 398073bf3b3385ed4025b46f9f91bd111e2bdf3d Mon Sep 17 00:00:00 2001 From: Bhanu Date: Mon, 12 Jun 2017 15:14:43 +0530 Subject: [PATCH 031/150] Revert "Revert "php sdk debianizing install dir change"" This reverts commit 85e326f89fb1ccf48358ba5caf7c26a36b6c6527. --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 1eec01d42cb..448dd23b84c 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -29,7 +29,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -s dir -t deb -n swagger-php-sdk -v $BUILD_NUMBER -C ./intouch_api/php_client/php/ --deb-no-default-config-files + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ From cafe8fa8ea713649ad6c0ed7ebb77a35d4fdb662 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Thu, 6 Jul 2017 15:41:21 +0530 Subject: [PATCH 032/150] array template change in api client --- .../swagger-codegen/src/main/resources/php/ApiClient.mustache | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache index c6c7392f452..2df3626fe57 100644 --- a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache @@ -319,7 +319,7 @@ class ApiClient } elseif (is_array($headers[$h[0]])) { $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1]))); } else { - $headers[$h[0]] = array_merge([$headers[$h[0]]], array(trim($h[1]))); + $headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1]))); } $key = $h[0]; From 87f86c30abe8082fe3be636f9f62f4cbd43b8c45 Mon Sep 17 00:00:00 2001 From: Rohit Raveendran Date: Fri, 21 Jul 2017 23:45:39 +0530 Subject: [PATCH 033/150] Remove the unavailable snapshot dep --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 14183730254..6843e9d0719 100644 --- a/pom.xml +++ b/pom.xml @@ -807,7 +807,7 @@ - 1.0.24-SNAPSHOT + 1.0.24 2.11.1 2.3.4 1.5.10 From fd289d88f4cd8ec19c8d3f5d5f6b70f236579aed Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 24 Jul 2017 14:48:24 +0530 Subject: [PATCH 034/150] removed snapshot --- modules/swagger-codegen-cli/pom.xml | 2 +- modules/swagger-codegen-maven-plugin/pom.xml | 2 +- modules/swagger-codegen/pom.xml | 2 +- modules/swagger-generator/pom.xml | 2 +- pom.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/swagger-codegen-cli/pom.xml b/modules/swagger-codegen-cli/pom.xml index 6b56d5a6f56..212fd58e5d5 100644 --- a/modules/swagger-codegen-cli/pom.xml +++ b/modules/swagger-codegen-cli/pom.xml @@ -3,7 +3,7 @@ io.swagger swagger-codegen-project - 2.2.2-SNAPSHOT + 2.2.2 ../.. 4.0.0 diff --git a/modules/swagger-codegen-maven-plugin/pom.xml b/modules/swagger-codegen-maven-plugin/pom.xml index 4df64ca4e61..002f0a4498c 100644 --- a/modules/swagger-codegen-maven-plugin/pom.xml +++ b/modules/swagger-codegen-maven-plugin/pom.xml @@ -6,7 +6,7 @@ io.swagger swagger-codegen-project - 2.2.2-SNAPSHOT + 2.2.2 ../.. swagger-codegen-maven-plugin diff --git a/modules/swagger-codegen/pom.xml b/modules/swagger-codegen/pom.xml index 21e44ce2547..5cdb9bba741 100644 --- a/modules/swagger-codegen/pom.xml +++ b/modules/swagger-codegen/pom.xml @@ -3,7 +3,7 @@ io.swagger swagger-codegen-project - 2.2.2-SNAPSHOT + 2.2.2 ../.. 4.0.0 diff --git a/modules/swagger-generator/pom.xml b/modules/swagger-generator/pom.xml index ce59eb2f773..d579907d4f7 100644 --- a/modules/swagger-generator/pom.xml +++ b/modules/swagger-generator/pom.xml @@ -4,7 +4,7 @@ io.swagger swagger-codegen-project - 2.2.2-SNAPSHOT + 2.2.2 ../.. swagger-generator diff --git a/pom.xml b/pom.xml index 6843e9d0719..c791aad4f99 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ swagger-codegen-project pom swagger-codegen-project - 2.2.2-SNAPSHOT + 2.2.2 https://github.com/swagger-api/swagger-codegen scm:git:git@github.com:swagger-api/swagger-codegen.git From 631da8813a21a3ae2fe0a5488369898474324105 Mon Sep 17 00:00:00 2001 From: Bobbali-Bhanu Date: Fri, 28 Jul 2017 12:23:45 +0530 Subject: [PATCH 035/150] production branch swagger generation php --- swagger_sdk_gen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 448dd23b84c..15fd50d1409 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,7 +1,7 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -curl -k "http://newapi.nightly.capillary.in/version.json" -o config.json +curl -k "http://newapi.staging.capillary.in/version.json" -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then @@ -25,7 +25,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://newapi.nightly.capillary.in/swagger.json \ + -i http://newapi.staging.capillary.in/swagger.json \ -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . From 15ef1057b26ee057b3834f5a3fbaf05327ade63a Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 18:09:47 +0530 Subject: [PATCH 036/150] cluster wise sdk generation --- swagger_sdk_gen.sh | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 15fd50d1409..c9b4bb15792 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,7 +1,32 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -curl -k "http://newapi.staging.capillary.in/version.json" -o config.json +if [ "$Environment" = "Nightly" ] + then + $url = "http://newapi.nightly.capillary.in/swagger.json" + $version ="http://newapi.nightly.capillary.in/version.json" +elif ["$Environment" = "Staging"] + then + $url = "http://newapi.staging.capillary.in/swagger.json" + $version ="http://newapi.staging.capillary.in/version.json" +elif ["$Environment" = "APAC2"] + then +elif ["$Environment" = "INDIA"] + then + $url ="http://newapi.capillary.co.in/swagger.json" + $version ="http://newapi.capillary.co.in/version.json" +elif ["$Environment" = "CHINA"] + then + $url = "http://newapi.capillarytech.cn.com/swagger.json" + $version ="http://http://newapi.capillarytech.cn.com/version.json" +elif ["$Environment" = "EU"] + then + $url = "http://newapi.capillarytech.cn.com/swagger.json" + $version ="http://http://newapi.eu.capillarytech.com/version.json" +else " No Environment is selected" +fi + #statements +curl -k $version -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then @@ -25,7 +50,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://newapi.staging.capillary.in/swagger.json \ + -i $url \ -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . From 9bd01b5f65616988460af1440d0ba64829486e4a Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 18:12:56 +0530 Subject: [PATCH 037/150] cluster wise sdk generation fix --- swagger_sdk_gen.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index c9b4bb15792..75ae272a3c4 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,6 +11,8 @@ elif ["$Environment" = "Staging"] $version ="http://newapi.staging.capillary.in/version.json" elif ["$Environment" = "APAC2"] then + $url = "http://newapi.staging.capillary.in/swagger.json" + $version ="http://newapi.staging.capillary.in/version.json" elif ["$Environment" = "INDIA"] then $url ="http://newapi.capillary.co.in/swagger.json" From 10d85220ce1be11083fced72bf9aab6082baafcd Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 18:16:03 +0530 Subject: [PATCH 038/150] Revert "cluster wise sdk generation fix" This reverts commit 9bd01b5f65616988460af1440d0ba64829486e4a. --- swagger_sdk_gen.sh | 2 -- 1 file changed, 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 75ae272a3c4..c9b4bb15792 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -11,8 +11,6 @@ elif ["$Environment" = "Staging"] $version ="http://newapi.staging.capillary.in/version.json" elif ["$Environment" = "APAC2"] then - $url = "http://newapi.staging.capillary.in/swagger.json" - $version ="http://newapi.staging.capillary.in/version.json" elif ["$Environment" = "INDIA"] then $url ="http://newapi.capillary.co.in/swagger.json" From b2f5e88464c0863c63fbbb16c189a64667c84421 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 18:16:16 +0530 Subject: [PATCH 039/150] Revert "cluster wise sdk generation" This reverts commit 15ef1057b26ee057b3834f5a3fbaf05327ade63a. --- swagger_sdk_gen.sh | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index c9b4bb15792..15fd50d1409 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,32 +1,7 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Environment" = "Nightly" ] - then - $url = "http://newapi.nightly.capillary.in/swagger.json" - $version ="http://newapi.nightly.capillary.in/version.json" -elif ["$Environment" = "Staging"] - then - $url = "http://newapi.staging.capillary.in/swagger.json" - $version ="http://newapi.staging.capillary.in/version.json" -elif ["$Environment" = "APAC2"] - then -elif ["$Environment" = "INDIA"] - then - $url ="http://newapi.capillary.co.in/swagger.json" - $version ="http://newapi.capillary.co.in/version.json" -elif ["$Environment" = "CHINA"] - then - $url = "http://newapi.capillarytech.cn.com/swagger.json" - $version ="http://http://newapi.capillarytech.cn.com/version.json" -elif ["$Environment" = "EU"] - then - $url = "http://newapi.capillarytech.cn.com/swagger.json" - $version ="http://http://newapi.eu.capillarytech.com/version.json" -else " No Environment is selected" -fi - #statements -curl -k $version -o config.json +curl -k "http://newapi.staging.capillary.in/version.json" -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then @@ -50,7 +25,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i $url \ + -i http://newapi.staging.capillary.in/swagger.json \ -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . From 2583cc2f3845d6705b192ca4b0474fc19dbb4d7f Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 18:47:12 +0530 Subject: [PATCH 040/150] cluster wise swagger sdk generation --- swagger_sdk_gen.sh | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 15fd50d1409..e568e3ee2b2 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,13 +1,39 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -curl -k "http://newapi.staging.capillary.in/version.json" -o config.json +if [ "$Environment" = "Nightly" ] + then + url="http://newapi.nightly.capillary.in/swagger.json" + version="http://newapi.nightly.capillary.in/version.json" +elif [ "$Environment" = "Staging" ] + then + url="http://newapi.staging.capillary.in/swagger.json" + version="http://newapi.staging.capillary.in/version.json" +elif [ "$Environment" = "APAC2" ] + then + url="http://apac2.newapi.capillarytech.com/swagger.json" + version="http://apac2.newapi.capillarytech.com/version.json" +elif [ "$Environment" = "INDIA" ] + then + url="http://newapi.capillary.co.in/swagger.json" + version="http://newapi.capillary.co.in/version.json" +elif [ "$Environment" = "CHINA" ] + then + url="http://newapi.capillarytech.cn.com/swagger.json" + version="http://newapi.capillarytech.cn.com/version.json" +elif [ "$Environment" = "EU" ] + then + url="http://newapi.eu.capillarytech.com/swagger.json" + version="http://newapi.eu.capillarytech.com/version.json" +else " No Environment is selected" +fi +curl -k $version -o config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf intouch_api/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://newapi.nightly.capillary.in/swagger.json \ + -i $url \ -l java \ -DdateLibrary=java8 \ -o intouch_api/java_client/java \ @@ -17,7 +43,7 @@ then elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://newapi.nightly.capillary.in/swagger.json \ + -i $url \ -l csharp\ -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# @@ -25,7 +51,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://newapi.staging.capillary.in/swagger.json \ + -i $url \ -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . @@ -33,7 +59,7 @@ then rm -rf intouch_api/php_client/php elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ - curl http://newapi.nightly.capillary.in/swagger.json > swagger.json + curl $url > swagger.json npm install swagger-js-codegen cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER From 06c09d8875324a8b292a49121fadf4197346e36d Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 19:09:20 +0530 Subject: [PATCH 041/150] Nightly and staging sdk gen --- swagger_sdk_gen.sh | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index e568e3ee2b2..bbbd5406409 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -9,22 +9,6 @@ elif [ "$Environment" = "Staging" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" -elif [ "$Environment" = "APAC2" ] - then - url="http://apac2.newapi.capillarytech.com/swagger.json" - version="http://apac2.newapi.capillarytech.com/version.json" -elif [ "$Environment" = "INDIA" ] - then - url="http://newapi.capillary.co.in/swagger.json" - version="http://newapi.capillary.co.in/version.json" -elif [ "$Environment" = "CHINA" ] - then - url="http://newapi.capillarytech.cn.com/swagger.json" - version="http://newapi.capillarytech.cn.com/version.json" -elif [ "$Environment" = "EU" ] - then - url="http://newapi.eu.capillarytech.com/swagger.json" - version="http://newapi.eu.capillarytech.com/version.json" else " No Environment is selected" fi curl -k $version -o config.json From ef538458ee9d82fdffa67922d4c283ea36855187 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 19:27:22 +0530 Subject: [PATCH 042/150] Nightly and staging sdk gen --- swagger_sdk_gen.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index bbbd5406409..78e279d5baa 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,15 +1,15 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Environment" = "Nightly" ] +if [ "$Version" = "Nightly" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Environment" = "Staging" ] +elif [ "$Version" = "Staging" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" -else " No Environment is selected" +else " No Version is selected" fi curl -k $version -o config.json echo "GENERATING SDK" From 1421e436e93b2cb2dbd12f8f13a090308c443141 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 19:32:08 +0530 Subject: [PATCH 043/150] Revert "Nightly and staging sdk gen" This reverts commit ef538458ee9d82fdffa67922d4c283ea36855187. --- swagger_sdk_gen.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 78e279d5baa..bbbd5406409 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,15 +1,15 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Version" = "Nightly" ] +if [ "$Environment" = "Nightly" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Version" = "Staging" ] +elif [ "$Environment" = "Staging" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" -else " No Version is selected" +else " No Environment is selected" fi curl -k $version -o config.json echo "GENERATING SDK" From c3adf05e9a033e8a8a827963366183edb11e9ec2 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 31 Jul 2017 19:38:31 +0530 Subject: [PATCH 044/150] snapshot and release --- swagger_sdk_gen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index bbbd5406409..0861fd6d270 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,11 +1,11 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Environment" = "Nightly" ] +if [ "$Environment" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Environment" = "Staging" ] +elif [ "$Environment" = "release" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" From d6900f8d7e3b5115bd386b28efc0b3815f87ff24 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 1 Aug 2017 11:41:18 +0530 Subject: [PATCH 045/150] changed snapshot,release env to branch --- swagger_sdk_gen.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 0861fd6d270..677cc4a40a3 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -1,15 +1,15 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Environment" = "snapshot" ] +if [ "$Branch" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Environment" = "release" ] +elif [ "$Branch" = "release" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" -else " No Environment is selected" +else " No Branch is selected" fi curl -k $version -o config.json echo "GENERATING SDK" From fdd92509f9125bb0caefcb415d8fee9803c2ead6 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 1 Aug 2017 11:48:42 +0530 Subject: [PATCH 046/150] changed branch name from release to staging --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 677cc4a40a3..5ca2a401ea5 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -5,7 +5,7 @@ if [ "$Branch" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Branch" = "release" ] +elif [ "$Branch" = "staging" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" From 074602a631c40130cedc01a2042b8019a3abcecc Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 1 Aug 2017 12:11:30 +0530 Subject: [PATCH 047/150] added sdk debianizing --- swagger_sdk_gen.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 5ca2a401ea5..0a7908f9410 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -24,6 +24,7 @@ then -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -32,6 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -47,6 +49,7 @@ then rm -rf intouch_api/nodejs_client npm install swagger-js-codegen cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 261aa84fa3be496782637a6a872e4148c6b97906 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 29 Aug 2017 15:29:56 +0530 Subject: [PATCH 048/150] staging url for branch release --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 0a7908f9410..8349d43042c 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -5,7 +5,7 @@ if [ "$Branch" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Branch" = "staging" ] +elif [ "$Branch" = "release" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" From 9895eb78ce64e16b7fd45d33e3fe03d76f3e5109 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 29 Aug 2017 15:40:54 +0530 Subject: [PATCH 049/150] Revert "staging url for branch release" This reverts commit 261aa84fa3be496782637a6a872e4148c6b97906. --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 8349d43042c..0a7908f9410 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -5,7 +5,7 @@ if [ "$Branch" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Branch" = "release" ] +elif [ "$Branch" = "staging" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" From 2d6c2f54a051661aa96c6c7d9a434a4236374558 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 29 Aug 2017 16:00:42 +0530 Subject: [PATCH 050/150] production branch name --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 0a7908f9410..850b22acf44 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -5,7 +5,7 @@ if [ "$Branch" = "snapshot" ] then url="http://newapi.nightly.capillary.in/swagger.json" version="http://newapi.nightly.capillary.in/version.json" -elif [ "$Branch" = "staging" ] +elif [ "$Branch" = "production" ] then url="http://newapi.staging.capillary.in/swagger.json" version="http://newapi.staging.capillary.in/version.json" From 8e88953814db6a342195d48bfc71869184f23103 Mon Sep 17 00:00:00 2001 From: Bobbali-Bhanu Date: Fri, 15 Sep 2017 17:41:39 +0530 Subject: [PATCH 051/150] headers in response --- modules/swagger-codegen/src/main/resources/php/api.mustache | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/resources/php/api.mustache b/modules/swagger-codegen/src/main/resources/php/api.mustache index 14921374518..e2941d1ea2f 100644 --- a/modules/swagger-codegen/src/main/resources/php/api.mustache +++ b/modules/swagger-codegen/src/main/resources/php/api.mustache @@ -98,7 +98,10 @@ use \{{invokerPackage}}\ObjectSerializer; */ public function {{operationId}}({{#allParams}}${{paramName}}{{^required}} = null{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { - list($response) = $this->{{operationId}}WithHttpInfo({{#allParams}}${{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); + $responseWithHeaders = $this->{{operationId}}WithHttpInfo({{#allParams}}${{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); + list($response) = $responseWithHeaders; + $response["api_status"] = $responseWithHeaders["1"]; + $response["headers"] = $responseWithHeaders["2"]; return $response; } From a6b51c22caab5202a0d0641a41d969dd028ea310 Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Mon, 18 Sep 2017 13:42:43 +0530 Subject: [PATCH 052/150] generate python SDK --- swagger_sdk_gen.sh | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 850b22acf44..532fb9e4e08 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -50,6 +50,14 @@ then rm -rf intouch_api/nodejs_client cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" +elif [ "$Client" = "python" ] +then rm -rf intouch_api/python_client + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l python \ + -o intouch_api/python_client/python + tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" From c1ed3fbf35dd02c785229d62c661a60f032a002e Mon Sep 17 00:00:00 2001 From: swativerma11 Date: Tue, 19 Sep 2017 19:15:35 +0530 Subject: [PATCH 053/150] python .deb --- swagger_sdk_gen.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 532fb9e4e08..ad2ed8e607c 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -24,7 +24,7 @@ then -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -33,7 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -49,7 +49,7 @@ then rm -rf intouch_api/nodejs_client npm install swagger-js-codegen cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" elif [ "$Client" = "python" ] then rm -rf intouch_api/python_client java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -57,7 +57,7 @@ then rm -rf intouch_api/python_client -l python \ -o intouch_api/python_client/python tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 7305404e683f9cd5db98677dd52d66d7d56d3cdb Mon Sep 17 00:00:00 2001 From: VishalTejaswi Date: Tue, 17 Oct 2017 14:57:14 +0530 Subject: [PATCH 054/150] Swagger java8 setting java.util.Date for DateTime format --- .../io/swagger/codegen/languages/AbstractJavaCodegen.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java index 052a0f82316..0d42666b4b3 100644 --- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java +++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java @@ -8,6 +8,7 @@ import java.util.List; import java.util.ListIterator; import java.util.Map; +import java.util.Date; import java.util.regex.Pattern; import org.apache.commons.lang3.BooleanUtils; @@ -285,6 +286,9 @@ else if (dateLibrary.startsWith("java8")) { typeMapping.put("DateTime", "OffsetDateTime"); importMapping.put("OffsetDateTime", "java.time.OffsetDateTime"); } + + typeMapping.put("DateTime", "Date"); + importMapping.put("DateTime", "java.util.Date"); } } From 795249f5010ec4e08f8e64e8473c3de7d20bedf1 Mon Sep 17 00:00:00 2001 From: luckynarayana Date: Fri, 15 Dec 2017 20:09:35 +0530 Subject: [PATCH 055/150] added iris (campaigns api) configuration for swagger sdk --- configurations/IrisConfiguration.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 configurations/IrisConfiguration.json diff --git a/configurations/IrisConfiguration.json b/configurations/IrisConfiguration.json new file mode 100644 index 00000000000..bd22d630559 --- /dev/null +++ b/configurations/IrisConfiguration.json @@ -0,0 +1,3 @@ +{ +"invokerPackage":"Iris\Client" +} From f903ed695f9a87914c620fb6c0e4b0ad2d299801 Mon Sep 17 00:00:00 2001 From: Bobbali-Bhanu Date: Thu, 2 May 2019 17:39:53 +0530 Subject: [PATCH 056/150] swagger sdk --- .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../okhttp-gson/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../feign/src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../feign/src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../java/feign/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../jersey1/src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../java/jersey1/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../jersey2-java6/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../jersey2-java8/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../jersey2/src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../java/jersey2/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../okhttp-gson/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../retrofit/src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../java/retrofit/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../java/retrofit2/src/main/gen/io/swagger/client/R.java | 7 +++++++ .../src/main/gen/io/swagger/client/BuildConfig.java | 8 ++++++++ .../src/main/gen/io/swagger/client/Manifest.java | 7 +++++++ .../retrofit2rx/src/main/gen/io/swagger/client/R.java | 7 +++++++ swagger_sdk_gen.sh | 4 ++-- 34 files changed, 244 insertions(+), 2 deletions(-) create mode 100644 samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/feign/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/feign/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/feign/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/R.java create mode 100644 samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/BuildConfig.java create mode 100644 samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/Manifest.java create mode 100644 samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/R.java diff --git a/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/R.java b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore-security-test/java/okhttp-gson/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/feign/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/jersey1/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java6/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/jersey2-java8/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/jersey2/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/retrofit/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/retrofit2/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/BuildConfig.java b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/BuildConfig.java new file mode 100644 index 00000000000..720765940d3 --- /dev/null +++ b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/BuildConfig.java @@ -0,0 +1,8 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the BuildConfig class actually packed into the APK */ +public final class BuildConfig { + public final static boolean DEBUG = Boolean.parseBoolean(null); +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/Manifest.java b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/Manifest.java new file mode 100644 index 00000000000..41e0523a208 --- /dev/null +++ b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/Manifest.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the Manifest class actually packed into the APK */ +public final class Manifest { +} \ No newline at end of file diff --git a/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/R.java b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/R.java new file mode 100644 index 00000000000..cd0683364d5 --- /dev/null +++ b/samples/client/petstore/java/retrofit2rx/src/main/gen/io/swagger/client/R.java @@ -0,0 +1,7 @@ +/*___Generated_by_IDEA___*/ + +package io.swagger.client; + +/* This stub is only used by the IDE. It is NOT the R class actually packed into the APK */ +public final class R { +} \ No newline at end of file diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index ad2ed8e607c..d3b6618f6e5 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -3,8 +3,8 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://newapi.nightly.capillary.in/swagger.json" - version="http://newapi.nightly.capillary.in/version.json" + url="http://newapi-nightly.capillary.in/swagger.json" + version="http://newapi-nightly.capillary.in/version.json" elif [ "$Branch" = "production" ] then url="http://newapi.staging.capillary.in/swagger.json" From e97d59c71f71af6ecc99690c0aa4a0c74ecfa8c0 Mon Sep 17 00:00:00 2001 From: manohar-angirekula <40820540+manohar-angirekula@users.noreply.github.com> Date: Thu, 27 Jun 2019 13:22:45 +0530 Subject: [PATCH 057/150] Update ApiClient.mustache --- .../src/main/resources/csharp/ApiClient.mustache | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache index 137b079efc9..ae0bdb94772 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/ApiClient.mustache @@ -23,7 +23,9 @@ namespace {{packageName}}.Client { private JsonSerializerSettings serializerSettings = new JsonSerializerSettings { - ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor, + DateFormatHandling= DateFormatHandling.IsoDateFormat, + DateTimeZoneHandling= DateTimeZoneHandling.Utc }; /// From 60d82487662caf5746864ea9a9bfee1c8c36bb83 Mon Sep 17 00:00:00 2001 From: Ankit Date: Mon, 26 Aug 2019 18:09:04 +0530 Subject: [PATCH 058/150] swagger_sdk_v3 --- swagger_sdk_gen_v3.sh | 63 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 swagger_sdk_gen_v3.sh diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh new file mode 100644 index 00000000000..03010c80ac8 --- /dev/null +++ b/swagger_sdk_gen_v3.sh @@ -0,0 +1,63 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi +if [ "$Branch" = "snapshot" ] + then + url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" + version="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs/version.json" +elif [ "$Branch" = "production" ] + then + url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" + version="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs/version.json" +else " No Branch is selected" +fi +curl -k $version -o config.json +echo "GENERATING SDK" +if [ "$Client" = "java" ] +then + rm -rf intouch_api/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l java \ + -DdateLibrary=java8 \ + -o intouch_api/java_client/java \ + -c config.json + tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + mvn3 clean deploy -f intouch_api/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" +elif [ "$Client" = "c#" ] +then rm -rf intouch_api/csharp_client/c# + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l csharp\ + -DtargetFramework=v$Version \ + -o intouch_api/csharp_client/c# + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" +elif [ "$Client" = "php" ] +then rm -rf intouch_api/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l php \ + -o intouch_api/php_client/php + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" +elif [ "$Client" = "nodejs" ] +then rm -rf intouch_api/nodejs_client + mkdir -p intouch_api/nodejs_client/ + curl $url > swagger.json + npm install swagger-js-codegen + cd swagger-js-codegen + node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" +elif [ "$Client" = "python" ] +then rm -rf intouch_api/python_client + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l python \ + -o intouch_api/python_client/python + tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 7a971ab81ebea2d7b466a30da4f381d0b024e8aa Mon Sep 17 00:00:00 2001 From: Ankit Date: Mon, 26 Aug 2019 19:06:20 +0530 Subject: [PATCH 059/150] swagger --- swagger_sdk_gen_v3.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 03010c80ac8..bc3b2d7049a 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -24,7 +24,7 @@ then -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml - fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -33,7 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . - fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -41,7 +41,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ @@ -49,7 +49,7 @@ then rm -rf intouch_api/nodejs_client npm install swagger-js-codegen cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER - fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" elif [ "$Client" = "python" ] then rm -rf intouch_api/python_client java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -57,7 +57,7 @@ then rm -rf intouch_api/python_client -l python \ -o intouch_api/python_client/python tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . - fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" From ec9b41893a780bbb69812ca9ac4411cb3adb0e7b Mon Sep 17 00:00:00 2001 From: Ankit Date: Mon, 26 Aug 2019 20:38:40 +0530 Subject: [PATCH 060/150] sdk-v3 --- swagger_sdk_gen_v3.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index bc3b2d7049a..67619a17e79 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -24,7 +24,7 @@ then -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml - fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -33,7 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . - fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -41,7 +41,7 @@ then rm -rf intouch_api/php_client/php -l php \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ @@ -49,7 +49,7 @@ then rm -rf intouch_api/nodejs_client npm install swagger-js-codegen cd swagger-js-codegen node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER - fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "python" ] then rm -rf intouch_api/python_client java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ @@ -57,7 +57,7 @@ then rm -rf intouch_api/python_client -l python \ -o intouch_api/python_client/python tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . - fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-v3-sdk" else " no client is selected" fi echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 95a5f8e202020267556cdc38ba3ea7d337635219 Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 28 Aug 2019 13:56:40 +0530 Subject: [PATCH 061/150] java namespace --- swagger_sdk_gen_v3.sh | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 67619a17e79..1d8b548eb2f 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -22,6 +22,11 @@ then -DdateLibrary=java8 \ -o intouch_api/java_client/java \ -c config.json + --group-id com.capillary.platforms + --artifact-version $version + --model-package com.capillary.platforms.intouch-api.models.v3 + --api-package com.capillary.platforms.intouch-api.api.v3 + --artifact-id intouch-api-client.v3 tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-v3-sdk" From aeff81c239b1fb05c5fcae4431fd5dcaaba99b1e Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 28 Aug 2019 16:58:32 +0530 Subject: [PATCH 062/150] version api add --- swagger_sdk_gen_v3.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 1d8b548eb2f..eb4ac05b976 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -4,11 +4,11 @@ fi if [ "$Branch" = "snapshot" ] then url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" - version="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs/version.json" + version="https://nightly.capillary.in/v3/meta/version" elif [ "$Branch" = "production" ] then url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" - version="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs/version.json" + version="https://nightly.capillary.in/v3/meta/version" else " No Branch is selected" fi curl -k $version -o config.json From df0f72d127e769a7e9ca922b3e2a9c8bdd4f4add Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 28 Aug 2019 17:14:17 +0530 Subject: [PATCH 063/150] swagger sdk --- swagger_sdk_gen_v3.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index eb4ac05b976..de9b90402ef 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -21,11 +21,11 @@ then -l java \ -DdateLibrary=java8 \ -o intouch_api/java_client/java \ - -c config.json - --group-id com.capillary.platforms - --artifact-version $version - --model-package com.capillary.platforms.intouch-api.models.v3 - --api-package com.capillary.platforms.intouch-api.api.v3 + + --group-id com.capillary.platforms \ + --artifact-version $version \ + --model-package com.capillary.platforms.intouch-api.models.v3 \ + --api-package com.capillary.platforms.intouch-api.api.v3 \ --artifact-id intouch-api-client.v3 tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml From c59f87d51457c7592cf48b0ac5e1db460dcf5d5b Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 28 Aug 2019 18:42:22 +0530 Subject: [PATCH 064/150] version --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index de9b90402ef..1904e29a800 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -21,7 +21,7 @@ then -l java \ -DdateLibrary=java8 \ -o intouch_api/java_client/java \ - + -c config.json \ --group-id com.capillary.platforms \ --artifact-version $version \ --model-package com.capillary.platforms.intouch-api.models.v3 \ From 2cd685327cc97482692b2bfa3014ff122fd93018 Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 28 Aug 2019 18:54:50 +0530 Subject: [PATCH 065/150] re --- swagger_sdk_gen_v3.sh | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 1904e29a800..d680d242448 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -21,15 +21,11 @@ then -l java \ -DdateLibrary=java8 \ -o intouch_api/java_client/java \ - -c config.json \ - --group-id com.capillary.platforms \ - --artifact-version $version \ - --model-package com.capillary.platforms.intouch-api.models.v3 \ - --api-package com.capillary.platforms.intouch-api.api.v3 \ - --artifact-id intouch-api-client.v3 + -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . mvn3 clean deploy -f intouch_api/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-v3-sdk" + elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ From 8168914d3b84a035d0f2997d6bff955de0b573da Mon Sep 17 00:00:00 2001 From: Ankit Date: Thu, 29 Aug 2019 22:03:53 +0530 Subject: [PATCH 066/150] php version --- swagger_sdk_gen_v3.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index d680d242448..33477f94a7b 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -40,7 +40,8 @@ then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l php \ - -o intouch_api/php_client/php + -o intouch_api/php_client/php \ + -c config.json tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "nodejs" ] From 8e375dd17a85ac44b6d37c712295be89a4f2d3e7 Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 20:16:52 +0530 Subject: [PATCH 067/150] php namesapce --- swagger_sdk_gen_v3.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 33477f94a7b..95018c32fdd 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -38,6 +38,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -DpackageName=Swagger.V3 \ -i $url \ -l php \ -o intouch_api/php_client/php \ From 0e77f1bf9d598d2d0553b1ddd02bf85eb5aeee40 Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 21:57:34 +0530 Subject: [PATCH 068/150] namespace add --- swagger_sdk_gen_v3.sh | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 95018c32fdd..64fa040c393 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,6 +12,10 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json +echo '{ + "invokerPackage": "Example", + "modelPackage": "Example\\Model", + "apiPackage": "Example\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then @@ -38,11 +42,10 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -DpackageName=Swagger.V3 \ -i $url \ -l php \ -o intouch_api/php_client/php \ - -c config.json + -c config_php.json tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-v3-sdk" elif [ "$Client" = "nodejs" ] From 7286dad1aeec999d365ab9440558092cce00fa81 Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:09:54 +0530 Subject: [PATCH 069/150] namesaoce add --- swagger_sdk_gen_v3.sh | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 64fa040c393..946dd83c865 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,10 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{ - "invokerPackage": "Example", - "modelPackage": "Example\\Model", - "apiPackage": "Example\\Api"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage": "Example","modelPackage": "Example\\Model","apiPackage": "Example\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From a5108414ad8d4ce40c02b513c06a43755b56d1a2 Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:16:06 +0530 Subject: [PATCH 070/150] namespace --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 946dd83c865..31afe4acbb5 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage": "Example","modelPackage": "Example\\Model","apiPackage": "Example\\Api"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\\Model","apiPackage":"Example\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From 734105038cc5050ffb776d283321baeaed5876df Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:18:17 +0530 Subject: [PATCH 071/150] namespace --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 31afe4acbb5..9efd2e93fd4 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\\Model","apiPackage":"Example\\Api"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From bf57d07e7c8c41073205a769837dc22965ead406 Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:22:05 +0530 Subject: [PATCH 072/150] namespace --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 9efd2e93fd4..abeadb6c956 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\Model","apiPackage":"Example\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From 21d076312c673a5df5bb2e1f6cd7cbafee1597df Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:27:33 +0530 Subject: [PATCH 073/150] namespace --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index abeadb6c956..1d64a3af4d8 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\Model","apiPackage":"Example\Api"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\\\\Model","apiPackage":"Example\\\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From 57233ad676dd2caa26af728db48d87c48db7896c Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:34:20 +0530 Subject: [PATCH 074/150] namespace php add --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 1d64a3af4d8..6a13497045c 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"Example","modelPackage":"Example\\\\Model","apiPackage":"Example\\\\Api"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From 3f280728637ba0a6bea6f51b0b7b8fe66d269edc Mon Sep 17 00:00:00 2001 From: Ankit Date: Sun, 1 Sep 2019 22:40:52 +0530 Subject: [PATCH 075/150] namespace php add --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 6a13497045c..779fa2e16c7 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -12,7 +12,7 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3"}'>config_php.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From 103dad29dbb167c40737bcf64631e7e5f858258e Mon Sep 17 00:00:00 2001 From: krishna sankar Date: Fri, 22 Nov 2019 15:30:11 +0530 Subject: [PATCH 076/150] intouch v3 test --- swagger_sdk_gen_v3_test.sh | 66 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 swagger_sdk_gen_v3_test.sh diff --git a/swagger_sdk_gen_v3_test.sh b/swagger_sdk_gen_v3_test.sh new file mode 100644 index 00000000000..d124cc1e79e --- /dev/null +++ b/swagger_sdk_gen_v3_test.sh @@ -0,0 +1,66 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi +if [ "$Branch" = "snapshot" ] + then + url="http://newapi-nightly.capillary.in/tl-docs-test/v2/api-docs" + version="https://nightly.capillary.in/v3test/meta/version" +elif [ "$Branch" = "production" ] + then + url="http://newapi-nightly.capillary.in/tl-docs-test/v2/api-docs" + version="https://nightly.capillary.in/v3test/meta/version" +else " No Branch is selected" +fi +curl -k $version -o config.json +echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json +echo "GENERATING SDK" +if [ "$Client" = "java" ] +then + rm -rf intouch_api/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l java \ + -DdateLibrary=java8 \ + -o intouch_api/java_client/java \ + -c config.json + tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + mvn3 clean deploy -f intouch_api/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-v3-sdk-test" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-v3-sdk-test" + +elif [ "$Client" = "c#" ] +then rm -rf intouch_api/csharp_client/c# + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l csharp\ + -DtargetFramework=v$Version \ + -o intouch_api/csharp_client/c# + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-v3-sdk-test" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-v3-sdk-test" +elif [ "$Client" = "php" ] +then rm -rf intouch_api/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l php \ + -o intouch_api/php_client/php \ + -c config_php.json + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-v3-sdk-test" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-v3-sdk-test" +elif [ "$Client" = "nodejs" ] +then rm -rf intouch_api/nodejs_client + mkdir -p intouch_api/nodejs_client/ + curl $url > swagger.json + npm install swagger-js-codegen + cd swagger-js-codegen + node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-v3-sdk-test" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-v3-sdk-test" +elif [ "$Client" = "python" ] +then rm -rf intouch_api/python_client + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l python \ + -o intouch_api/python_client/python + tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-v3-sdk-test" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-v3-sdk-test" +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From fbac41344c71b7f23fc80bba84c9a1e90a759e05 Mon Sep 17 00:00:00 2001 From: mohitsarewar1481 Date: Mon, 27 Jan 2020 18:10:02 +0530 Subject: [PATCH 077/150] add swagger gen file for fileservice --- swagger_sdk_gen_fileService.sh | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100755 swagger_sdk_gen_fileService.sh diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh new file mode 100755 index 00000000000..75a01ddf94d --- /dev/null +++ b/swagger_sdk_gen_fileService.sh @@ -0,0 +1,30 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi +if [ "$Branch" = "master" ] + then + url="http://fileservice.capillary.in/tl-docs-test/v2/api-docs" + version="https://fileservice.capillary.in/v1/meta/version" +elif [ "$Branch" = "production" ] + then + url="http://fileservice.capillary.in/tl-docs-test/v2/api-docs" + version="https://fileservice.capillary.in/v1/meta/version" +else " No Branch is selected" +fi +curl -k $version -o config.json +echo "GENERATING SDK" +if [ "$Client" = "java" ] +then + rm -rf fileservice/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l java \ + -DdateLibrary=java8 \ + -o fileservice/java_client/java \ + -c config.json + tar cvzf fileservice/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + mvn3 clean deploy -f fileservice/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "swagger_sdk_gen_fileService" -v $BUILD_NUMBER -C ./fileservice/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_fileService" +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 2fdb26c5bef6fd239340d94de30e260242d639a0 Mon Sep 17 00:00:00 2001 From: mohitsarewar1481 Date: Tue, 4 Feb 2020 11:29:41 +0530 Subject: [PATCH 078/150] change to fic content type --- .../java/io/swagger/codegen/languages/AbstractJavaCodegen.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java index 0d42666b4b3..cd00722657b 100644 --- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java +++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java @@ -937,7 +937,8 @@ public String escapeQuotationMark(String input) { @Override public String escapeUnsafeCharacters(String input) { - return input.replace("*/", "*_/").replace("/*", "/_*"); + return input; + //return input.replace("*/", "*_/").replace("/*", "/_*"); } /* From 8c741886d2873bd8a06c67e8ad303ad80a68f0ff Mon Sep 17 00:00:00 2001 From: manishkrprasad Date: Thu, 11 Jun 2020 18:18:49 +0530 Subject: [PATCH 079/150] cc nightly url --- swagger_sdk_gen.sh | 4 ++-- swagger_sdk_gen_v3.sh | 8 ++++---- swagger_sdk_gen_v3_test.sh | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index d3b6618f6e5..04aa3ebed7b 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -3,8 +3,8 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://newapi-nightly.capillary.in/swagger.json" - version="http://newapi-nightly.capillary.in/version.json" + url="http://crm-nightly-new.cc.capillarytech.com/swagger.json" + version="http://crm-nightly-new.cc.capillarytech.com/version.json" elif [ "$Branch" = "production" ] then url="http://newapi.staging.capillary.in/swagger.json" diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 779fa2e16c7..657842b0687 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -3,12 +3,12 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" - version="https://nightly.capillary.in/v3/meta/version" + url="http://crm-nightly-new.cc.capillarytech.com/tl-docs/v2/api-docs" + version="https://crm-nightly-new.cc.capillarytech.com/v3/meta/version" elif [ "$Branch" = "production" ] then - url="http://newapi-nightly.capillary.in/tl-docs/v2/api-docs" - version="https://nightly.capillary.in/v3/meta/version" + url="http://crm-nightly-new.cc.capillarytech.com/tl-docs/v2/api-docs" + version="https://crm-nightly-new.cc.capillarytech.com/v3/meta/version" else " No Branch is selected" fi curl -k $version -o config.json diff --git a/swagger_sdk_gen_v3_test.sh b/swagger_sdk_gen_v3_test.sh index d124cc1e79e..30b837f236e 100644 --- a/swagger_sdk_gen_v3_test.sh +++ b/swagger_sdk_gen_v3_test.sh @@ -3,12 +3,12 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://newapi-nightly.capillary.in/tl-docs-test/v2/api-docs" - version="https://nightly.capillary.in/v3test/meta/version" + url="http://crm-nightly-new.cc.capillarytech.com/tl-docs-test/v2/api-docs" + version="https://crm-nightly-new.cc.capillarytech.com/v3test/meta/version" elif [ "$Branch" = "production" ] then - url="http://newapi-nightly.capillary.in/tl-docs-test/v2/api-docs" - version="https://nightly.capillary.in/v3test/meta/version" + url="http://crm-nightly-new.cc.capillarytech.com/tl-docs-test/v2/api-docs" + version="https://crm-nightly-new.cc.capillarytech.com/v3test/meta/version" else " No Branch is selected" fi curl -k $version -o config.json From 6eec75e6596e9538955ec52cfc1cbb6315acf054 Mon Sep 17 00:00:00 2001 From: manishkrprasad Date: Fri, 12 Jun 2020 13:33:21 +0530 Subject: [PATCH 080/150] url correction --- swagger_sdk_gen.sh | 4 ++-- swagger_sdk_gen_v3.sh | 8 ++++---- swagger_sdk_gen_v3_test.sh | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 04aa3ebed7b..916658ce62b 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -3,8 +3,8 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://crm-nightly-new.cc.capillarytech.com/swagger.json" - version="http://crm-nightly-new.cc.capillarytech.com/version.json" + url="https://intouch-api-swagger.crm-nightly-new.cc.capillarytech.com/swagger.json" + version="https://api.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then url="http://newapi.staging.capillary.in/swagger.json" diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 657842b0687..ff88fd2565b 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -3,12 +3,12 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://crm-nightly-new.cc.capillarytech.com/tl-docs/v2/api-docs" - version="https://crm-nightly-new.cc.capillarytech.com/v3/meta/version" + url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" + version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" elif [ "$Branch" = "production" ] then - url="http://crm-nightly-new.cc.capillarytech.com/tl-docs/v2/api-docs" - version="https://crm-nightly-new.cc.capillarytech.com/v3/meta/version" + url="http://newapi.staging.capillary.in/tl-docs/v2/api-docs" + version="http://newapi.staging.capillary.in/v3/meta/version" else " No Branch is selected" fi curl -k $version -o config.json diff --git a/swagger_sdk_gen_v3_test.sh b/swagger_sdk_gen_v3_test.sh index 30b837f236e..81fffd2a068 100644 --- a/swagger_sdk_gen_v3_test.sh +++ b/swagger_sdk_gen_v3_test.sh @@ -3,12 +3,12 @@ if $Build_Codegen ; then fi if [ "$Branch" = "snapshot" ] then - url="http://crm-nightly-new.cc.capillarytech.com/tl-docs-test/v2/api-docs" - version="https://crm-nightly-new.cc.capillarytech.com/v3test/meta/version" + url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/tl-docs-test/v2/api-docs" + version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3test/meta/version" elif [ "$Branch" = "production" ] then - url="http://crm-nightly-new.cc.capillarytech.com/tl-docs-test/v2/api-docs" - version="https://crm-nightly-new.cc.capillarytech.com/v3test/meta/version" + url="http://newapi.staging.capillary.in/tl-docs-test/v2/api-docs" + version="http://newapi.staging.capillary.in/v3test/meta/version" else " No Branch is selected" fi curl -k $version -o config.json From 24e4e0aa03cc5f66eae483a6de17ef0608890081 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Thu, 13 Aug 2020 16:23:36 +0530 Subject: [PATCH 081/150] file service script url updated --- swagger_sdk_gen_fileService.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index 75a01ddf94d..9f0494d02d9 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -3,15 +3,15 @@ if $Build_Codegen ; then fi if [ "$Branch" = "master" ] then - url="http://fileservice.capillary.in/tl-docs-test/v2/api-docs" - version="https://fileservice.capillary.in/v1/meta/version" + url="https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v2/api-docs" + version="https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v1/meta/version" elif [ "$Branch" = "production" ] then url="http://fileservice.capillary.in/tl-docs-test/v2/api-docs" version="https://fileservice.capillary.in/v1/meta/version" else " No Branch is selected" fi -curl -k $version -o config.json +curl -k $version -o config.json -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" echo "GENERATING SDK" if [ "$Client" = "java" ] then @@ -22,7 +22,7 @@ then -DdateLibrary=java8 \ -o fileservice/java_client/java \ -c config.json - tar cvzf fileservice/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + tar cvzf fileservice/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./filservice/java_client/java/ . mvn3 clean deploy -f fileservice/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "swagger_sdk_gen_fileService" -v $BUILD_NUMBER -C ./fileservice/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_fileService" else " no client is selected" From a32320e700a45d9c74fa2828016272fc46020129 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Thu, 13 Aug 2020 17:08:23 +0530 Subject: [PATCH 082/150] adding auth for fileservice --- swagger_sdk_gen_fileService.sh | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index 9f0494d02d9..9233abe72ea 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -11,12 +11,14 @@ elif [ "$Branch" = "production" ] version="https://fileservice.capillary.in/v1/meta/version" else " No Branch is selected" fi -curl -k $version -o config.json -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" +ver=$(curl -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -k $version) +echo {"artifactVersion":$ver} > config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf fileservice/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -a "Authorization%3ABasic%20a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA%3D" -i $url \ -l java \ -DdateLibrary=java8 \ From 8efbef0ac30dcc2e2b8d4574ed93052d55f13c55 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Thu, 13 Aug 2020 17:26:52 +0530 Subject: [PATCH 083/150] adding auth for fileservice --- swagger_sdk_gen_fileService.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index 9233abe72ea..31894fa3b27 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -18,7 +18,7 @@ if [ "$Client" = "java" ] then rm -rf fileservice/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -a "Authorization%3ABasic%20a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA%3D" + -a "Authorization%3ABasic%20a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA%3D" \ -i $url \ -l java \ -DdateLibrary=java8 \ From c0291bfd54f4f1f2edca07c0f21e11494835b07b Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Thu, 13 Aug 2020 17:52:11 +0530 Subject: [PATCH 084/150] file sevice correction --- swagger_sdk_gen_fileService.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index 31894fa3b27..9f226a8785e 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -12,14 +12,14 @@ elif [ "$Branch" = "production" ] else " No Branch is selected" fi ver=$(curl -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -k $version) -echo {"artifactVersion":$ver} > config.json +echo {'"artifactVersion"':\"$ver\"} > config.json echo "GENERATING SDK" +curl -H"Authorization:Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -o spec.json "https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v2/api-docs" if [ "$Client" = "java" ] -then +then rm -rf fileservice/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -a "Authorization%3ABasic%20a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA%3D" \ - -i $url \ + -i spec.json \ -l java \ -DdateLibrary=java8 \ -o fileservice/java_client/java \ From f6e991f4b7d0a58a1964c6e85ea60cd583e014b3 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Thu, 13 Aug 2020 18:03:36 +0530 Subject: [PATCH 085/150] fileservice artifact issue --- swagger_sdk_gen_fileService.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index 9f226a8785e..d898d1075ea 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -23,7 +23,7 @@ then -l java \ -DdateLibrary=java8 \ -o fileservice/java_client/java \ - -c config.json + -c config.json --group-id com.capillary.platforms --model-package com.capillary.platforms.fileservice.models --api-package com.capillary.platforms.fileservice.api --artifact-id fileservice-client tar cvzf fileservice/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./filservice/java_client/java/ . mvn3 clean deploy -f fileservice/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "swagger_sdk_gen_fileService" -v $BUILD_NUMBER -C ./fileservice/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_fileService" From ca58c10bb0d3f3b6f2b19cfdd5f2964195803054 Mon Sep 17 00:00:00 2001 From: Krishna ManiSankar J Date: Wed, 2 Sep 2020 13:11:38 +0530 Subject: [PATCH 086/150] updating staging url for v3 swagger --- swagger_sdk_gen_v3.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index ff88fd2565b..887a9b8c484 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -7,12 +7,12 @@ if [ "$Branch" = "snapshot" ] version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" elif [ "$Branch" = "production" ] then - url="http://newapi.staging.capillary.in/tl-docs/v2/api-docs" - version="http://newapi.staging.capillary.in/v3/meta/version" + url="http://api.staging.capillary.in/tl-docs/v2/api-docs" + version="http://api.staging.capillary.in/v3/meta/version" else " No Branch is selected" fi curl -k $version -o config.json -echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json +#echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] then From d7ee5e37c01b9f9199d4daa7d6174f397bca143c Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Fri, 4 Sep 2020 14:24:53 +0530 Subject: [PATCH 087/150] added camel case option in php sdk --- swagger_sdk_gen.sh | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 916658ce62b..baa5af8cf82 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -36,7 +36,10 @@ then rm -rf intouch_api/csharp_client/c# fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php - java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + if [ "$CamelCase" = "Yes" ] + then + sed -i -e 's/}/,"variableNamingConvention":"camelCase"}/g' config.json + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l php \ -o intouch_api/php_client/php From b7ea807dbffdfe745a87f9228c20b6663c22cc80 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Fri, 4 Sep 2020 14:45:17 +0530 Subject: [PATCH 088/150] fixes --- swagger_sdk_gen.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index baa5af8cf82..b1d55d14e3c 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -39,6 +39,7 @@ then rm -rf intouch_api/php_client/php if [ "$CamelCase" = "Yes" ] then sed -i -e 's/}/,"variableNamingConvention":"camelCase"}/g' config.json + fi java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l php \ From 43490694c0fc51cbe455744999be62c9f0aefadc Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Fri, 4 Sep 2020 15:06:54 +0530 Subject: [PATCH 089/150] php sdk fixes --- swagger_sdk_gen.sh | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index b1d55d14e3c..66459026ebd 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -38,11 +38,13 @@ elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php if [ "$CamelCase" = "Yes" ] then - sed -i -e 's/}/,"variableNamingConvention":"camelCase"}/g' config.json + echo "setting camelcase variable name convention for php sdk" + echo '{"variableNamingConvention":"camelCase"}' > config.json fi java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l php \ + -c config.json \ -o intouch_api/php_client/php tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . fpm -f -s "dir" -t "deb" -a "all" -n "swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-sdk" From bee1bdaad0763d5a0ca3f3bf281238683d8bedef Mon Sep 17 00:00:00 2001 From: Krishna ManiSankar J Date: Fri, 9 Oct 2020 12:05:58 +0530 Subject: [PATCH 090/150] updating links for fileservice --- swagger_sdk_gen_fileService.sh | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen_fileService.sh b/swagger_sdk_gen_fileService.sh index d898d1075ea..81e95b9f65b 100755 --- a/swagger_sdk_gen_fileService.sh +++ b/swagger_sdk_gen_fileService.sh @@ -5,16 +5,18 @@ if [ "$Branch" = "master" ] then url="https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v2/api-docs" version="https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v1/meta/version" + ver=$(curl -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -k $version) + curl -H"Authorization:Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -o spec.json $url elif [ "$Branch" = "production" ] then - url="http://fileservice.capillary.in/tl-docs-test/v2/api-docs" - version="https://fileservice.capillary.in/v1/meta/version" + url="https://crm-staging-new.cc.capillarytech.com/api_gateway/file-service/v2/api-docs" + version="https://crm-staging-new.cc.capillarytech.com/api_gateway/file-service/v1/meta/version" + ver=$(curl -H"Authorization: Basic Zmlyc3RfdXNlckBjYXBpbGxhcnl0ZWNoLmNvbTo3ZmUzMmM5YjE1N2I0MDE0Y2QzOTg3MjhhYTJiM2UwYg==" -k $version) + curl -H"Authorization:Basic Zmlyc3RfdXNlckBjYXBpbGxhcnl0ZWNoLmNvbTo3ZmUzMmM5YjE1N2I0MDE0Y2QzOTg3MjhhYTJiM2UwYg==" -o spec.json $url else " No Branch is selected" fi -ver=$(curl -H"Authorization: Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -k $version) echo {'"artifactVersion"':\"$ver\"} > config.json echo "GENERATING SDK" -curl -H"Authorization:Basic a3Jpc2huYS50aWxsMDE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" -o spec.json "https://crm-nightly-new.cc.capillarytech.com/api_gateway/file-service/v2/api-docs" if [ "$Client" = "java" ] then rm -rf fileservice/java_client/java From f2005abb5d8a4326174ae6b458a30290306baf70 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Mon, 9 Nov 2020 11:03:33 +0530 Subject: [PATCH 091/150] url fix for intouch api sdk --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 66459026ebd..72ce43c31d5 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -4,7 +4,7 @@ fi if [ "$Branch" = "snapshot" ] then url="https://intouch-api-swagger.crm-nightly-new.cc.capillarytech.com/swagger.json" - version="https://api.crm-nightly-new.cc.capillarytech.com/version" + version="https://newapi.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then url="http://newapi.staging.capillary.in/swagger.json" From 3dc12e9519a6db78d2daeafe8decb76a6555c3ca Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 17 Feb 2021 18:20:35 +0530 Subject: [PATCH 092/150] coupon_gateway sdk gen --- swagger_sdk_gen_coupon_gateway.sh | 66 +++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 swagger_sdk_gen_coupon_gateway.sh diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh new file mode 100644 index 00000000000..b7b0a547421 --- /dev/null +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -0,0 +1,66 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi +if [ "$Branch" = "snapshot" ] + then + url="https://coupon-gateway-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" + version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" +elif [ "$Branch" = "production" ] + then + url="http://api.staging.capillary.in/tl-docs/v2/api-docs" + version="http://api.staging.capillary.in/v3/meta/version" +else " No Branch is selected" +fi +curl -k $version -o config.json +#echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json +echo "GENERATING SDK" +if [ "$Client" = "java" ] +then + rm -rf intouch_api/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l java \ + -DdateLibrary=java8 \ + -o intouch_api/java_client/java \ + -c config.json + tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . + mvn3 clean deploy -f intouch_api/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-coupon-gateway-sdk" + +elif [ "$Client" = "c#" ] +then rm -rf intouch_api/csharp_client/c# + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l csharp\ + -DtargetFramework=v$Version \ + -o intouch_api/csharp_client/c# + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-coupon-gateway-sdk" +elif [ "$Client" = "php" ] +then rm -rf intouch_api/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l php \ + -o intouch_api/php_client/php \ + -c config_php.json + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-coupon-gateway-sdk" +elif [ "$Client" = "nodejs" ] +then rm -rf intouch_api/nodejs_client + mkdir -p intouch_api/nodejs_client/ + curl $url > swagger.json + npm install swagger-js-codegen + cd swagger-js-codegen + node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-coupon-gateway-sdk" +elif [ "$Client" = "python" ] +then rm -rf intouch_api/python_client + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l python \ + -o intouch_api/python_client/python + tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-coupon-gateway-sdk" +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From c93bc96d8875f015c701b12e00099d586c457e84 Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 17 Feb 2021 18:53:48 +0530 Subject: [PATCH 093/150] coupon gateway sdk gen --- swagger_sdk_gen_coupon_gateway.sh | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index b7b0a547421..0c8755ce86a 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -15,17 +15,18 @@ curl -k $version -o config.json #echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json echo "GENERATING SDK" if [ "$Client" = "java" ] -then - rm -rf intouch_api/java_client/java +then + rm -rf coupon_gateway/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i $url \ + -i spec.json \ -l java \ -DdateLibrary=java8 \ - -o intouch_api/java_client/java \ - -c config.json - tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . - mvn3 clean deploy -f intouch_api/java_client/java/pom.xml - fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./intouch_api/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-coupon-gateway-sdk" + -o coupon_gateway/java_client/java \ + -c config.json --group-id com.capillary --model-package com.capillary.coupon.gateway.models --api-package com.capillary.coupon.gateway.api --artifact-id coupon-gateway + tar cvzf coupon_gateway/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./coupon_gateway/java_client/java/ . + mvn3 clean deploy -f coupon_gateway/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./coupon_gateway/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_coupon_gateway" +else " no client is selected" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# From f672ff56a655a2c3053156cc775e2c70e9ed9610 Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 17 Feb 2021 18:54:43 +0530 Subject: [PATCH 094/150] coupon gateway sdk gen --- swagger_sdk_gen_coupon_gateway.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index 0c8755ce86a..62f7622cf4c 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -26,7 +26,6 @@ then tar cvzf coupon_gateway/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./coupon_gateway/java_client/java/ . mvn3 clean deploy -f coupon_gateway/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./coupon_gateway/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_coupon_gateway" -else " no client is selected" elif [ "$Client" = "c#" ] then rm -rf intouch_api/csharp_client/c# From 0a8b3527054de4babbd9ca54f70528f6a8c8a1fc Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 17 Feb 2021 19:05:40 +0530 Subject: [PATCH 095/150] changes --- swagger_sdk_gen_coupon_gateway.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index 62f7622cf4c..f2524d10896 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -17,6 +17,7 @@ echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf coupon_gateway/java_client/java + mkdir -p coupon_gateway/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i spec.json \ -l java \ From d79871cd841b53dab180f89747edac8d3130e823 Mon Sep 17 00:00:00 2001 From: Ankit Date: Wed, 17 Feb 2021 19:13:50 +0530 Subject: [PATCH 096/150] changes --- swagger_sdk_gen_coupon_gateway.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index f2524d10896..b774a62f4c9 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -19,7 +19,7 @@ then rm -rf coupon_gateway/java_client/java mkdir -p coupon_gateway/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i spec.json \ + -i $url \ -l java \ -DdateLibrary=java8 \ -o coupon_gateway/java_client/java \ From e6be278da852213871a5d960cbd7c634eaee1d36 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Wed, 17 Feb 2021 19:27:36 +0530 Subject: [PATCH 097/150] Update swagger_sdk_gen_coupon_gateway.sh --- swagger_sdk_gen_coupon_gateway.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index b774a62f4c9..2e318456454 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -23,7 +23,7 @@ then -l java \ -DdateLibrary=java8 \ -o coupon_gateway/java_client/java \ - -c config.json --group-id com.capillary --model-package com.capillary.coupon.gateway.models --api-package com.capillary.coupon.gateway.api --artifact-id coupon-gateway + -c config.json --group-id com.capillary.commons --model-package com.capillary.coupon.gateway.models --api-package com.capillary.coupon.gateway.api --artifact-id coupon-gateway tar cvzf coupon_gateway/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./coupon_gateway/java_client/java/ . mvn3 clean deploy -f coupon_gateway/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./coupon_gateway/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_coupon_gateway" From 69e5a9dac1374f63bc9cfba5438b61ec95d27691 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Fri, 19 Feb 2021 11:34:17 +0530 Subject: [PATCH 098/150] Update swagger_sdk_gen_coupon_gateway.sh --- swagger_sdk_gen_coupon_gateway.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index 2e318456454..9fef6ac2360 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -23,7 +23,7 @@ then -l java \ -DdateLibrary=java8 \ -o coupon_gateway/java_client/java \ - -c config.json --group-id com.capillary.commons --model-package com.capillary.coupon.gateway.models --api-package com.capillary.coupon.gateway.api --artifact-id coupon-gateway + -c config.json --group-id com.capillary.coupongateway --model-package com.capillary.coupon.gateway.models --api-package com.capillary.coupon.gateway.api --artifact-id coupon-gateway-swagger-sdk tar cvzf coupon_gateway/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./coupon_gateway/java_client/java/ . mvn3 clean deploy -f coupon_gateway/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-coupon-gateway-sdk" -v $BUILD_NUMBER -C ./coupon_gateway/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_coupon_gateway" From 69d50a8fb5ca95b6150616a92283b1521d9fc6c3 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Fri, 19 Feb 2021 12:05:24 +0530 Subject: [PATCH 099/150] Update swagger_sdk_gen_coupon_gateway.sh --- swagger_sdk_gen_coupon_gateway.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index 9fef6ac2360..aaf4fb727da 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -4,7 +4,7 @@ fi if [ "$Branch" = "snapshot" ] then url="https://coupon-gateway-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" - version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" + version="https://coupon-gateway-api.crm-nightly-new.cc.capillarytech.com/v1/coupongateway/version" elif [ "$Branch" = "production" ] then url="http://api.staging.capillary.in/tl-docs/v2/api-docs" From b6c6fb029bf9c8995f465d90c58b51b007505bcb Mon Sep 17 00:00:00 2001 From: Prasenjit Saha Date: Tue, 2 Mar 2021 13:02:58 +0530 Subject: [PATCH 100/150] coupon-gateway change --- coupon-gateway.json | 1 + swagger_sdk_gen_coupon_gateway.sh | 16 +++------------- 2 files changed, 4 insertions(+), 13 deletions(-) create mode 100644 coupon-gateway.json diff --git a/coupon-gateway.json b/coupon-gateway.json new file mode 100644 index 00000000000..2c4189546f5 --- /dev/null +++ b/coupon-gateway.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"localhost:8080","basePath":"/","tags":[{"name":"org-gateway-mapping-resource","description":"Org Gateway Mapping Resource"},{"name":"coupon-gateway-resource","description":"Coupon Gateway Resource"},{"name":"gateway-resource","description":"Gateway Resource"},{"name":"coupon-resource","description":"Coupon Resource"}],"paths":{"/v1/coupon/issue":{"post":{"tags":["coupon-resource"],"summary":"issueCoupon","operationId":"issueCouponUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"issueCouponRequest","description":"issueCouponRequest","required":true,"schema":{"$ref":"#/definitions/IssueCouponRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«IssueCouponResponse»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/coupongateway/isAlive":{"get":{"tags":["coupon-gateway-resource"],"summary":"isAlive","operationId":"isAliveUsingGET","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/coupongateway/version":{"get":{"tags":["coupon-gateway-resource"],"summary":"getVersion","operationId":"getVersionUsingGET","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VersionData"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gatewaymappings":{"get":{"tags":["org-gateway-mapping-resource"],"summary":"getAllGatewayMappingsByOrgId","operationId":"getAllGatewayMappingsByOrgIdUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"orgId","in":"query","description":"orgId","required":true,"type":"integer","format":"int64"},{"name":"includeInactive","in":"query","description":"includeInactive","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«OrgCouponGatewayMapping»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["org-gateway-mapping-resource"],"summary":"createGatewayMappings","operationId":"createGatewayMappingsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"orgCouponGatewayMapping","description":"orgCouponGatewayMapping","required":true,"schema":{"$ref":"#/definitions/OrgCouponGatewayMapping"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«OrgCouponGatewayMapping»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gatewaymappings/{gatewayMappingId}/activate":{"put":{"tags":["org-gateway-mapping-resource"],"summary":"activateGatewayMapping","operationId":"activateGatewayMappingUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayMappingId","in":"path","description":"gatewayMappingId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gatewaymappings/{gatewayMappingId}/deactivate":{"put":{"tags":["org-gateway-mapping-resource"],"summary":"deActivateGatewayMapping","operationId":"deActivateGatewayMappingUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayMappingId","in":"path","description":"gatewayMappingId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gatewaymappings/{id}":{"get":{"tags":["org-gateway-mapping-resource"],"summary":"getByGatewayMappingId","operationId":"getByGatewayMappingIdUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«OrgCouponGatewayMapping»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["org-gateway-mapping-resource"],"summary":"updateGatewayMappings","operationId":"updateGatewayMappingsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"},{"in":"body","name":"orgCouponGatewayMapping","description":"orgCouponGatewayMapping","required":true,"schema":{"$ref":"#/definitions/OrgCouponGatewayMapping"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«OrgCouponGatewayMapping»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gateways":{"post":{"tags":["gateway-resource"],"summary":"create","operationId":"createUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"couponGateway","description":"couponGateway","required":true,"schema":{"$ref":"#/definitions/CouponGateway"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CouponGateway»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gateways/":{"get":{"tags":["gateway-resource"],"summary":"getAllGateways","operationId":"getAllGatewaysUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"includeInactive","in":"query","description":"includeInactive","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CouponGateway»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gateways/{gatewayId}":{"get":{"tags":["gateway-resource"],"summary":"getById","operationId":"getByIdUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayId","in":"path","description":"gatewayId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CouponGateway»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["gateway-resource"],"summary":"update","operationId":"updateUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayId","in":"path","description":"gatewayId","required":true,"type":"string"},{"in":"body","name":"couponGateway","description":"couponGateway","required":true,"schema":{"$ref":"#/definitions/CouponGateway"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CouponGateway»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gateways/{gatewayId}/activate":{"put":{"tags":["gateway-resource"],"summary":"activateGateway","operationId":"activateGatewayUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayId","in":"path","description":"gatewayId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/gateways/{gatewayId}/deactivate":{"put":{"tags":["gateway-resource"],"summary":"deActivateGateway","operationId":"deActivateGatewayUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"gatewayId","in":"path","description":"gatewayId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"ApiError":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"getIsRetryable":{"type":"boolean"},"message":{"type":"string"}}},"CouponGateway":{"type":"object","properties":{"active":{"type":"boolean"},"baseUrl":{"type":"string"},"batchSize":{"type":"integer","format":"int32"},"concurrency":{"type":"integer","format":"int32"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"gatewayProperties":{"type":"array","items":{"$ref":"#/definitions/Property"}},"id":{"type":"string"},"name":{"type":"string"},"requiredFields":{"type":"array","items":{"type":"string"}},"timeoutInMillis":{"type":"integer","format":"int32"},"updatedBy":{"type":"integer","format":"int64"},"updatedOn":{"type":"string","format":"date-time"}}},"CouponSeries":{"type":"object","properties":{"customProperties":{"type":"object","additionalProperties":{"type":"string"}},"discountType":{"type":"string","enum":["PERC","ABS"]},"discountValue":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"seriesExpiryDate":{"type":"integer","format":"int64"}}},"IssueCouponRequest":{"type":"object","properties":{"couponSeries":{"$ref":"#/definitions/CouponSeries"},"issuedBy":{"$ref":"#/definitions/OrgEntity"},"orgCouponGatewayId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"requestId":{"type":"string"},"userInfo":{"$ref":"#/definitions/UserInfo"}}},"IssueCouponResponse":{"type":"object","properties":{"issuedCouponDetails":{"$ref":"#/definitions/IssuedCouponDetails"},"serverRequestId":{"type":"string"}}},"IssuedCouponDetails":{"type":"object","properties":{"additionalInfo":{"type":"string"},"couponCode":{"type":"string"},"error":{"$ref":"#/definitions/ApiError"},"issuedTime":{"type":"integer","format":"int64"},"userInfo":{"$ref":"#/definitions/UserInfo"}}},"OrgCouponGatewayMapping":{"type":"object","properties":{"active":{"type":"boolean"},"couponGateway":{"$ref":"#/definitions/CouponGateway"},"couponGatewayId":{"type":"string"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"string"},"orgCouponGatewayProperties":{"type":"array","items":{"$ref":"#/definitions/Property"}},"orgId":{"type":"integer","format":"int64"},"updatedBy":{"type":"integer","format":"int64"},"updatedOn":{"type":"string","format":"date-time"}}},"OrgEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"Property":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"ResponseWrapper«CouponGateway»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CouponGateway"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"ResponseWrapper«IssueCouponResponse»":{"type":"object","properties":{"data":{"$ref":"#/definitions/IssueCouponResponse"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"ResponseWrapper«List«CouponGateway»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CouponGateway"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"ResponseWrapper«List«OrgCouponGatewayMapping»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/OrgCouponGatewayMapping"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"ResponseWrapper«OrgCouponGatewayMapping»":{"type":"object","properties":{"data":{"$ref":"#/definitions/OrgCouponGatewayMapping"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"ResponseWrapper«boolean»":{"type":"object","properties":{"data":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}}},"Transaction":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"transactionNumber":{"type":"string"},"transactionTime":{"type":"integer","format":"int64"}}},"UserInfo":{"type":"object","properties":{"email":{"type":"string"},"externalId":{"type":"string"},"mobile":{"type":"string"},"transaction":{"$ref":"#/definitions/Transaction"},"userId":{"type":"integer","format":"int64"}}},"VersionData":{"type":"object","properties":{"artifactVersion":{"type":"string"}}}}} diff --git a/swagger_sdk_gen_coupon_gateway.sh b/swagger_sdk_gen_coupon_gateway.sh index aaf4fb727da..5ee04088c44 100644 --- a/swagger_sdk_gen_coupon_gateway.sh +++ b/swagger_sdk_gen_coupon_gateway.sh @@ -1,25 +1,15 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Branch" = "snapshot" ] - then - url="https://coupon-gateway-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" - version="https://coupon-gateway-api.crm-nightly-new.cc.capillarytech.com/v1/coupongateway/version" -elif [ "$Branch" = "production" ] - then - url="http://api.staging.capillary.in/tl-docs/v2/api-docs" - version="http://api.staging.capillary.in/v3/meta/version" -else " No Branch is selected" -fi -curl -k $version -o config.json -#echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json + +echo "{\"artifactVersion\":\"${Version}\"}">config.json echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf coupon_gateway/java_client/java mkdir -p coupon_gateway/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i $url \ + -i coupon-gateway.json \ -l java \ -DdateLibrary=java8 \ -o coupon_gateway/java_client/java \ From 2dac5f20c7b0e75be402a5a369c5957f6a08efce Mon Sep 17 00:00:00 2001 From: Prasenjit Saha Date: Fri, 23 Apr 2021 18:41:55 +0530 Subject: [PATCH 101/150] swagger-sdk generated for promotion-engine --- promotion-engine.json | 1 + swagger_sdk_gen_promotion_engine.sh | 57 +++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 promotion-engine.json create mode 100644 swagger_sdk_gen_promotion_engine.sh diff --git a/promotion-engine.json b/promotion-engine.json new file mode 100644 index 00000000000..4356631264a --- /dev/null +++ b/promotion-engine.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"promotion-engine-api.crm-nightly-new.cc.capillarytech.com","basePath":"/","tags":[{"name":"audit-log-resource","description":"Audit Log Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"promotion-earning-management-resource","description":"Promotion Earning Management Resource"},{"name":"promotion-earning-resource","description":"Promotion Earning Resource"},{"name":"promotion-meta-resource","description":"Promotion Meta Resource"},{"name":"promotion-redemption-resource","description":"Promotion Redemption Resource"},{"name":"promotion-resource","description":"Promotion Resource"},{"name":"promotion-settings-resource","description":"Promotion Settings Resource"}],"paths":{"/health/isalive":{"get":{"tags":["health-check-resource"],"summary":"isAlive","operationId":"isAliveUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions":{"get":{"tags":["promotion-meta-resource"],"summary":"getAllPromotionConfigs","operationId":"getAllPromotionConfigsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionMetaRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-meta-resource"],"summary":"createPromotionConfig","operationId":"createPromotionConfigUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotion","description":"promotion","required":true,"schema":{"$ref":"#/definitions/PromotionMetaROReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/auditLogs/versions":{"get":{"tags":["audit-log-resource"],"summary":"getAuditLogVersions","operationId":"getAuditLogVersionsUsingGET","produces":["application/json"],"parameters":[{"name":"endDate","in":"query","required":false,"type":"integer","format":"int64"},{"name":"entityId","in":"query","required":true,"type":"string"},{"name":"entityType","in":"query","required":true,"type":"string","enum":["PROMOTION_META","PROMOTION_SETTING"]},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startDate","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«AuditLogVersionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}":{"get":{"tags":["audit-log-resource"],"summary":"getAuditLogEntity","operationId":"getAuditLogEntityUsingGET","produces":["application/json"],"parameters":[{"name":"entityId","in":"path","description":"entityId","required":true,"type":"string"},{"name":"entityType","in":"path","description":"entityType","required":true,"type":"string","enum":["PROMOTION_META","PROMOTION_SETTING"]},{"name":"version","in":"path","description":"version","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«object»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/filters":{"get":{"tags":["promotion-meta-resource"],"summary":"getFilteredPromotions","operationId":"getFilteredPromotionsUsingGET","produces":["application/json"],"parameters":[{"name":"active","in":"query","required":false,"type":"boolean"},{"name":"campaignId","in":"query","required":false,"type":"string"},{"name":"endDate","in":"query","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"promotionType","in":"query","required":false,"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["ID","NAME","START_DATE"]},{"name":"startDate","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionSummaryRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/settings/custom_field":{"get":{"tags":["promotion-settings-resource"],"summary":"getPromotionCustomFields","operationId":"getPromotionCustomFieldsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-settings-resource"],"summary":"savePromotionCustomFields","operationId":"savePromotionCustomFieldsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"customMetadataFields","description":"customMetadataFields","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/CustomMetadataFieldRO"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/settings/strategy":{"get":{"tags":["promotion-settings-resource"],"summary":"getPromotionStrategy","operationId":"getPromotionStrategyUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionStrategyRO»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-settings-resource"],"summary":"savePromotionStrategy","operationId":"savePromotionStrategyUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotionStrategy","description":"promotionStrategy","required":true,"schema":{"$ref":"#/definitions/PromotionStrategyRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionStrategyRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}":{"get":{"tags":["promotion-meta-resource"],"summary":"getPromotionConfig","operationId":"getPromotionConfigUsingGET","produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["promotion-meta-resource"],"summary":"updatePromotionConfig","operationId":"updatePromotionConfigUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotion","description":"promotion","required":true,"schema":{"$ref":"#/definitions/PromotionMetaROReq"}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/activate":{"put":{"tags":["promotion-meta-resource"],"summary":"activatePromotion","operationId":"activatePromotionUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/deactivate":{"put":{"tags":["promotion-meta-resource"],"summary":"deactivatePromotion","operationId":"deactivatePromotionUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/issueBulk":{"post":{"tags":["promotion-earning-management-resource"],"summary":"issuePromotionsInBulk","operationId":"issuePromotionsInBulkUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"contextId","required":true,"type":"string"},{"in":"body","name":"customerIds","description":"customerIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/config":{"get":{"tags":["promotion-resource"],"summary":"getPromotionConfig","operationId":"getPromotionConfigUsingGET_1","produces":["application/json"],"parameters":[{"name":"includeExpired","in":"query","required":false,"type":"boolean"},{"name":"includeInactive","in":"query","required":false,"type":"boolean"},{"name":"promotionIds","in":"query","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionConfigRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/customer/{customerId}":{"get":{"tags":["promotion-earning-resource"],"summary":"getAllForCustomer","operationId":"getAllForCustomerUsingGET","produces":["application/json"],"parameters":[{"name":"customerId","in":"path","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"includeExpired","in":"query","required":false,"type":"boolean"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["EVENT_TIME","VALID_TILL"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomerPromotionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/evaluate":{"post":{"tags":["promotion-redemption-resource"],"summary":"evaluatePromotionOnCart","operationId":"evaluatePromotionOnCartUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"cart","description":"cart","required":true,"schema":{"$ref":"#/definitions/CartRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CartRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/redemptions":{"get":{"tags":["promotion-redemption-resource"],"summary":"getRedemptions","operationId":"getRedemptionsUsingGET","produces":["application/json"],"parameters":[{"name":"customerId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"promotionId","in":"query","required":false,"type":"string"},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["REDEMPTION_DATE"]},{"name":"transactionEntityIdentifier","in":"query","required":false,"type":"string"},{"name":"transactionIdentifier","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/till/{tillId}":{"get":{"tags":["promotion-resource"],"summary":"getAllActivePosPromotionForTill","operationId":"getAllActivePosPromotionForTillUsingGET","produces":["application/json"],"parameters":[{"name":"tillId","in":"path","description":"tillId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionMetaRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/activate":{"post":{"tags":["promotion-earning-resource"],"summary":"activate","operationId":"activateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customerId","in":"query","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/deactivate":{"post":{"tags":["promotion-earning-resource"],"summary":"deactivate","operationId":"deactivateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customerId","in":"query","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/earn":{"post":{"tags":["promotion-earning-resource"],"summary":"earnPromotion","operationId":"earnPromotionUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"customerEarnedPromotion","description":"customerEarnedPromotion","required":true,"schema":{"$ref":"#/definitions/CustomerEarnedPromotionRO"}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"Action":{"type":"object","required":["type"],"properties":{"cartBasedAction":{"$ref":"#/definitions/CartBasedAction"},"fixedPriceAction":{"$ref":"#/definitions/FixedPriceAction"},"freeProductAction":{"$ref":"#/definitions/FreeProductAction"},"productBasedAction":{"$ref":"#/definitions/ProductBasedAction"},"type":{"type":"string","enum":["CART_BASED","FIXED_PRICE","FREE_PRODUCT","PRODUCT_BASED"]}},"title":"Action"},"ApiError":{"type":"object","properties":{"code":{"type":"integer","format":"int64"},"message":{"type":"string"}},"title":"ApiError"},"AppliedPromotionRO":{"type":"object","properties":{"discount":{"type":"string"},"discountAppliedOnQuantity":{"type":"string"},"identifier":{"type":"string"},"messageLabel":{"type":"string"},"name":{"type":"string"},"promotionAppliedOnQuantity":{"type":"string"},"promotionId":{"type":"string"},"redemptionCount":{"type":"integer","format":"int64"}},"title":"AppliedPromotionRO"},"AuditLogVersionRO":{"type":"object","properties":{"action":{"type":"string"},"triggeredBy":{"type":"integer","format":"int64"},"triggeredOn":{"type":"integer","format":"int64"},"version":{"type":"string"}},"title":"AuditLogVersionRO"},"CartBasedAction":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["ABSOLUTE","PERCENTAGE"]},"value":{"type":"string"}},"title":"CartBasedAction"},"CartCondition":{"type":"object","required":["kpi","operator","value"],"properties":{"kpi":{"type":"string","enum":["ITEMCOUNT","SUBTOTAL"]},"operator":{"type":"string","enum":["EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","IN","LESS_THAN","LESS_THAN_OR_EQUAL","NONE"]},"value":{"type":"string"}},"title":"CartCondition"},"CartItemRO":{"type":"object","required":["amount","qty","sku"],"properties":{"amount":{"type":"string"},"appliedPromotions":{"type":"array","items":{"$ref":"#/definitions/AppliedPromotionRO"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"brandList":{"type":"array","items":{"type":"string"}},"categoryList":{"type":"array","items":{"type":"string"}},"discount":{"type":"string"},"qty":{"type":"string"},"referenceId":{"type":"string"},"sku":{"type":"string"}},"title":"CartItemRO"},"CartRO":{"type":"object","required":["amount","cartItems","customerId"],"properties":{"amount":{"type":"string"},"appliedPromotions":{"type":"array","items":{"$ref":"#/definitions/AppliedPromotionRO"}},"cartItems":{"type":"array","items":{"$ref":"#/definitions/CartItemRO"}},"categoryHierarchySentInPayload":{"type":"boolean"},"customerId":{"type":"integer","format":"int64"},"evaluationId":{"type":"string"}},"title":"CartRO"},"ComboProductConditionRO":{"type":"object","required":["productConditions"],"properties":{"productConditions":{"type":"array","items":{"$ref":"#/definitions/ProductCondition"}}},"title":"ComboProductConditionRO"},"Condition":{"type":"object","required":["type"],"properties":{"cartCondition":{"$ref":"#/definitions/CartCondition"},"comboProductCondition":{"$ref":"#/definitions/ComboProductConditionRO"},"productCondition":{"$ref":"#/definitions/ProductCondition"},"type":{"type":"string","enum":["CART","COMBO_PRODUCT","PRODUCT"]}},"title":"Condition"},"CustomMetadataFieldRO":{"type":"object","required":["dataType","fieldName"],"properties":{"dataType":{"type":"string","enum":["DATE","NUMBER","STRING"]},"fieldName":{"type":"string"},"isRequired":{"type":"boolean"}},"title":"CustomMetadataFieldRO"},"CustomerEarnedPromotionRO":{"type":"object","required":["customerId","earnedFromId","earnedFromType","eventDetails","eventTime"],"properties":{"customerId":{"type":"integer","format":"int64"},"earnedFromId":{"type":"string"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventDetails":{"$ref":"#/definitions/EventDetailsRO"},"eventTime":{"type":"integer","format":"int64"},"id":{"type":"string"},"promotionId":{"type":"string"},"validTill":{"type":"integer","format":"int64"}},"title":"CustomerEarnedPromotionRO"},"CustomerPromotionRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"customerId":{"type":"integer","format":"int64"},"earnedFromId":{"type":"string"},"earnedStatus":{"type":"string","enum":["LOCKED","UNLOCKED"]},"earnedType":{"type":"string","enum":["MILESTONE_EARN","NONE","REWARD","SINGLE_ACTIVITY_EARN"]},"mileStoneId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validTill":{"type":"integer","format":"int64"}},"title":"CustomerPromotionRO"},"Duration":{"type":"object","properties":{"period":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}},"title":"Duration"},"EarningCriteriaRO":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteria"}},"title":"EarningCriteriaRO"},"EarningCriteriaROReq":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaReq"}},"title":"EarningCriteriaROReq"},"EarningCriteriaRORes":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaRes"}},"title":"EarningCriteriaRORes"},"EventDetailsRO":{"type":"object","properties":{"eventPayload":{"type":"object"},"id":{"type":"string"},"type":{"type":"string"}},"title":"EventDetailsRO"},"FixedPriceAction":{"type":"object","required":["value"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"},"value":{"type":"string"}},"title":"FixedPriceAction"},"FreeProductAction":{"type":"object","required":["productBasedCondition"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"}},"title":"FreeProductAction"},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"}},"title":"LocalTime"},"LocalTimeReq":{"type":"object","properties":{"hour":{"type":"string","format":"byte"},"minute":{"type":"string","format":"byte"},"nano":{"type":"integer","format":"int32"},"second":{"type":"string","format":"byte"}},"title":"LocalTimeReq"},"LocalTimeRes":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"}},"title":"LocalTimeRes"},"ObjectId":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"timestamp":{"type":"integer","format":"int32"}},"title":"ObjectId"},"ProductBasedAction":{"type":"object","required":["type","value"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"},"type":{"type":"string","enum":["ABSOLUTE","PERCENTAGE"]},"value":{"type":"string"}},"title":"ProductBasedAction"},"ProductCondition":{"type":"object","required":["criteriaList","kpi"],"properties":{"criteriaList":{"type":"array","items":{"$ref":"#/definitions/ProductSelectionCriteriaRO"}},"kpi":{"type":"string","enum":["AMOUNT","NONE","QUANTITY"]},"operator":{"type":"string","enum":["EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","IN","LESS_THAN","LESS_THAN_OR_EQUAL","NONE"]},"value":{"type":"string"}},"title":"ProductCondition"},"ProductSelectionCriteriaRO":{"type":"object","required":["entity","values"],"properties":{"attributeName":{"type":"string"},"entity":{"type":"string","enum":["ATTRIBUTE","BRAND","CATEGORY","SKU"]},"operator":{"type":"string","enum":["IN","NOT_IN"]},"values":{"type":"array","items":{"type":"string"}}},"title":"ProductSelectionCriteriaRO"},"PromotionConfigRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"},"expiry":{"type":"integer","format":"int64"},"groupId":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"milestoneId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"promotionType":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},"reward":{"type":"string"},"ruleId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"}},"title":"PromotionConfigRO"},"PromotionMetaRO":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaRO"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteria"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaRO"},"PromotionMetaROReq":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaROReq"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaReq"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaROReq"},"PromotionMetaRORes":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaRORes"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaRes"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaRORes"},"PromotionRedemptionRO":{"type":"object","properties":{"amount":{"type":"string"},"cartEvaluationId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"discount":{"type":"string"},"discountAppliedQuantity":{"type":"string"},"id":{"$ref":"#/definitions/ObjectId"},"orgId":{"type":"integer","format":"int64"},"productId":{"type":"integer","format":"int64"},"promotionAppliedQuantity":{"type":"string"},"promotionId":{"type":"string"},"promotionMessageLabel":{"type":"string"},"promotionName":{"type":"string"},"redemptionCount":{"type":"integer","format":"int64"},"redemptionDate":{"type":"string","format":"date-time"},"redemptionTill":{"type":"integer","format":"int64"},"redemptionType":{"type":"string","enum":["CART","LINEITEM"]},"sku":{"type":"string"},"transactionEntityIdentifier":{"type":"string"},"transactionIdentifier":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PromotionRedemptionRO"},"PromotionStrategyRO":{"type":"object","required":["promotionRankingStrategy","rewardStrategy"],"properties":{"isActive":{"type":"boolean"},"promotionRankingStrategy":{"type":"string","enum":["EXPIRY_BASED","MAX_DISCOUNT","PRIORITY"]},"rewardStrategy":{"type":"string","enum":["NO_STRATEGY","PROMOTION_FIRST","REWARDS_FIRST"]}},"title":"PromotionStrategyRO"},"PromotionSummaryRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"endDate":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"lastEarned":{"type":"integer","format":"int64"},"lastRedeemed":{"type":"integer","format":"int64"},"orgId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionType":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},"startDate":{"type":"integer","format":"int64"},"targetedCustomerCount":{"type":"integer","format":"int64"},"totalDiscount":{"type":"string"},"totalDiscountAppliedQuantity":{"type":"number","format":"double"},"totalEarned":{"type":"string"},"totalPromotionAppliedQuantity":{"type":"number","format":"double"},"totalRedeemed":{"type":"integer","format":"int64"},"totalTransactions":{"type":"integer","format":"int64"}},"title":"PromotionSummaryRO"},"ResponseWrapper«CartRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CartRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«CartRO»"},"ResponseWrapper«CustomerEarnedPromotionRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CustomerEarnedPromotionRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«CustomerEarnedPromotionRO»"},"ResponseWrapper«List«AuditLogVersionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/AuditLogVersionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«AuditLogVersionRO»»"},"ResponseWrapper«List«CustomMetadataFieldRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CustomMetadataFieldRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«CustomMetadataFieldRO»»"},"ResponseWrapper«List«CustomerPromotionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CustomerPromotionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«CustomerPromotionRO»»"},"ResponseWrapper«List«PromotionConfigRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionConfigRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionConfigRO»»"},"ResponseWrapper«List«PromotionMetaRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionMetaRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionMetaRO»»"},"ResponseWrapper«List«PromotionRedemptionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionRedemptionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionRedemptionRO»»"},"ResponseWrapper«List«PromotionSummaryRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionSummaryRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionSummaryRO»»"},"ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/definitions/CustomerEarnedPromotionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»"},"ResponseWrapper«PromotionMetaRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PromotionMetaRORes"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«PromotionMetaRO»"},"ResponseWrapper«PromotionStrategyRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PromotionStrategyRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«PromotionStrategyRO»"},"ResponseWrapper«boolean»":{"type":"object","properties":{"data":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«boolean»"},"ResponseWrapper«object»":{"type":"object","properties":{"data":{"type":"object"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«object»"},"RestrictionKPIRO":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAYS","WEEKS"]},"kpi":{"type":"string","enum":["DISCOUNT","REDEMPTION","TRANSACTION"]},"limit":{"type":"number"},"minTimeBetweenRepeat":{"type":"integer","format":"int64"}},"title":"RestrictionKPIRO"},"StoreCriteria":{"type":"object","required":["operator","type","values"],"properties":{"operator":{"type":"string","enum":["IN","NOT_IN"]},"type":{"type":"string","enum":["CONCEPT","STORE","ZONE"]},"values":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"StoreCriteria"},"TimeCriteria":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTime"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteria"},"TimeCriteriaReq":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTimeReq"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteriaReq"},"TimeCriteriaRes":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTimeRes"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteriaRes"}}} diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh new file mode 100644 index 00000000000..321accb3dbc --- /dev/null +++ b/swagger_sdk_gen_promotion_engine.sh @@ -0,0 +1,57 @@ +if $Build_Codegen ; then + mvn3 clean package -Dmaven.test.skip=true +fi + +echo "{\"artifactVersion\":\"${Version}\"}">config.json +echo "GENERATING SDK" +if [ "$Client" = "java" ] +then + rm -rf promotion_engine/java_client/java + mkdir -p promotion_engine/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i promotion-engine.json \ + -l java \ + -DdateLibrary=java8 \ + -o promotion_engine/java_client/java \ + -c config.json --group-id com.capillary.promotionengine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk + tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . + mvn3 clean deploy -f promotion_engine/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_promotion_engine" + +elif [ "$Client" = "c#" ] +then rm -rf intouch_api/csharp_client/c# + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l csharp\ + -DtargetFramework=v$Version \ + -o intouch_api/csharp_client/c# + tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-promotion-engine-sdk" +elif [ "$Client" = "php" ] +then rm -rf intouch_api/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l php \ + -o intouch_api/php_client/php \ + -c config_php.json + tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-promotion-engine-sdk" +elif [ "$Client" = "nodejs" ] +then rm -rf intouch_api/nodejs_client + mkdir -p intouch_api/nodejs_client/ + curl $url > swagger.json + npm install swagger-js-codegen + cd swagger-js-codegen + node ../nodejs_sdk_gen > ../intouch_api/nodejs_client/node_$BUILD_NUMBER + fpm -f -s "dir" -t "deb" -a "all" -n "node-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/nodejs_client --deb-no-default-config-files nodejs="/usr/share/nodejs/capillary-libs/swagger-promotion-engine-sdk" +elif [ "$Client" = "python" ] +then rm -rf intouch_api/python_client + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i $url \ + -l python \ + -o intouch_api/python_client/python + tar cvzf intouch_api/python_client/python_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/python_client/python/ . + fpm -f -s "dir" -t "deb" -a "all" -n "py-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/python_client --deb-no-default-config-files python="/usr/share/python/capillary-libs/swagger-promotion-engine-sdk" +else " no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From f08a92dd069365baf5f72ca72ac14072eba35a6a Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 15:44:00 +0530 Subject: [PATCH 102/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 321accb3dbc..8692231eeea 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -9,7 +9,7 @@ then rm -rf promotion_engine/java_client/java mkdir -p promotion_engine/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i promotion-engine.json \ + -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ -l java \ -DdateLibrary=java8 \ -o promotion_engine/java_client/java \ From 0efe6151148ef5399457858d0ee7beed2de97226 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 15:45:00 +0530 Subject: [PATCH 103/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 8692231eeea..5b0b541005d 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -9,7 +9,7 @@ then rm -rf promotion_engine/java_client/java mkdir -p promotion_engine/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ + -i "https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ -l java \ -DdateLibrary=java8 \ -o promotion_engine/java_client/java \ From 44f3c623c8f822ce5434c8ebc3925fbf2093adaf Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 15:53:29 +0530 Subject: [PATCH 104/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 5b0b541005d..cc0296ec33b 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -9,9 +9,9 @@ then rm -rf promotion_engine/java_client/java mkdir -p promotion_engine/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i "https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ + -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ -l java \ - -DdateLibrary=java8 \ + -DdateLibrary=java11 \ -o promotion_engine/java_client/java \ -c config.json --group-id com.capillary.promotionengine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . From 4777e546d5b2ca9dce407f988e57df6617b69e85 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 15:56:45 +0530 Subject: [PATCH 105/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index cc0296ec33b..8692231eeea 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -11,7 +11,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ -l java \ - -DdateLibrary=java11 \ + -DdateLibrary=java8 \ -o promotion_engine/java_client/java \ -c config.json --group-id com.capillary.promotionengine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . From d143d67cac38ac2a36e8c5dfd9f3210ccf2e342f Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 15:58:08 +0530 Subject: [PATCH 106/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 8692231eeea..cc0296ec33b 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -11,7 +11,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ -l java \ - -DdateLibrary=java8 \ + -DdateLibrary=java11 \ -o promotion_engine/java_client/java \ -c config.json --group-id com.capillary.promotionengine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . From 36a74b1bb8dd2a9c0794edce2ba3c663f2184121 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Mon, 26 Apr 2021 16:03:39 +0530 Subject: [PATCH 107/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index cc0296ec33b..ca8ed6c1465 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -9,11 +9,11 @@ then rm -rf promotion_engine/java_client/java mkdir -p promotion_engine/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i "https://promotion-engine-api.crm-nightly-new.cc.capillarytech.com/v2/api-docs" \ + -i promotion-engine.json \ -l java \ -DdateLibrary=java11 \ -o promotion_engine/java_client/java \ - -c config.json --group-id com.capillary.promotionengine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk + -c config.json --group-id com.capillary.coupongateway --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . mvn3 clean deploy -f promotion_engine/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_promotion_engine" From ee3da72c9f2169af521143c839df44ffd80b499b Mon Sep 17 00:00:00 2001 From: bhanu Date: Tue, 4 May 2021 22:40:20 +0530 Subject: [PATCH 108/150] api v3 url change --- swagger_sdk_gen_v3.sh | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 887a9b8c484..4e24917c247 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -1,16 +1,8 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -if [ "$Branch" = "snapshot" ] - then - url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" - version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" -elif [ "$Branch" = "production" ] - then - url="http://api.staging.capillary.in/tl-docs/v2/api-docs" - version="http://api.staging.capillary.in/v3/meta/version" -else " No Branch is selected" -fi +url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" +version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" curl -k $version -o config.json #echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json echo "GENERATING SDK" From eabda962e09619423b7f8a0e637f12f5a3f1a876 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 11:15:28 +0530 Subject: [PATCH 109/150] Revert "api v3 url change" This reverts commit ee3da72c9f2169af521143c839df44ffd80b499b. --- swagger_sdk_gen_v3.sh | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 4e24917c247..887a9b8c484 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -1,8 +1,16 @@ if $Build_Codegen ; then mvn3 clean package -Dmaven.test.skip=true fi -url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" -version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" +if [ "$Branch" = "snapshot" ] + then + url="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v2/api-docs" + version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" +elif [ "$Branch" = "production" ] + then + url="http://api.staging.capillary.in/tl-docs/v2/api-docs" + version="http://api.staging.capillary.in/v3/meta/version" +else " No Branch is selected" +fi curl -k $version -o config.json #echo '{"artifactVersion":"0.0.1-SNAPSHOT","invokerPackage":"SwaggerV3\\\\Client","modelPackage":"SwaggerV3\\\\Client\\\\Model","apiPackage":"SwaggerV3\\\\Client\\\\Api"}'>config_php.json echo "GENERATING SDK" From b8c95b3fdd111a9b9f12c4d59b12093fb9cb3680 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 11:18:28 +0530 Subject: [PATCH 110/150] updating v3 urls --- swagger_sdk_gen_v3.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 887a9b8c484..4b468a53dd4 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -7,8 +7,8 @@ if [ "$Branch" = "snapshot" ] version="https://intouch-api-v3-swagger.crm-nightly-new.cc.capillarytech.com/v3/meta/version" elif [ "$Branch" = "production" ] then - url="http://api.staging.capillary.in/tl-docs/v2/api-docs" - version="http://api.staging.capillary.in/v3/meta/version" + url="https://intouch-api-v3-swagger.crm-staging-new.cc.capillarytech.com/v2/api-docs" + version="https://intouch-api-v3-swagger.crm-staging-new.cc.capillarytech.com/v3/meta/version" else " No Branch is selected" fi curl -k $version -o config.json From 8b297a096419351eaa6e97ce31e0fa27ba10685d Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 11:26:30 +0530 Subject: [PATCH 111/150] certificate skip in v3 --- swagger_sdk_gen_v3.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 4b468a53dd4..015739fb481 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -21,6 +21,7 @@ then -i $url \ -l java \ -DdateLibrary=java8 \ + -Dio.swagger.parser.util.RemoteUrl.trustAll=true \ -o intouch_api/java_client/java \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . From 58aa4637f382e4d0fb8da520bdcd4d7939505ee1 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 11:39:38 +0530 Subject: [PATCH 112/150] date format in v3 --- swagger_sdk_gen_v3.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index 015739fb481..aebf97187f6 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -20,8 +20,7 @@ then java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l java \ - -DdateLibrary=java8 \ - -Dio.swagger.parser.util.RemoteUrl.trustAll=true \ + -Dio.swagger.parser.util.RemoteUrl.trustAll=true -DdateLibrary=java8 \ -o intouch_api/java_client/java \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . From 9c97105ad234a6a5cd36e076ffdfaae7fc399030 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 11:45:59 +0530 Subject: [PATCH 113/150] date format in v3 --- swagger_sdk_gen_v3.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index aebf97187f6..acf93e2fc1f 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -17,10 +17,9 @@ echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf intouch_api/java_client/java - java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + java -Dio.swagger.parser.util.RemoteUrl.trustAll=true -DdateLibrary=java8 -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l java \ - -Dio.swagger.parser.util.RemoteUrl.trustAll=true -DdateLibrary=java8 \ -o intouch_api/java_client/java \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . From e6a02a175a4c86c8819b15eaacfb75c9a4a8a429 Mon Sep 17 00:00:00 2001 From: Krishna Sankar Date: Wed, 5 May 2021 12:10:55 +0530 Subject: [PATCH 114/150] fixing v3 --- swagger_sdk_gen_v3.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index acf93e2fc1f..f7f6af9029f 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -17,7 +17,7 @@ echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf intouch_api/java_client/java - java -Dio.swagger.parser.util.RemoteUrl.trustAll=true -DdateLibrary=java8 -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + java -Dio.swagger.parser.util.RemoteUrl.trustAll=true,dateLibrary=java8 -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l java \ -o intouch_api/java_client/java \ From b63fe1a32c20fa7942733e5ada9226d789410c4e Mon Sep 17 00:00:00 2001 From: Krishna ManiSankar J Date: Wed, 5 May 2021 12:36:52 +0530 Subject: [PATCH 115/150] Update swagger_sdk_gen_v3.sh --- swagger_sdk_gen_v3.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/swagger_sdk_gen_v3.sh b/swagger_sdk_gen_v3.sh index f7f6af9029f..4b468a53dd4 100644 --- a/swagger_sdk_gen_v3.sh +++ b/swagger_sdk_gen_v3.sh @@ -17,9 +17,10 @@ echo "GENERATING SDK" if [ "$Client" = "java" ] then rm -rf intouch_api/java_client/java - java -Dio.swagger.parser.util.RemoteUrl.trustAll=true,dateLibrary=java8 -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l java \ + -DdateLibrary=java8 \ -o intouch_api/java_client/java \ -c config.json tar cvzf intouch_api/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/java_client/java/ . From 5d6c5cff5c90e552dc57b50d433aa188dd856332 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Wed, 16 Jun 2021 18:19:06 +0530 Subject: [PATCH 116/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index ca8ed6c1465..8e6fb7cdc87 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -28,14 +28,14 @@ then rm -rf intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-promotion-engine-sdk" elif [ "$Client" = "php" ] -then rm -rf intouch_api/php_client/php +then rm -rf promotion_engine/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i $url \ -l php \ - -o intouch_api/php_client/php \ + -o promotion_engine/php_client/php \ -c config_php.json - tar cvzf intouch_api/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . - fpm -f -s "dir" -t "deb" -a "all" -n "swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./intouch_api/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-promotion-engine-sdk" + tar cvzf promotion_engine/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-promotion-engine-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client mkdir -p intouch_api/nodejs_client/ From db32e4c83191c3ec92998a885f373afa4189f41e Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Wed, 16 Jun 2021 18:19:39 +0530 Subject: [PATCH 117/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 8e6fb7cdc87..e03c894fce2 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -34,7 +34,7 @@ then rm -rf promotion_engine/php_client/php -l php \ -o promotion_engine/php_client/php \ -c config_php.json - tar cvzf promotion_engine/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./intouch_api/php_client/php/ . + tar cvzf promotion_engine/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/php_client/php/ . fpm -f -s "dir" -t "deb" -a "all" -n "swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-promotion-engine-sdk" elif [ "$Client" = "nodejs" ] then rm -rf intouch_api/nodejs_client From 707b0ebc5baf3d18a62589a3e033449775afd200 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Wed, 16 Jun 2021 18:20:01 +0530 Subject: [PATCH 118/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index e03c894fce2..92d05ca1241 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -30,7 +30,7 @@ then rm -rf intouch_api/csharp_client/c# elif [ "$Client" = "php" ] then rm -rf promotion_engine/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i $url \ + -i promotion-engine.json \ -l php \ -o promotion_engine/php_client/php \ -c config_php.json From 7ea5b574f5b6861373d365e91452eb75096820dc Mon Sep 17 00:00:00 2001 From: Vishak Udupa Date: Thu, 22 Jul 2021 10:06:35 +0530 Subject: [PATCH 119/150] Update promotion-engine.json --- promotion-engine.json | 3813 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 3812 insertions(+), 1 deletion(-) diff --git a/promotion-engine.json b/promotion-engine.json index 4356631264a..6e6db4df2b4 100644 --- a/promotion-engine.json +++ b/promotion-engine.json @@ -1 +1,3812 @@ -{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"promotion-engine-api.crm-nightly-new.cc.capillarytech.com","basePath":"/","tags":[{"name":"audit-log-resource","description":"Audit Log Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"promotion-earning-management-resource","description":"Promotion Earning Management Resource"},{"name":"promotion-earning-resource","description":"Promotion Earning Resource"},{"name":"promotion-meta-resource","description":"Promotion Meta Resource"},{"name":"promotion-redemption-resource","description":"Promotion Redemption Resource"},{"name":"promotion-resource","description":"Promotion Resource"},{"name":"promotion-settings-resource","description":"Promotion Settings Resource"}],"paths":{"/health/isalive":{"get":{"tags":["health-check-resource"],"summary":"isAlive","operationId":"isAliveUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions":{"get":{"tags":["promotion-meta-resource"],"summary":"getAllPromotionConfigs","operationId":"getAllPromotionConfigsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionMetaRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-meta-resource"],"summary":"createPromotionConfig","operationId":"createPromotionConfigUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotion","description":"promotion","required":true,"schema":{"$ref":"#/definitions/PromotionMetaROReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/auditLogs/versions":{"get":{"tags":["audit-log-resource"],"summary":"getAuditLogVersions","operationId":"getAuditLogVersionsUsingGET","produces":["application/json"],"parameters":[{"name":"endDate","in":"query","required":false,"type":"integer","format":"int64"},{"name":"entityId","in":"query","required":true,"type":"string"},{"name":"entityType","in":"query","required":true,"type":"string","enum":["PROMOTION_META","PROMOTION_SETTING"]},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startDate","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«AuditLogVersionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}":{"get":{"tags":["audit-log-resource"],"summary":"getAuditLogEntity","operationId":"getAuditLogEntityUsingGET","produces":["application/json"],"parameters":[{"name":"entityId","in":"path","description":"entityId","required":true,"type":"string"},{"name":"entityType","in":"path","description":"entityType","required":true,"type":"string","enum":["PROMOTION_META","PROMOTION_SETTING"]},{"name":"version","in":"path","description":"version","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«object»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/filters":{"get":{"tags":["promotion-meta-resource"],"summary":"getFilteredPromotions","operationId":"getFilteredPromotionsUsingGET","produces":["application/json"],"parameters":[{"name":"active","in":"query","required":false,"type":"boolean"},{"name":"campaignId","in":"query","required":false,"type":"string"},{"name":"endDate","in":"query","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"promotionType","in":"query","required":false,"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["ID","NAME","START_DATE"]},{"name":"startDate","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionSummaryRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/settings/custom_field":{"get":{"tags":["promotion-settings-resource"],"summary":"getPromotionCustomFields","operationId":"getPromotionCustomFieldsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-settings-resource"],"summary":"savePromotionCustomFields","operationId":"savePromotionCustomFieldsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"customMetadataFields","description":"customMetadataFields","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/CustomMetadataFieldRO"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/settings/strategy":{"get":{"tags":["promotion-settings-resource"],"summary":"getPromotionStrategy","operationId":"getPromotionStrategyUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionStrategyRO»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["promotion-settings-resource"],"summary":"savePromotionStrategy","operationId":"savePromotionStrategyUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotionStrategy","description":"promotionStrategy","required":true,"schema":{"$ref":"#/definitions/PromotionStrategyRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionStrategyRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}":{"get":{"tags":["promotion-meta-resource"],"summary":"getPromotionConfig","operationId":"getPromotionConfigUsingGET","produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["promotion-meta-resource"],"summary":"updatePromotionConfig","operationId":"updatePromotionConfigUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"promotion","description":"promotion","required":true,"schema":{"$ref":"#/definitions/PromotionMetaROReq"}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«PromotionMetaRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/activate":{"put":{"tags":["promotion-meta-resource"],"summary":"activatePromotion","operationId":"activatePromotionUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/deactivate":{"put":{"tags":["promotion-meta-resource"],"summary":"deactivatePromotion","operationId":"deactivatePromotionUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/management/promotions/{promotionId}/issueBulk":{"post":{"tags":["promotion-earning-management-resource"],"summary":"issuePromotionsInBulk","operationId":"issuePromotionsInBulkUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"contextId","required":true,"type":"string"},{"in":"body","name":"customerIds","description":"customerIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/config":{"get":{"tags":["promotion-resource"],"summary":"getPromotionConfig","operationId":"getPromotionConfigUsingGET_1","produces":["application/json"],"parameters":[{"name":"includeExpired","in":"query","required":false,"type":"boolean"},{"name":"includeInactive","in":"query","required":false,"type":"boolean"},{"name":"promotionIds","in":"query","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionConfigRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/customer/{customerId}":{"get":{"tags":["promotion-earning-resource"],"summary":"getAllForCustomer","operationId":"getAllForCustomerUsingGET","produces":["application/json"],"parameters":[{"name":"customerId","in":"path","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"includeExpired","in":"query","required":false,"type":"boolean"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["EVENT_TIME","VALID_TILL"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«CustomerPromotionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/evaluate":{"post":{"tags":["promotion-redemption-resource"],"summary":"evaluatePromotionOnCart","operationId":"evaluatePromotionOnCartUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"cart","description":"cart","required":true,"schema":{"$ref":"#/definitions/CartRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CartRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/redemptions":{"get":{"tags":["promotion-redemption-resource"],"summary":"getRedemptions","operationId":"getRedemptionsUsingGET","produces":["application/json"],"parameters":[{"name":"customerId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string","enum":["ASC","DESC"]},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"promotionId","in":"query","required":false,"type":"string"},{"name":"sortOn","in":"query","required":false,"type":"string","enum":["REDEMPTION_DATE"]},{"name":"transactionEntityIdentifier","in":"query","required":false,"type":"string"},{"name":"transactionIdentifier","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/till/{tillId}":{"get":{"tags":["promotion-resource"],"summary":"getAllActivePosPromotionForTill","operationId":"getAllActivePosPromotionForTillUsingGET","produces":["application/json"],"parameters":[{"name":"tillId","in":"path","description":"tillId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«List«PromotionMetaRO»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/activate":{"post":{"tags":["promotion-earning-resource"],"summary":"activate","operationId":"activateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customerId","in":"query","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/deactivate":{"post":{"tags":["promotion-earning-resource"],"summary":"deactivate","operationId":"deactivateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"customerId","in":"query","description":"customerId","required":true,"type":"integer","format":"int64"},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«boolean»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/v1/promotions/{promotionId}/earn":{"post":{"tags":["promotion-earning-resource"],"summary":"earnPromotion","operationId":"earnPromotionUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"customerEarnedPromotion","description":"customerEarnedPromotion","required":true,"schema":{"$ref":"#/definitions/CustomerEarnedPromotionRO"}},{"name":"promotionId","in":"path","description":"promotionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"Action":{"type":"object","required":["type"],"properties":{"cartBasedAction":{"$ref":"#/definitions/CartBasedAction"},"fixedPriceAction":{"$ref":"#/definitions/FixedPriceAction"},"freeProductAction":{"$ref":"#/definitions/FreeProductAction"},"productBasedAction":{"$ref":"#/definitions/ProductBasedAction"},"type":{"type":"string","enum":["CART_BASED","FIXED_PRICE","FREE_PRODUCT","PRODUCT_BASED"]}},"title":"Action"},"ApiError":{"type":"object","properties":{"code":{"type":"integer","format":"int64"},"message":{"type":"string"}},"title":"ApiError"},"AppliedPromotionRO":{"type":"object","properties":{"discount":{"type":"string"},"discountAppliedOnQuantity":{"type":"string"},"identifier":{"type":"string"},"messageLabel":{"type":"string"},"name":{"type":"string"},"promotionAppliedOnQuantity":{"type":"string"},"promotionId":{"type":"string"},"redemptionCount":{"type":"integer","format":"int64"}},"title":"AppliedPromotionRO"},"AuditLogVersionRO":{"type":"object","properties":{"action":{"type":"string"},"triggeredBy":{"type":"integer","format":"int64"},"triggeredOn":{"type":"integer","format":"int64"},"version":{"type":"string"}},"title":"AuditLogVersionRO"},"CartBasedAction":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["ABSOLUTE","PERCENTAGE"]},"value":{"type":"string"}},"title":"CartBasedAction"},"CartCondition":{"type":"object","required":["kpi","operator","value"],"properties":{"kpi":{"type":"string","enum":["ITEMCOUNT","SUBTOTAL"]},"operator":{"type":"string","enum":["EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","IN","LESS_THAN","LESS_THAN_OR_EQUAL","NONE"]},"value":{"type":"string"}},"title":"CartCondition"},"CartItemRO":{"type":"object","required":["amount","qty","sku"],"properties":{"amount":{"type":"string"},"appliedPromotions":{"type":"array","items":{"$ref":"#/definitions/AppliedPromotionRO"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"brandList":{"type":"array","items":{"type":"string"}},"categoryList":{"type":"array","items":{"type":"string"}},"discount":{"type":"string"},"qty":{"type":"string"},"referenceId":{"type":"string"},"sku":{"type":"string"}},"title":"CartItemRO"},"CartRO":{"type":"object","required":["amount","cartItems","customerId"],"properties":{"amount":{"type":"string"},"appliedPromotions":{"type":"array","items":{"$ref":"#/definitions/AppliedPromotionRO"}},"cartItems":{"type":"array","items":{"$ref":"#/definitions/CartItemRO"}},"categoryHierarchySentInPayload":{"type":"boolean"},"customerId":{"type":"integer","format":"int64"},"evaluationId":{"type":"string"}},"title":"CartRO"},"ComboProductConditionRO":{"type":"object","required":["productConditions"],"properties":{"productConditions":{"type":"array","items":{"$ref":"#/definitions/ProductCondition"}}},"title":"ComboProductConditionRO"},"Condition":{"type":"object","required":["type"],"properties":{"cartCondition":{"$ref":"#/definitions/CartCondition"},"comboProductCondition":{"$ref":"#/definitions/ComboProductConditionRO"},"productCondition":{"$ref":"#/definitions/ProductCondition"},"type":{"type":"string","enum":["CART","COMBO_PRODUCT","PRODUCT"]}},"title":"Condition"},"CustomMetadataFieldRO":{"type":"object","required":["dataType","fieldName"],"properties":{"dataType":{"type":"string","enum":["DATE","NUMBER","STRING"]},"fieldName":{"type":"string"},"isRequired":{"type":"boolean"}},"title":"CustomMetadataFieldRO"},"CustomerEarnedPromotionRO":{"type":"object","required":["customerId","earnedFromId","earnedFromType","eventDetails","eventTime"],"properties":{"customerId":{"type":"integer","format":"int64"},"earnedFromId":{"type":"string"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventDetails":{"$ref":"#/definitions/EventDetailsRO"},"eventTime":{"type":"integer","format":"int64"},"id":{"type":"string"},"promotionId":{"type":"string"},"validTill":{"type":"integer","format":"int64"}},"title":"CustomerEarnedPromotionRO"},"CustomerPromotionRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"customerId":{"type":"integer","format":"int64"},"earnedFromId":{"type":"string"},"earnedStatus":{"type":"string","enum":["LOCKED","UNLOCKED"]},"earnedType":{"type":"string","enum":["MILESTONE_EARN","NONE","REWARD","SINGLE_ACTIVITY_EARN"]},"mileStoneId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validTill":{"type":"integer","format":"int64"}},"title":"CustomerPromotionRO"},"Duration":{"type":"object","properties":{"period":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}},"title":"Duration"},"EarningCriteriaRO":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteria"}},"title":"EarningCriteriaRO"},"EarningCriteriaROReq":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaReq"}},"title":"EarningCriteriaROReq"},"EarningCriteriaRORes":{"type":"object","required":["earnedFromType"],"properties":{"active":{"type":"boolean"},"criteriaDsl":{"type":"string"},"criteriaDslJson":{"type":"string"},"criteriaName":{"type":"string"},"duration":{"$ref":"#/definitions/Duration"},"earnedFromType":{"type":"string","enum":["ACTIVITY","BULK_ISSUE","MILESTONE","REWARD"]},"eventType":{"type":"string","enum":["CustomerRegistration","CustomerUpdate","TransactionAdd"]},"groupId":{"type":"integer","format":"int64"},"milestoneId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaRes"}},"title":"EarningCriteriaRORes"},"EventDetailsRO":{"type":"object","properties":{"eventPayload":{"type":"object"},"id":{"type":"string"},"type":{"type":"string"}},"title":"EventDetailsRO"},"FixedPriceAction":{"type":"object","required":["value"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"},"value":{"type":"string"}},"title":"FixedPriceAction"},"FreeProductAction":{"type":"object","required":["productBasedCondition"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"}},"title":"FreeProductAction"},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"}},"title":"LocalTime"},"LocalTimeReq":{"type":"object","properties":{"hour":{"type":"string","format":"byte"},"minute":{"type":"string","format":"byte"},"nano":{"type":"integer","format":"int32"},"second":{"type":"string","format":"byte"}},"title":"LocalTimeReq"},"LocalTimeRes":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"}},"title":"LocalTimeRes"},"ObjectId":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"timestamp":{"type":"integer","format":"int32"}},"title":"ObjectId"},"ProductBasedAction":{"type":"object","required":["type","value"],"properties":{"productBasedCondition":{"$ref":"#/definitions/Condition"},"type":{"type":"string","enum":["ABSOLUTE","PERCENTAGE"]},"value":{"type":"string"}},"title":"ProductBasedAction"},"ProductCondition":{"type":"object","required":["criteriaList","kpi"],"properties":{"criteriaList":{"type":"array","items":{"$ref":"#/definitions/ProductSelectionCriteriaRO"}},"kpi":{"type":"string","enum":["AMOUNT","NONE","QUANTITY"]},"operator":{"type":"string","enum":["EQUALS","GREATER_THAN","GREATER_THAN_OR_EQUAL","IN","LESS_THAN","LESS_THAN_OR_EQUAL","NONE"]},"value":{"type":"string"}},"title":"ProductCondition"},"ProductSelectionCriteriaRO":{"type":"object","required":["entity","values"],"properties":{"attributeName":{"type":"string"},"entity":{"type":"string","enum":["ATTRIBUTE","BRAND","CATEGORY","SKU"]},"operator":{"type":"string","enum":["IN","NOT_IN"]},"values":{"type":"array","items":{"type":"string"}}},"title":"ProductSelectionCriteriaRO"},"PromotionConfigRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"},"expiry":{"type":"integer","format":"int64"},"groupId":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"milestoneId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"promotionType":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},"reward":{"type":"string"},"ruleId":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"}},"title":"PromotionConfigRO"},"PromotionMetaRO":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaRO"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteria"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaRO"},"PromotionMetaROReq":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaROReq"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaReq"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaROReq"},"PromotionMetaRORes":{"type":"object","required":["action","campaignId","endDate","name","startDate","type"],"properties":{"action":{"$ref":"#/definitions/Action"},"active":{"type":"boolean"},"campaignId":{"type":"integer","format":"int64"},"condition":{"$ref":"#/definitions/Condition"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"earnLimitedToSpecificAudience":{"type":"boolean"},"earningCriteria":{"$ref":"#/definitions/EarningCriteriaRORes"},"endDate":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastUpdatedBy":{"type":"integer","format":"int64"},"lastUpdatedOn":{"type":"string","format":"date-time"},"loyaltyEarningExpiryDays":{"type":"integer","format":"int32"},"maxEarningPerCustomer":{"type":"integer","format":"int32"},"messageLabel":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":50},"orgId":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int32"},"promotionRestrictions":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/RestrictionKPIRO"}}},"startDate":{"type":"integer","format":"int64"},"storeCriteria":{"$ref":"#/definitions/StoreCriteria"},"timeCriteria":{"$ref":"#/definitions/TimeCriteriaRes"},"type":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]}},"title":"PromotionMetaRORes"},"PromotionRedemptionRO":{"type":"object","properties":{"amount":{"type":"string"},"cartEvaluationId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"discount":{"type":"string"},"discountAppliedQuantity":{"type":"string"},"id":{"$ref":"#/definitions/ObjectId"},"orgId":{"type":"integer","format":"int64"},"productId":{"type":"integer","format":"int64"},"promotionAppliedQuantity":{"type":"string"},"promotionId":{"type":"string"},"promotionMessageLabel":{"type":"string"},"promotionName":{"type":"string"},"redemptionCount":{"type":"integer","format":"int64"},"redemptionDate":{"type":"string","format":"date-time"},"redemptionTill":{"type":"integer","format":"int64"},"redemptionType":{"type":"string","enum":["CART","LINEITEM"]},"sku":{"type":"string"},"transactionEntityIdentifier":{"type":"string"},"transactionIdentifier":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PromotionRedemptionRO"},"PromotionStrategyRO":{"type":"object","required":["promotionRankingStrategy","rewardStrategy"],"properties":{"isActive":{"type":"boolean"},"promotionRankingStrategy":{"type":"string","enum":["EXPIRY_BASED","MAX_DISCOUNT","PRIORITY"]},"rewardStrategy":{"type":"string","enum":["NO_STRATEGY","PROMOTION_FIRST","REWARDS_FIRST"]}},"title":"PromotionStrategyRO"},"PromotionSummaryRO":{"type":"object","properties":{"customFieldValues":{"type":"object","additionalProperties":{"type":"string"}},"endDate":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"lastEarned":{"type":"integer","format":"int64"},"lastRedeemed":{"type":"integer","format":"int64"},"orgId":{"type":"integer","format":"int64"},"promotionId":{"type":"string"},"promotionName":{"type":"string"},"promotionType":{"type":"string","enum":["CUSTOMER","EARNING","POS","REWARD"]},"startDate":{"type":"integer","format":"int64"},"targetedCustomerCount":{"type":"integer","format":"int64"},"totalDiscount":{"type":"string"},"totalDiscountAppliedQuantity":{"type":"number","format":"double"},"totalEarned":{"type":"string"},"totalPromotionAppliedQuantity":{"type":"number","format":"double"},"totalRedeemed":{"type":"integer","format":"int64"},"totalTransactions":{"type":"integer","format":"int64"}},"title":"PromotionSummaryRO"},"ResponseWrapper«CartRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CartRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«CartRO»"},"ResponseWrapper«CustomerEarnedPromotionRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CustomerEarnedPromotionRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«CustomerEarnedPromotionRO»"},"ResponseWrapper«List«AuditLogVersionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/AuditLogVersionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«AuditLogVersionRO»»"},"ResponseWrapper«List«CustomMetadataFieldRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CustomMetadataFieldRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«CustomMetadataFieldRO»»"},"ResponseWrapper«List«CustomerPromotionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CustomerPromotionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«CustomerPromotionRO»»"},"ResponseWrapper«List«PromotionConfigRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionConfigRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionConfigRO»»"},"ResponseWrapper«List«PromotionMetaRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionMetaRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionMetaRO»»"},"ResponseWrapper«List«PromotionRedemptionRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionRedemptionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionRedemptionRO»»"},"ResponseWrapper«List«PromotionSummaryRO»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/PromotionSummaryRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«List«PromotionSummaryRO»»"},"ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/definitions/CustomerEarnedPromotionRO"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»"},"ResponseWrapper«PromotionMetaRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PromotionMetaRORes"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«PromotionMetaRO»"},"ResponseWrapper«PromotionStrategyRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PromotionStrategyRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«PromotionStrategyRO»"},"ResponseWrapper«boolean»":{"type":"object","properties":{"data":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«boolean»"},"ResponseWrapper«object»":{"type":"object","properties":{"data":{"type":"object"},"errors":{"type":"array","items":{"$ref":"#/definitions/ApiError"}}},"title":"ResponseWrapper«object»"},"RestrictionKPIRO":{"type":"object","properties":{"frequency":{"type":"string","enum":["DAYS","WEEKS"]},"kpi":{"type":"string","enum":["DISCOUNT","REDEMPTION","TRANSACTION"]},"limit":{"type":"number"},"minTimeBetweenRepeat":{"type":"integer","format":"int64"}},"title":"RestrictionKPIRO"},"StoreCriteria":{"type":"object","required":["operator","type","values"],"properties":{"operator":{"type":"string","enum":["IN","NOT_IN"]},"type":{"type":"string","enum":["CONCEPT","STORE","ZONE"]},"values":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"StoreCriteria"},"TimeCriteria":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTime"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteria"},"TimeCriteriaReq":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTimeReq"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteriaReq"},"TimeCriteriaRes":{"type":"object","properties":{"durationInHours":{"type":"integer","format":"int32"},"monthlyDayValues":{"type":"array","items":{"type":"integer","format":"int32"}},"repeatFrequency":{"type":"string","enum":["DAYS","DOES_NOT_REPEAT","WEEKS"]},"startTime":{"$ref":"#/definitions/LocalTimeRes"},"weeklyValues":{"type":"array","items":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}}},"title":"TimeCriteriaRes"}}} +{ + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "localhost:64373", + "basePath": "/", + "tags": [ + { + "name": "audit-log-resource", + "description": "Audit Log Resource" + }, + { + "name": "cart-evaluation-log-resource", + "description": "Cart Evaluation Log Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "promotion-communication-resource", + "description": "Promotion Communication Resource" + }, + { + "name": "promotion-earning-management-resource", + "description": "Promotion Earning Management Resource" + }, + { + "name": "promotion-earning-resource", + "description": "Promotion Earning Resource" + }, + { + "name": "promotion-meta-resource", + "description": "Promotion Meta Resource" + }, + { + "name": "promotion-redemption-resource", + "description": "Promotion Redemption Resource" + }, + { + "name": "promotion-resource", + "description": "Promotion Resource" + }, + { + "name": "promotion-settings-resource", + "description": "Promotion Settings Resource" + } + ], + "paths": { + "/health/isalive": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "isAlive", + "operationId": "isAliveUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getAllPromotionConfigs", + "operationId": "getAllPromotionConfigsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "createPromotionConfig", + "operationId": "createPromotionConfigUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/auditLogs/versions": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogVersions", + "operationId": "getAuditLogVersionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«AuditLogVersionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogEntity", + "operationId": "getAuditLogEntityUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "entityId", + "in": "path", + "description": "entityId", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "path", + "description": "entityType", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«object»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/evaluationLogs/{evaluationId}": { + "get": { + "tags": [ + "cart-evaluation-log-resource" + ], + "summary": "getEvaluationLogs", + "operationId": "getEvaluationLogsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "evaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartEvaluationRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/filters": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getFilteredPromotions", + "operationId": "getFilteredPromotionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "campaignId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "promotionType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ID", + "NAME", + "START_DATE" + ] + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionSummaryRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/settings/custom_field": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionCustomFields", + "operationId": "getPromotionCustomFieldsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionCustomFields", + "operationId": "savePromotionCustomFieldsUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customMetadataFields", + "description": "customMetadataFields", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/settings/strategy": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionStrategy", + "operationId": "getPromotionStrategyUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionStrategy", + "operationId": "savePromotionStrategyUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionStrategy", + "description": "promotionStrategy", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionStrategyRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "updatePromotionConfig", + "operationId": "updatePromotionConfigUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/activate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "activatePromotion", + "operationId": "activatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/deactivate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "deactivatePromotion", + "operationId": "deactivatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminders", + "operationId": "getPromotionExpiryRemindersUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionExpiryReminderRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "createPromotionExpiryReminder", + "operationId": "createPromotionExpiryReminderUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminder", + "operationId": "getPromotionExpiryReminderUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "updatePromotionExpiryReminder", + "operationId": "updatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/activate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "activatePromotionExpiryReminder", + "operationId": "activatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/deactivate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "deactivatePromotionExpiryReminder", + "operationId": "deactivatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/issueBulk": { + "post": { + "tags": [ + "promotion-earning-management-resource" + ], + "summary": "issuePromotionsInBulk", + "operationId": "issuePromotionsInBulkUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "contextId", + "in": "query", + "description": "contextId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "customerIds", + "description": "customerIds", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/config": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET_1", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "promotionIds", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionConfigRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/customer/{customerId}": { + "get": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "getAllForCustomer", + "operationId": "getAllForCustomerUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "path", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EVENT_TIME", + "VALID_TILL" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomerPromotionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/earn/bulk": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "bulkEarnPromotion", + "operationId": "bulkEarnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "bulkEarnRO", + "description": "bulkEarnRO", + "required": true, + "schema": { + "$ref": "#/definitions/BulkEarnRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«BulkEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/evaluate": { + "post": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "evaluatePromotionOnCart", + "operationId": "evaluatePromotionOnCartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "cart", + "description": "cart", + "required": true, + "schema": { + "$ref": "#/definitions/CartRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/redemptions": { + "get": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "getRedemptions", + "operationId": "getRedemptionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "promotionId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "REDEMPTION_DATE" + ] + }, + { + "name": "transactionEntityIdentifier", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "transactionIdentifier", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/till/{tillId}": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getAllActivePosPromotionForTill", + "operationId": "getAllActivePosPromotionForTillUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "tillId", + "in": "path", + "description": "tillId", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/activate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "activate", + "operationId": "activateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/deactivate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "deactivate", + "operationId": "deactivateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/earn": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "earnPromotion", + "operationId": "earnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customerEarnedPromotion", + "description": "customerEarnedPromotion", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + } + }, + "definitions": { + "Action": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartBasedAction": { + "$ref": "#/definitions/CartBasedAction" + }, + "fixedPriceAction": { + "$ref": "#/definitions/FixedPriceAction" + }, + "freeProductAction": { + "$ref": "#/definitions/FreeProductAction" + }, + "productBasedAction": { + "$ref": "#/definitions/ProductBasedAction" + }, + "type": { + "type": "string", + "enum": [ + "CART_BASED", + "FIXED_PRICE", + "FREE_PRODUCT", + "PRODUCT_BASED" + ] + } + }, + "title": "Action" + }, + "ApiError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "message": { + "type": "string" + } + }, + "title": "ApiError" + }, + "AppliedPromotionRO": { + "type": "object", + "properties": { + "discount": { + "type": "string" + }, + "discountAppliedOnQuantity": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string" + }, + "promotionAppliedOnQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + } + }, + "title": "AppliedPromotionRO" + }, + "AuditLogVersionRO": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "triggeredBy": { + "type": "integer", + "format": "int64" + }, + "triggeredOn": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + } + }, + "title": "AuditLogVersionRO" + }, + "BulkEarnRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnedPromotion" + } + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + } + }, + "title": "BulkEarnRO" + }, + "BulkEarnedPromotionRO": { + "type": "object", + "properties": { + "customerEarnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "earnedFromId": { + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/ErrorDetails" + }, + "failedEarnCount": { + "type": "integer", + "format": "int32" + }, + "successfulEarnCount": { + "type": "integer", + "format": "int32" + } + }, + "title": "BulkEarnedPromotionRO" + }, + "CartBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartBasedAction" + }, + "CartCondition": { + "type": "object", + "required": [ + "kpi", + "operator", + "value" + ], + "properties": { + "kpi": { + "type": "string", + "enum": [ + "ITEMCOUNT", + "SUBTOTAL" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartCondition" + }, + "CartEvaluationRO": { + "type": "object", + "properties": { + "createdOn": { + "type": "string", + "format": "date-time" + }, + "evaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionLogRO" + } + }, + "id": { + "type": "string" + }, + "isRedeemed": { + "type": "boolean" + } + }, + "title": "CartEvaluationRO" + }, + "CartItemRO": { + "type": "object", + "required": [ + "amount", + "qty", + "sku" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "brandList": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryList": { + "type": "array", + "items": { + "type": "string" + } + }, + "discount": { + "type": "string" + }, + "qty": { + "type": "string" + }, + "referenceId": { + "type": "string" + }, + "sku": { + "type": "string" + } + }, + "title": "CartItemRO" + }, + "CartRO": { + "type": "object", + "required": [ + "amount", + "cartItems", + "customerId" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "evaluationId": { + "type": "string" + } + }, + "title": "CartRO" + }, + "ComboProductConditionRO": { + "type": "object", + "required": [ + "productConditions" + ], + "properties": { + "productConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductCondition" + } + } + }, + "title": "ComboProductConditionRO" + }, + "CommunicationChannelRO": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "channelType": { + "type": "string", + "enum": [ + "ANDROID", + "EMAIL", + "IOS", + "SMS" + ] + }, + "domainPropertyId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "senderCDMA": { + "type": "string" + }, + "senderEmail": { + "type": "string" + }, + "senderGSM": { + "type": "string" + }, + "senderLabel": { + "type": "string" + }, + "senderReplyToEmail": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "unsubscribeLabel": { + "type": "string" + } + }, + "title": "CommunicationChannelRO" + }, + "Condition": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartCondition": { + "$ref": "#/definitions/CartCondition" + }, + "comboProductCondition": { + "$ref": "#/definitions/ComboProductConditionRO" + }, + "productCondition": { + "$ref": "#/definitions/ProductCondition" + }, + "type": { + "type": "string", + "enum": [ + "CART", + "COMBO_PRODUCT", + "PRODUCT" + ] + } + }, + "title": "Condition" + }, + "CustomMetadataFieldRO": { + "type": "object", + "required": [ + "dataType", + "fieldName" + ], + "properties": { + "dataType": { + "type": "string", + "enum": [ + "DATE", + "NUMBER", + "STRING" + ] + }, + "fieldName": { + "type": "string" + }, + "isRequired": { + "type": "boolean" + } + }, + "title": "CustomMetadataFieldRO" + }, + "CustomerEarnedPromotionRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerEarnedPromotionRO" + }, + "CustomerPromotionRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedStatus": { + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED" + ] + }, + "earnedType": { + "type": "string", + "enum": [ + "MILESTONE_EARN", + "NONE", + "REWARD", + "SINGLE_ACTIVITY_EARN" + ] + }, + "mileStoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + }, + "unlockedDate": { + "type": "integer", + "format": "int64" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerPromotionRO" + }, + "Duration": { + "type": "object", + "properties": { + "period": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "DAYS", + "HOURS", + "MINUTES" + ] + } + }, + "title": "Duration" + }, + "EarnedPromotion": { + "type": "object", + "required": [ + "earnCount", + "earnedFromId", + "promotionId" + ], + "properties": { + "earnCount": { + "type": "integer", + "format": "int32" + }, + "earnedFromId": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnedPromotion" + }, + "EarningCriteriaRO": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + } + }, + "title": "EarningCriteriaRO" + }, + "EarningCriteriaROReq": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + } + }, + "title": "EarningCriteriaROReq" + }, + "EarningCriteriaRORes": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + } + }, + "title": "EarningCriteriaRORes" + }, + "ErrorDetails": { + "type": "object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int64" + }, + "errorMessages": { + "type": "string" + } + }, + "title": "ErrorDetails" + }, + "EventDetailsRO": { + "type": "object", + "properties": { + "eventPayload": { + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "title": "EventDetailsRO" + }, + "FixedPriceAction": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "value": { + "type": "string" + } + }, + "title": "FixedPriceAction" + }, + "FreeProductAction": { + "type": "object", + "required": [ + "productBasedCondition" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + } + }, + "title": "FreeProductAction" + }, + "LocalTime": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTime" + }, + "LocalTimeReq": { + "type": "object", + "properties": { + "hour": { + "type": "string", + "format": "byte" + }, + "minute": { + "type": "string", + "format": "byte" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "string", + "format": "byte" + } + }, + "title": "LocalTimeReq" + }, + "LocalTimeRes": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTimeRes" + }, + "ObjectId": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "timestamp": { + "type": "integer", + "format": "int32" + } + }, + "title": "ObjectId" + }, + "ProductBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductBasedAction" + }, + "ProductCondition": { + "type": "object", + "required": [ + "criteriaList", + "kpi" + ], + "properties": { + "criteriaList": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductSelectionCriteriaRO" + } + }, + "kpi": { + "type": "string", + "enum": [ + "AMOUNT", + "NONE", + "QUANTITY" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductCondition" + }, + "ProductSelectionCriteriaRO": { + "type": "object", + "required": [ + "entity", + "values" + ], + "properties": { + "attributeName": { + "type": "string" + }, + "entity": { + "type": "string", + "enum": [ + "ATTRIBUTE", + "BRAND", + "CATEGORY", + "SKU" + ] + }, + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "ProductSelectionCriteriaRO" + }, + "PromotionConfigRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "expiry": { + "type": "integer", + "format": "int64" + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "promotionType": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "reward": { + "type": "string" + }, + "ruleId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + } + }, + "title": "PromotionConfigRO" + }, + "PromotionExpiryReminderRO": { + "type": "object", + "required": [ + "communicationChannels", + "numberOfDaysBeforeExpiry" + ], + "properties": { + "active": { + "type": "boolean" + }, + "communicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "integer", + "format": "int64" + }, + "numberOfDaysBeforeExpiry": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionExpiryReminderRO" + }, + "PromotionLogRO": { + "type": "object", + "properties": { + "earnedPromotionId": { + "type": "string" + }, + "evaluationStatus": { + "type": "boolean" + }, + "logType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionLogRO" + }, + "PromotionMetaRO": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRO" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRO" + }, + "PromotionMetaROReq": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaROReq" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaROReq" + }, + "PromotionMetaRORes": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRORes" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRORes" + }, + "PromotionRedemptionRO": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "cartEvaluationId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "discount": { + "type": "string" + }, + "discountAppliedQuantity": { + "type": "string" + }, + "id": { + "$ref": "#/definitions/ObjectId" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "productId": { + "type": "integer", + "format": "int64" + }, + "promotionAppliedQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "promotionMessageLabel": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + }, + "redemptionDate": { + "type": "string", + "format": "date-time" + }, + "redemptionTill": { + "type": "integer", + "format": "int64" + }, + "redemptionType": { + "type": "string", + "enum": [ + "CART", + "LINEITEM" + ] + }, + "sku": { + "type": "string" + }, + "transactionEntityIdentifier": { + "type": "string" + }, + "transactionIdentifier": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PromotionRedemptionRO" + }, + "PromotionStrategyRO": { + "type": "object", + "required": [ + "conditionBasedRankingStrategy", + "promotionRankingStrategy", + "rewardStrategy", + "singlePromotionPerLineitem" + ], + "properties": { + "conditionBasedRankingStrategy": { + "type": "string", + "enum": [ + "CART_BASED_FIRST", + "LINE_ITEM_BASED_FIRST" + ] + }, + "isActive": { + "type": "boolean" + }, + "promotionRankingStrategy": { + "type": "string", + "enum": [ + "EXPIRY_BASED", + "MAX_DISCOUNT", + "PRIORITY" + ] + }, + "rewardStrategy": { + "type": "string", + "enum": [ + "NO_STRATEGY", + "PROMOTION_FIRST", + "REWARDS_FIRST" + ] + }, + "singlePromotionPerLineitem": { + "type": "boolean" + } + }, + "title": "PromotionStrategyRO" + }, + "PromotionSummaryRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "lastEarned": { + "type": "integer", + "format": "int64" + }, + "lastRedeemed": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "targetedCustomerCount": { + "type": "integer", + "format": "int64" + }, + "totalDiscount": { + "type": "string" + }, + "totalDiscountAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalEarned": { + "type": "string" + }, + "totalPromotionAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalRedeemed": { + "type": "integer", + "format": "int64" + }, + "totalTransactions": { + "type": "integer", + "format": "int64" + } + }, + "title": "PromotionSummaryRO" + }, + "ResponseWrapper«CartEvaluationRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartEvaluationRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartEvaluationRO»" + }, + "ResponseWrapper«CartRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartRO»" + }, + "ResponseWrapper«CustomerEarnedPromotionRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CustomerEarnedPromotionRO»" + }, + "ResponseWrapper«List«AuditLogVersionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/AuditLogVersionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«AuditLogVersionRO»»" + }, + "ResponseWrapper«List«BulkEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/BulkEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" + }, + "ResponseWrapper«List«CustomMetadataFieldRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomMetadataFieldRO»»" + }, + "ResponseWrapper«List«CustomerPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomerPromotionRO»»" + }, + "ResponseWrapper«List«PromotionConfigRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionConfigRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionConfigRO»»" + }, + "ResponseWrapper«List«PromotionExpiryReminderRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionExpiryReminderRO»»" + }, + "ResponseWrapper«List«PromotionMetaRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionMetaRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionMetaRO»»" + }, + "ResponseWrapper«List«PromotionRedemptionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionRedemptionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionRedemptionRO»»" + }, + "ResponseWrapper«List«PromotionSummaryRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionSummaryRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionSummaryRO»»" + }, + "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + }, + "ResponseWrapper«PromotionExpiryReminderRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionExpiryReminderRO»" + }, + "ResponseWrapper«PromotionMetaRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionMetaRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionMetaRO»" + }, + "ResponseWrapper«PromotionStrategyRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionStrategyRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionStrategyRO»" + }, + "ResponseWrapper«boolean»": { + "type": "object", + "properties": { + "data": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«boolean»" + }, + "ResponseWrapper«object»": { + "type": "object", + "properties": { + "data": { + "type": "object" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«object»" + }, + "RestrictionKPIRO": { + "type": "object", + "properties": { + "frequency": { + "type": "string", + "enum": [ + "DAYS", + "WEEKS" + ] + }, + "kpi": { + "type": "string", + "enum": [ + "DISCOUNT", + "REDEMPTION", + "TRANSACTION" + ] + }, + "limit": { + "type": "string" + }, + "minTimeBetweenRepeat": { + "type": "integer", + "format": "int64" + } + }, + "title": "RestrictionKPIRO" + }, + "StoreCriteria": { + "type": "object", + "required": [ + "operator", + "type", + "values" + ], + "properties": { + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "type": { + "type": "string", + "enum": [ + "CONCEPT", + "STORE", + "ZONE" + ] + }, + "values": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + "title": "StoreCriteria" + }, + "TimeCriteria": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTime" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteria" + }, + "TimeCriteriaReq": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeReq" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteriaReq" + }, + "TimeCriteriaRes": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeRes" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteriaRes" + } + } +} From 74cbd786958df4776e51bcabbe91e57b01c543a2 Mon Sep 17 00:00:00 2001 From: Vishak Udupa Date: Thu, 22 Jul 2021 10:17:15 +0530 Subject: [PATCH 120/150] Update swagger_sdk_gen_promotion_engine.sh --- swagger_sdk_gen_promotion_engine.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen_promotion_engine.sh b/swagger_sdk_gen_promotion_engine.sh index 92d05ca1241..4c9054b5566 100644 --- a/swagger_sdk_gen_promotion_engine.sh +++ b/swagger_sdk_gen_promotion_engine.sh @@ -13,7 +13,7 @@ then -l java \ -DdateLibrary=java11 \ -o promotion_engine/java_client/java \ - -c config.json --group-id com.capillary.coupongateway --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk + -c config.json --group-id com.capillary.promotion.engine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . mvn3 clean deploy -f promotion_engine/java_client/java/pom.xml fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_promotion_engine" From 5c6a0647b61aad59ac5cacf6fbb818a5c0f5377f Mon Sep 17 00:00:00 2001 From: Vishak Udupa Date: Tue, 30 Nov 2021 14:41:14 +0530 Subject: [PATCH 121/150] Update promotion-engine.json --- promotion-engine.json | 8171 ++++++++++++++++++++++------------------- 1 file changed, 4392 insertions(+), 3779 deletions(-) diff --git a/promotion-engine.json b/promotion-engine.json index 6e6db4df2b4..c66f09bc51d 100644 --- a/promotion-engine.json +++ b/promotion-engine.json @@ -1,3812 +1,4425 @@ { - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "host": "localhost:64373", - "basePath": "/", - "tags": [ - { - "name": "audit-log-resource", - "description": "Audit Log Resource" - }, - { - "name": "cart-evaluation-log-resource", - "description": "Cart Evaluation Log Resource" - }, - { - "name": "health-check-resource", - "description": "Health Check Resource" - }, - { - "name": "promotion-communication-resource", - "description": "Promotion Communication Resource" - }, - { - "name": "promotion-earning-management-resource", - "description": "Promotion Earning Management Resource" - }, - { - "name": "promotion-earning-resource", - "description": "Promotion Earning Resource" - }, - { - "name": "promotion-meta-resource", - "description": "Promotion Meta Resource" - }, - { - "name": "promotion-redemption-resource", - "description": "Promotion Redemption Resource" - }, - { - "name": "promotion-resource", - "description": "Promotion Resource" - }, - { - "name": "promotion-settings-resource", - "description": "Promotion Settings Resource" - } - ], - "paths": { - "/health/isalive": { - "get": { - "tags": [ - "health-check-resource" - ], - "summary": "isAlive", - "operationId": "isAliveUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "promotion-engine-api.crm-nightly-new.cc.capillarytech.com", + "basePath": "/", + "tags": [ + { + "name": "audit-log-resource", + "description": "Audit Log Resource" + }, + { + "name": "cart-evaluation-log-resource", + "description": "Cart Evaluation Log Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "promotion-communication-resource", + "description": "Promotion Communication Resource" + }, + { + "name": "promotion-earning-management-resource", + "description": "Promotion Earning Management Resource" + }, + { + "name": "promotion-earning-resource", + "description": "Promotion Earning Resource" + }, + { + "name": "promotion-language-resource", + "description": "Promotion Language Resource" + }, + { + "name": "promotion-meta-resource", + "description": "Promotion Meta Resource" + }, + { + "name": "promotion-redemption-resource", + "description": "Promotion Redemption Resource" + }, + { + "name": "promotion-resource", + "description": "Promotion Resource" + }, + { + "name": "promotion-settings-resource", + "description": "Promotion Settings Resource" + } + ], + "paths": { + "/health/isalive": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "isAlive", + "operationId": "isAliveUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" } - }, - "/v1/management/promotions": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getAllPromotionConfigs", - "operationId": "getAllPromotionConfigsUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "createPromotionConfig", - "operationId": "createPromotionConfigUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotion", - "description": "promotion", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionMetaROReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getAllPromotionConfigs", + "operationId": "getAllPromotionConfigsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "campaignId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "loyaltyProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "partnerProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "programType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + }, + { + "name": "promotionType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ID", + "NAME", + "START_DATE" + ] + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" } - }, - "/v1/management/promotions/auditLogs/versions": { - "get": { - "tags": [ - "audit-log-resource" - ], - "summary": "getAuditLogVersions", - "operationId": "getAuditLogVersionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "endDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "entityId", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "entityType", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "PROMOTION_EXPIRY_REMINDER", - "PROMOTION_META", - "PROMOTION_SETTING" - ] - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«AuditLogVersionRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "createPromotionConfig", + "operationId": "createPromotionConfigUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" } - }, - "/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}": { - "get": { - "tags": [ - "audit-log-resource" - ], - "summary": "getAuditLogEntity", - "operationId": "getAuditLogEntityUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "entityId", - "in": "path", - "description": "entityId", - "required": true, - "type": "string" - }, - { - "name": "entityType", - "in": "path", - "description": "entityType", - "required": true, - "type": "string", - "enum": [ - "PROMOTION_EXPIRY_REMINDER", - "PROMOTION_META", - "PROMOTION_SETTING" - ] - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«object»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" } - }, - "/v1/management/promotions/evaluationLogs/{evaluationId}": { - "get": { - "tags": [ - "cart-evaluation-log-resource" - ], - "summary": "getEvaluationLogs", - "operationId": "getEvaluationLogsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "evaluationId", - "in": "path", - "description": "evaluationId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CartEvaluationRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/auditLogs/versions": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogVersions", + "operationId": "getAuditLogVersionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«AuditLogVersionRO»»" } - }, - "/v1/management/promotions/filters": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getFilteredPromotions", - "operationId": "getFilteredPromotionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "active", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "campaignId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "name", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "promotionType", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ID", - "NAME", - "START_DATE" - ] - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionSummaryRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogEntity", + "operationId": "getAuditLogEntityUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "entityId", + "in": "path", + "description": "entityId", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "path", + "description": "entityType", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«object»" } - }, - "/v1/management/promotions/settings/custom_field": { - "get": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "getPromotionCustomFields", - "operationId": "getPromotionCustomFieldsUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "savePromotionCustomFields", - "operationId": "savePromotionCustomFieldsUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "customMetadataFields", - "description": "customMetadataFields", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomMetadataFieldRO" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/evaluationLogs/{evaluationId}": { + "get": { + "tags": [ + "cart-evaluation-log-resource" + ], + "summary": "getEvaluationLogs", + "operationId": "getEvaluationLogsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "evaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartEvaluationRO»" } - }, - "/v1/management/promotions/settings/strategy": { - "get": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "getPromotionStrategy", - "operationId": "getPromotionStrategyUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "savePromotionStrategy", - "operationId": "savePromotionStrategyUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotionStrategy", - "description": "promotionStrategy", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionStrategyRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/filters": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getFilteredPromotions", + "operationId": "getFilteredPromotionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "campaignId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "loyaltyProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "partnerProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "programType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + }, + { + "name": "promotionType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ID", + "NAME", + "START_DATE" + ] + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionSummaryRO»»" } - }, - "/v1/management/promotions/{promotionId}": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getPromotionConfig", - "operationId": "getPromotionConfigUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/language": { + "get": { + "tags": [ + "promotion-language-resource" + ], + "summary": "getMultiLanguageDetails", + "operationId": "getMultiLanguageDetailsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "entity", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_META" + ] + }, + { + "name": "entityId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "languageCodes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" }, - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "updatePromotionConfig", - "operationId": "updatePromotionConfigUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotion", - "description": "promotion", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionMetaROReq" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" } - }, - "/v1/management/promotions/{promotionId}/activate": { - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "activatePromotion", - "operationId": "activatePromotionUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-language-resource" + ], + "summary": "saveMultiLanguageDetails", + "operationId": "saveMultiLanguageDetailsUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionLanguageRO", + "description": "promotionLanguageRO", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionLanguageRO" } - }, - "/v1/management/promotions/{promotionId}/deactivate": { - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "deactivatePromotion", - "operationId": "deactivatePromotionUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" } - }, - "/v1/management/promotions/{promotionId}/expiryReminders": { - "get": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "getPromotionExpiryReminders", - "operationId": "getPromotionExpiryRemindersUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionExpiryReminderRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "createPromotionExpiryReminder", - "operationId": "createPromotionExpiryReminderUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotionExpiryReminder", - "description": "promotionExpiryReminder", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/settings/custom_field": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionCustomFields", + "operationId": "getPromotionCustomFieldsUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}": { - "get": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "getPromotionExpiryReminder", - "operationId": "getPromotionExpiryReminderUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "updatePromotionExpiryReminder", - "operationId": "updatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "promotionExpiryReminder", - "description": "promotionExpiryReminder", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionCustomFields", + "operationId": "savePromotionCustomFieldsUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customMetadataFields", + "description": "customMetadataFields", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/activate": { - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "activatePromotionExpiryReminder", - "operationId": "activatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/deactivate": { - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "deactivatePromotionExpiryReminder", - "operationId": "deactivatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/settings/strategy": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionStrategy", + "operationId": "getPromotionStrategyUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" } - }, - "/v1/management/promotions/{promotionId}/issueBulk": { - "post": { - "tags": [ - "promotion-earning-management-resource" - ], - "summary": "issuePromotionsInBulk", - "operationId": "issuePromotionsInBulkUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "contextId", - "in": "query", - "description": "contextId", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "customerIds", - "description": "customerIds", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionStrategy", + "operationId": "savePromotionStrategyUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionStrategy", + "description": "promotionStrategy", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionStrategyRO" } - }, - "/v1/promotions/config": { - "get": { - "tags": [ - "promotion-resource" - ], - "summary": "getPromotionConfig", - "operationId": "getPromotionConfigUsingGET_1", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "includeExpired", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "includeInactive", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "promotionIds", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionConfigRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" } - }, - "/v1/promotions/customer/{customerId}": { - "get": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "getAllForCustomer", - "operationId": "getAllForCustomerUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "description": "customerId", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "entityId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "includeExpired", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "EVENT_TIME", - "VALID_TILL" - ] - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomerPromotionRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" } - }, - "/v1/promotions/earn/bulk": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "bulkEarnPromotion", - "operationId": "bulkEarnPromotionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "bulkEarnRO", - "description": "bulkEarnRO", - "required": true, - "schema": { - "$ref": "#/definitions/BulkEarnRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«BulkEarnedPromotionRO»»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "updatePromotionConfig", + "operationId": "updatePromotionConfigUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" } - }, - "/v1/promotions/evaluate": { - "post": { - "tags": [ - "promotion-redemption-resource" - ], - "summary": "evaluatePromotionOnCart", - "operationId": "evaluatePromotionOnCartUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "cart", - "description": "cart", - "required": true, - "schema": { - "$ref": "#/definitions/CartRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CartRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" } - }, - "/v1/promotions/redemptions": { - "get": { - "tags": [ - "promotion-redemption-resource" - ], - "summary": "getRedemptions", - "operationId": "getRedemptionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "promotionId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "REDEMPTION_DATE" - ] - }, - { - "name": "transactionEntityIdentifier", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "transactionIdentifier", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/activate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "activatePromotion", + "operationId": "activatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" } - }, - "/v1/promotions/till/{tillId}": { - "get": { - "tags": [ - "promotion-resource" - ], - "summary": "getAllActivePosPromotionForTill", - "operationId": "getAllActivePosPromotionForTillUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "tillId", - "in": "path", - "description": "tillId", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/deactivate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "deactivatePromotion", + "operationId": "deactivatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" } - }, - "/v1/promotions/{promotionId}/activate": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "activate", - "operationId": "activateUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "description": "customerId", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminders", + "operationId": "getPromotionExpiryRemindersUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionExpiryReminderRO»»" } - }, - "/v1/promotions/{promotionId}/deactivate": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "deactivate", - "operationId": "deactivateUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "description": "customerId", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "createPromotionExpiryReminder", + "operationId": "createPromotionExpiryReminderUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" } - }, - "/v1/promotions/{promotionId}/earn": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "earnPromotion", - "operationId": "earnPromotionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "customerEarnedPromotion", - "description": "customerEarnedPromotion", - "required": true, - "schema": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } } + } }, - "definitions": { - "Action": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "cartBasedAction": { - "$ref": "#/definitions/CartBasedAction" - }, - "fixedPriceAction": { - "$ref": "#/definitions/FixedPriceAction" - }, - "freeProductAction": { - "$ref": "#/definitions/FreeProductAction" - }, - "productBasedAction": { - "$ref": "#/definitions/ProductBasedAction" - }, - "type": { - "type": "string", - "enum": [ - "CART_BASED", - "FIXED_PRICE", - "FREE_PRODUCT", - "PRODUCT_BASED" - ] - } - }, - "title": "Action" - }, - "ApiError": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int64" - }, - "message": { - "type": "string" - } - }, - "title": "ApiError" - }, - "AppliedPromotionRO": { - "type": "object", - "properties": { - "discount": { - "type": "string" - }, - "discountAppliedOnQuantity": { - "type": "string" - }, - "earnedPromotionId": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "messageLabel": { - "type": "string" - }, - "name": { - "type": "string" - }, - "promotionAppliedOnQuantity": { - "type": "string" - }, - "promotionId": { - "type": "string" - }, - "redemptionCount": { - "type": "integer", - "format": "int64" - } - }, - "title": "AppliedPromotionRO" - }, - "AuditLogVersionRO": { - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "triggeredBy": { - "type": "integer", - "format": "int64" - }, - "triggeredOn": { - "type": "integer", - "format": "int64" - }, - "version": { - "type": "string" - } - }, - "title": "AuditLogVersionRO" - }, - "BulkEarnRO": { - "type": "object", - "required": [ - "customerId", - "earnedFromType", - "eventDetails", - "eventTime" - ], - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "earnedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/EarnedPromotion" - } - }, - "eventDetails": { - "$ref": "#/definitions/EventDetailsRO" - }, - "eventTime": { - "type": "integer", - "format": "int64" - }, - "orgId": { - "type": "integer", - "format": "int64" - } - }, - "title": "BulkEarnRO" - }, - "BulkEarnedPromotionRO": { - "type": "object", - "properties": { - "customerEarnedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - } - }, - "earnedFromId": { - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/ErrorDetails" - }, - "failedEarnCount": { - "type": "integer", - "format": "int32" - }, - "successfulEarnCount": { - "type": "integer", - "format": "int32" - } - }, - "title": "BulkEarnedPromotionRO" - }, - "CartBasedAction": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ABSOLUTE", - "PERCENTAGE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "CartBasedAction" - }, - "CartCondition": { - "type": "object", - "required": [ - "kpi", - "operator", - "value" - ], - "properties": { - "kpi": { - "type": "string", - "enum": [ - "ITEMCOUNT", - "SUBTOTAL" - ] - }, - "operator": { - "type": "string", - "enum": [ - "EQUALS", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "IN", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "NONE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "CartCondition" - }, - "CartEvaluationRO": { - "type": "object", - "properties": { - "createdOn": { - "type": "string", - "format": "date-time" - }, - "evaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionLogRO" - } - }, - "id": { - "type": "string" - }, - "isRedeemed": { - "type": "boolean" - } - }, - "title": "CartEvaluationRO" - }, - "CartItemRO": { - "type": "object", - "required": [ - "amount", - "qty", - "sku" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "brandList": { - "type": "array", - "items": { - "type": "string" - } - }, - "categoryList": { - "type": "array", - "items": { - "type": "string" - } - }, - "discount": { - "type": "string" - }, - "qty": { - "type": "string" - }, - "referenceId": { - "type": "string" - }, - "sku": { - "type": "string" - } - }, - "title": "CartItemRO" - }, - "CartRO": { - "type": "object", - "required": [ - "amount", - "cartItems", - "customerId" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "cartItems": { - "type": "array", - "items": { - "$ref": "#/definitions/CartItemRO" - } - }, - "categoryHierarchySentInPayload": { - "type": "boolean" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "evaluationId": { - "type": "string" - } - }, - "title": "CartRO" - }, - "ComboProductConditionRO": { - "type": "object", - "required": [ - "productConditions" - ], - "properties": { - "productConditions": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductCondition" - } - } - }, - "title": "ComboProductConditionRO" - }, - "CommunicationChannelRO": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "channelType": { - "type": "string", - "enum": [ - "ANDROID", - "EMAIL", - "IOS", - "SMS" - ] - }, - "domainPropertyId": { - "type": "string" - }, - "message": { - "type": "string" - }, - "senderCDMA": { - "type": "string" - }, - "senderEmail": { - "type": "string" - }, - "senderGSM": { - "type": "string" - }, - "senderLabel": { - "type": "string" - }, - "senderReplyToEmail": { - "type": "string" - }, - "subject": { - "type": "string" - }, - "unsubscribeLabel": { - "type": "string" - } - }, - "title": "CommunicationChannelRO" - }, - "Condition": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "cartCondition": { - "$ref": "#/definitions/CartCondition" - }, - "comboProductCondition": { - "$ref": "#/definitions/ComboProductConditionRO" - }, - "productCondition": { - "$ref": "#/definitions/ProductCondition" - }, - "type": { - "type": "string", - "enum": [ - "CART", - "COMBO_PRODUCT", - "PRODUCT" - ] - } - }, - "title": "Condition" - }, - "CustomMetadataFieldRO": { - "type": "object", - "required": [ - "dataType", - "fieldName" - ], - "properties": { - "dataType": { - "type": "string", - "enum": [ - "DATE", - "NUMBER", - "STRING" - ] - }, - "fieldName": { - "type": "string" - }, - "isRequired": { - "type": "boolean" - } - }, - "title": "CustomMetadataFieldRO" - }, - "CustomerEarnedPromotionRO": { - "type": "object", - "required": [ - "customerId", - "earnedFromId", - "earnedFromType", - "eventDetails", - "eventTime" - ], - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromId": { - "type": "string" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "eventDetails": { - "$ref": "#/definitions/EventDetailsRO" - }, - "eventTime": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "promotionId": { - "type": "string" - }, - "validTill": { - "type": "integer", - "format": "int64" - } - }, - "title": "CustomerEarnedPromotionRO" - }, - "CustomerPromotionRO": { - "type": "object", - "properties": { - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromId": { - "type": "string" - }, - "earnedStatus": { - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED" - ] - }, - "earnedType": { - "type": "string", - "enum": [ - "MILESTONE_EARN", - "NONE", - "REWARD", - "SINGLE_ACTIVITY_EARN" - ] - }, - "mileStoneId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - }, - "unlockedDate": { - "type": "integer", - "format": "int64" - }, - "validTill": { - "type": "integer", - "format": "int64" - } - }, - "title": "CustomerPromotionRO" - }, - "Duration": { - "type": "object", - "properties": { - "period": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string", - "enum": [ - "DAYS", - "HOURS", - "MINUTES" - ] - } - }, - "title": "Duration" - }, - "EarnedPromotion": { - "type": "object", - "required": [ - "earnCount", - "earnedFromId", - "promotionId" - ], - "properties": { - "earnCount": { - "type": "integer", - "format": "int32" - }, - "earnedFromId": { - "type": "string" - }, - "promotionId": { - "type": "string" - } - }, - "title": "EarnedPromotion" - }, - "EarningCriteriaRO": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteria" - } - }, - "title": "EarningCriteriaRO" - }, - "EarningCriteriaROReq": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaReq" - } - }, - "title": "EarningCriteriaROReq" - }, - "EarningCriteriaRORes": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaRes" - } - }, - "title": "EarningCriteriaRORes" - }, - "ErrorDetails": { - "type": "object", - "properties": { - "errorCode": { - "type": "integer", - "format": "int64" - }, - "errorMessages": { - "type": "string" - } - }, - "title": "ErrorDetails" - }, - "EventDetailsRO": { - "type": "object", - "properties": { - "eventPayload": { - "type": "object" - }, - "id": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "title": "EventDetailsRO" - }, - "FixedPriceAction": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - }, - "value": { - "type": "string" - } - }, - "title": "FixedPriceAction" - }, - "FreeProductAction": { - "type": "object", - "required": [ - "productBasedCondition" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - } - }, - "title": "FreeProductAction" - }, - "LocalTime": { - "type": "object", - "properties": { - "hour": { - "type": "integer", - "format": "int32" - }, - "minute": { - "type": "integer", - "format": "int32" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "integer", - "format": "int32" - } - }, - "title": "LocalTime" - }, - "LocalTimeReq": { - "type": "object", - "properties": { - "hour": { - "type": "string", - "format": "byte" - }, - "minute": { - "type": "string", - "format": "byte" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "string", - "format": "byte" - } - }, - "title": "LocalTimeReq" - }, - "LocalTimeRes": { - "type": "object", - "properties": { - "hour": { - "type": "integer", - "format": "int32" - }, - "minute": { - "type": "integer", - "format": "int32" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "integer", - "format": "int32" - } - }, - "title": "LocalTimeRes" - }, - "ObjectId": { - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "timestamp": { - "type": "integer", - "format": "int32" - } - }, - "title": "ObjectId" - }, - "ProductBasedAction": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - }, - "type": { - "type": "string", - "enum": [ - "ABSOLUTE", - "PERCENTAGE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "ProductBasedAction" - }, - "ProductCondition": { - "type": "object", - "required": [ - "criteriaList", - "kpi" - ], - "properties": { - "criteriaList": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductSelectionCriteriaRO" - } - }, - "kpi": { - "type": "string", - "enum": [ - "AMOUNT", - "NONE", - "QUANTITY" - ] - }, - "operator": { - "type": "string", - "enum": [ - "EQUALS", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "IN", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "NONE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "ProductCondition" - }, - "ProductSelectionCriteriaRO": { - "type": "object", - "required": [ - "entity", - "values" - ], - "properties": { - "attributeName": { - "type": "string" - }, - "entity": { - "type": "string", - "enum": [ - "ATTRIBUTE", - "BRAND", - "CATEGORY", - "SKU" - ] - }, - "operator": { - "type": "string", - "enum": [ - "IN", - "NOT_IN" - ] - }, - "values": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "ProductSelectionCriteriaRO" - }, - "PromotionConfigRO": { - "type": "object", - "properties": { - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "expiry": { - "type": "integer", - "format": "int64" - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "promotionType": { - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - "reward": { - "type": "string" - }, - "ruleId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - } - }, - "title": "PromotionConfigRO" - }, - "PromotionExpiryReminderRO": { - "type": "object", - "required": [ - "communicationChannels", - "numberOfDaysBeforeExpiry" - ], - "properties": { - "active": { - "type": "boolean" - }, - "communicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "integer", - "format": "int64" - }, - "numberOfDaysBeforeExpiry": { - "type": "integer", - "format": "int32", - "minimum": 0, - "exclusiveMinimum": false - }, - "promotionId": { - "type": "string" - } - }, - "title": "PromotionExpiryReminderRO" - }, - "PromotionLogRO": { - "type": "object", - "properties": { - "earnedPromotionId": { - "type": "string" - }, - "evaluationStatus": { - "type": "boolean" - }, - "logType": { - "type": "string" - }, - "message": { - "type": "string" - }, - "promotionId": { - "type": "string" - } - }, - "title": "PromotionLogRO" - }, - "PromotionMetaRO": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaRO" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "messageLabel": { - "type": "string" - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteria" - }, - "type": { - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaRO" - }, - "PromotionMetaROReq": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaROReq" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "messageLabel": { - "type": "string" - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaReq" - }, - "type": { - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaROReq" - }, - "PromotionMetaRORes": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaRORes" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "messageLabel": { - "type": "string" - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaRes" - }, - "type": { - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaRORes" - }, - "PromotionRedemptionRO": { - "type": "object", - "properties": { - "amount": { - "type": "string" - }, - "cartEvaluationId": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "discount": { - "type": "string" - }, - "discountAppliedQuantity": { - "type": "string" - }, - "id": { - "$ref": "#/definitions/ObjectId" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "productId": { - "type": "integer", - "format": "int64" - }, - "promotionAppliedQuantity": { - "type": "string" - }, - "promotionId": { - "type": "string" - }, - "promotionMessageLabel": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "redemptionCount": { - "type": "integer", - "format": "int64" - }, - "redemptionDate": { - "type": "string", - "format": "date-time" - }, - "redemptionTill": { - "type": "integer", - "format": "int64" - }, - "redemptionType": { - "type": "string", - "enum": [ - "CART", - "LINEITEM" - ] - }, - "sku": { - "type": "string" - }, - "transactionEntityIdentifier": { - "type": "string" - }, - "transactionIdentifier": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - }, - "title": "PromotionRedemptionRO" - }, - "PromotionStrategyRO": { - "type": "object", - "required": [ - "conditionBasedRankingStrategy", - "promotionRankingStrategy", - "rewardStrategy", - "singlePromotionPerLineitem" - ], - "properties": { - "conditionBasedRankingStrategy": { - "type": "string", - "enum": [ - "CART_BASED_FIRST", - "LINE_ITEM_BASED_FIRST" - ] - }, - "isActive": { - "type": "boolean" - }, - "promotionRankingStrategy": { - "type": "string", - "enum": [ - "EXPIRY_BASED", - "MAX_DISCOUNT", - "PRIORITY" - ] - }, - "rewardStrategy": { - "type": "string", - "enum": [ - "NO_STRATEGY", - "PROMOTION_FIRST", - "REWARDS_FIRST" - ] - }, - "singlePromotionPerLineitem": { - "type": "boolean" - } - }, - "title": "PromotionStrategyRO" - }, - "PromotionSummaryRO": { - "type": "object", - "properties": { - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "lastEarned": { - "type": "integer", - "format": "int64" - }, - "lastRedeemed": { - "type": "integer", - "format": "int64" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionType": { - "type": "string", - "enum": [ - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "targetedCustomerCount": { - "type": "integer", - "format": "int64" - }, - "totalDiscount": { - "type": "string" - }, - "totalDiscountAppliedQuantity": { - "type": "number", - "format": "double" - }, - "totalEarned": { - "type": "string" - }, - "totalPromotionAppliedQuantity": { - "type": "number", - "format": "double" - }, - "totalRedeemed": { - "type": "integer", - "format": "int64" - }, - "totalTransactions": { - "type": "integer", - "format": "int64" - } - }, - "title": "PromotionSummaryRO" - }, - "ResponseWrapper«CartEvaluationRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CartEvaluationRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CartEvaluationRO»" - }, - "ResponseWrapper«CartRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CartRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CartRO»" - }, - "ResponseWrapper«CustomerEarnedPromotionRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CustomerEarnedPromotionRO»" - }, - "ResponseWrapper«List«AuditLogVersionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/AuditLogVersionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«AuditLogVersionRO»»" - }, - "ResponseWrapper«List«BulkEarnedPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/BulkEarnedPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" - }, - "ResponseWrapper«List«CustomMetadataFieldRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomMetadataFieldRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CustomMetadataFieldRO»»" - }, - "ResponseWrapper«List«CustomerPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CustomerPromotionRO»»" - }, - "ResponseWrapper«List«PromotionConfigRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionConfigRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionConfigRO»»" - }, - "ResponseWrapper«List«PromotionExpiryReminderRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionExpiryReminderRO»»" - }, - "ResponseWrapper«List«PromotionMetaRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionMetaRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionMetaRO»»" - }, - "ResponseWrapper«List«PromotionRedemptionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionRedemptionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionRedemptionRO»»" - }, - "ResponseWrapper«List«PromotionSummaryRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionSummaryRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionSummaryRO»»" - }, - "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" - }, - "ResponseWrapper«PromotionExpiryReminderRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionExpiryReminderRO»" - }, - "ResponseWrapper«PromotionMetaRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionMetaRORes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionMetaRO»" - }, - "ResponseWrapper«PromotionStrategyRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionStrategyRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionStrategyRO»" - }, - "ResponseWrapper«boolean»": { - "type": "object", - "properties": { - "data": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«boolean»" - }, - "ResponseWrapper«object»": { - "type": "object", - "properties": { - "data": { - "type": "object" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«object»" - }, - "RestrictionKPIRO": { - "type": "object", - "properties": { - "frequency": { - "type": "string", - "enum": [ - "DAYS", - "WEEKS" - ] - }, - "kpi": { - "type": "string", - "enum": [ - "DISCOUNT", - "REDEMPTION", - "TRANSACTION" - ] - }, - "limit": { - "type": "string" - }, - "minTimeBetweenRepeat": { - "type": "integer", - "format": "int64" - } - }, - "title": "RestrictionKPIRO" - }, - "StoreCriteria": { - "type": "object", - "required": [ - "operator", - "type", - "values" - ], - "properties": { - "operator": { - "type": "string", - "enum": [ - "IN", - "NOT_IN" - ] - }, - "type": { - "type": "string", - "enum": [ - "CONCEPT", - "STORE", - "ZONE" - ] - }, - "values": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - }, - "title": "StoreCriteria" - }, - "TimeCriteria": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTime" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } - } - }, - "title": "TimeCriteria" - }, - "TimeCriteriaReq": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTimeReq" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } - } - }, - "title": "TimeCriteriaReq" - }, - "TimeCriteriaRes": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTimeRes" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } - } + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminder", + "operationId": "getPromotionExpiryReminderUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "updatePromotionExpiryReminder", + "operationId": "updatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/activate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "activatePromotionExpiryReminder", + "operationId": "activatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/deactivate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "deactivatePromotionExpiryReminder", + "operationId": "deactivatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/management/promotions/{promotionId}/issueBulk": { + "post": { + "tags": [ + "promotion-earning-management-resource" + ], + "summary": "issuePromotionsInBulk", + "operationId": "issuePromotionsInBulkUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "contextId", + "in": "query", + "description": "contextId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "customerIds", + "description": "customerIds", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/config": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET_1", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "promotionIds", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" }, - "title": "TimeCriteriaRes" + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionConfigRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/customer/{customerId}": { + "get": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "getAllForCustomer", + "operationId": "getAllForCustomerUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "path", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EVENT_TIME", + "VALID_TILL" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomerPromotionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/earn/bulk": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "bulkEarnPromotion", + "operationId": "bulkEarnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "bulkEarnRO", + "description": "bulkEarnRO", + "required": true, + "schema": { + "$ref": "#/definitions/BulkEarnRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«BulkEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/evaluate": { + "post": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "evaluatePromotionOnCart", + "operationId": "evaluatePromotionOnCartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "cart", + "description": "cart", + "required": true, + "schema": { + "$ref": "#/definitions/CartRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/redemptions": { + "get": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "getRedemptions", + "operationId": "getRedemptionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "promotionId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "REDEMPTION_DATE" + ] + }, + { + "name": "transactionEntityIdentifier", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "transactionIdentifier", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/revokeEarn": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "revokeEarn", + "operationId": "revokeEarnUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "revokeEarnRequest", + "description": "revokeEarnRequest", + "required": true, + "schema": { + "$ref": "#/definitions/RevokeEarnRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/till/{tillId}": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getAllActivePosPromotionForTill", + "operationId": "getAllActivePosPromotionForTillUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "tillId", + "in": "path", + "description": "tillId", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/activate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "activate", + "operationId": "activateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/deactivate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "deactivate", + "operationId": "deactivateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/promotions/{promotionId}/earn": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "earnPromotion", + "operationId": "earnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customerEarnedPromotion", + "description": "customerEarnedPromotion", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + } + }, + "definitions": { + "Action": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartBasedAction": { + "$ref": "#/definitions/CartBasedAction" + }, + "fixedPriceAction": { + "$ref": "#/definitions/FixedPriceAction" + }, + "freeProductAction": { + "$ref": "#/definitions/FreeProductAction" + }, + "productBasedAction": { + "$ref": "#/definitions/ProductBasedAction" + }, + "type": { + "type": "string", + "enum": [ + "CART_BASED", + "FIXED_PRICE", + "FREE_PRODUCT", + "PRODUCT_BASED" + ] + } + }, + "title": "Action" + }, + "ApiError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "message": { + "type": "string" + } + }, + "title": "ApiError" + }, + "AppliedPromotionRO": { + "type": "object", + "properties": { + "discount": { + "type": "string" + }, + "discountAppliedOnQuantity": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string" + }, + "promotionAppliedOnQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + } + }, + "title": "AppliedPromotionRO" + }, + "AuditLogVersionRO": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "triggeredBy": { + "type": "integer", + "format": "int64" + }, + "triggeredOn": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + } + }, + "title": "AuditLogVersionRO" + }, + "BulkEarnRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnedPromotion" + } + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + } + }, + "title": "BulkEarnRO" + }, + "BulkEarnedPromotionRO": { + "type": "object", + "properties": { + "customerEarnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "earnedFromId": { + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/ErrorDetails" + }, + "failedEarnCount": { + "type": "integer", + "format": "int32" + }, + "promotionId": { + "type": "string" + }, + "successfulEarnCount": { + "type": "integer", + "format": "int32" + } + }, + "title": "BulkEarnedPromotionRO" + }, + "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/RevokeEarnResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnRevokeError" + } + } + }, + "title": "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" + }, + "CartBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartBasedAction" + }, + "CartCondition": { + "type": "object", + "required": [ + "kpi", + "operator", + "value" + ], + "properties": { + "kpi": { + "type": "string", + "enum": [ + "ITEMCOUNT", + "SUBTOTAL" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartCondition" + }, + "CartEvaluationRO": { + "type": "object", + "properties": { + "createdOn": { + "type": "string", + "format": "date-time" + }, + "evaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionLogRO" + } + }, + "id": { + "type": "string" + }, + "isRedeemed": { + "type": "boolean" + } + }, + "title": "CartEvaluationRO" + }, + "CartItemRO": { + "type": "object", + "required": [ + "amount", + "qty", + "sku" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "brandList": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryList": { + "type": "array", + "items": { + "type": "string" + } + }, + "discount": { + "type": "string" + }, + "qty": { + "type": "string" + }, + "referenceId": { + "type": "string" + }, + "sku": { + "type": "string" + } + }, + "title": "CartItemRO" + }, + "CartRO": { + "type": "object", + "required": [ + "amount", + "cartItems", + "customerId" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "evaluationId": { + "type": "string" + } + }, + "title": "CartRO" + }, + "ComboProductConditionRO": { + "type": "object", + "required": [ + "productConditions" + ], + "properties": { + "productConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductCondition" + } + } + }, + "title": "ComboProductConditionRO" + }, + "CommunicationChannelRO": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "channelType": { + "type": "string", + "enum": [ + "ANDROID", + "EMAIL", + "IOS", + "SMS" + ] + }, + "domainPropertyId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "pushNotificationCta": { + "$ref": "#/definitions/PushNotificationCta" + }, + "senderCDMA": { + "type": "string" + }, + "senderEmail": { + "type": "string" + }, + "senderGSM": { + "type": "string" + }, + "senderLabel": { + "type": "string" + }, + "senderReplyToEmail": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "unsubscribeLabel": { + "type": "string" + } + }, + "title": "CommunicationChannelRO" + }, + "Condition": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartCondition": { + "$ref": "#/definitions/CartCondition" + }, + "comboProductCondition": { + "$ref": "#/definitions/ComboProductConditionRO" + }, + "productCondition": { + "$ref": "#/definitions/ProductCondition" + }, + "type": { + "type": "string", + "enum": [ + "CART", + "COMBO_PRODUCT", + "PRODUCT" + ] + } + }, + "title": "Condition" + }, + "CustomMetadataFieldRO": { + "type": "object", + "required": [ + "dataType", + "fieldName" + ], + "properties": { + "dataType": { + "type": "string", + "enum": [ + "DATE", + "NUMBER", + "STRING" + ] + }, + "fieldName": { + "type": "string" + }, + "isRequired": { + "type": "boolean" + } + }, + "title": "CustomMetadataFieldRO" + }, + "CustomerEarnedPromotionRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerEarnedPromotionRO" + }, + "CustomerPromotionRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "earnedStatus": { + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED" + ] + }, + "earnedType": { + "type": "string", + "enum": [ + "MILESTONE_EARN", + "NONE", + "REWARD", + "SINGLE_ACTIVITY_EARN", + "SUBSCRIPTION", + "TIER" + ] + }, + "mileStoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "unlockedDate": { + "type": "integer", + "format": "int64" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerPromotionRO" + }, + "DecimalRoundingStrategy": { + "type": "object", + "properties": { + "decimalPlaces": { + "type": "integer", + "format": "int32" + }, + "roundingMode": { + "type": "string", + "enum": [ + "CEILING", + "DOWN", + "FLOOR", + "HALF_DOWN", + "HALF_EVEN", + "HALF_UP", + "UNNECESSARY", + "UP" + ] + } + }, + "title": "DecimalRoundingStrategy" + }, + "Duration": { + "type": "object", + "properties": { + "period": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "DAYS", + "HOURS", + "MINUTES" + ] + } + }, + "title": "Duration" + }, + "EarnRevokeDetail": { + "type": "object", + "required": [ + "promotionId" + ], + "properties": { + "earnIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnRevokeDetail" + }, + "EarnRevokeError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "earnIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnRevokeError" + }, + "EarnedPromotion": { + "type": "object", + "required": [ + "earnCount", + "earnedFromId", + "promotionId" + ], + "properties": { + "earnCount": { + "type": "integer", + "format": "int32" + }, + "earnedFromId": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnedPromotion" + }, + "EarningCriteriaRO": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + } + }, + "title": "EarningCriteriaRO" + }, + "EarningCriteriaROReq": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + } + }, + "title": "EarningCriteriaROReq" + }, + "EarningCriteriaRORes": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + } + }, + "title": "EarningCriteriaRORes" + }, + "ErrorDetails": { + "type": "object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int64" + }, + "errorMessages": { + "type": "string" + } + }, + "title": "ErrorDetails" + }, + "EventDetailsRO": { + "type": "object", + "properties": { + "eventPayload": { + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "title": "EventDetailsRO" + }, + "FixedPriceAction": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "value": { + "type": "string" + } + }, + "title": "FixedPriceAction" + }, + "FreeProductAction": { + "type": "object", + "required": [ + "productBasedCondition" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + } + }, + "title": "FreeProductAction" + }, + "LanguageDescription": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOM", + "STANDARD" + ] + }, + "value": { + "type": "string" + } + }, + "title": "LanguageDescription" + }, + "LocalTime": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTime" + }, + "LocalTimeReq": { + "type": "object", + "properties": { + "hour": { + "type": "string", + "format": "byte" + }, + "minute": { + "type": "string", + "format": "byte" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "string", + "format": "byte" + } + }, + "title": "LocalTimeReq" + }, + "LocalTimeRes": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTimeRes" + }, + "MultiLanguageDetails": { + "type": "object", + "required": [ + "languageCode", + "languageDescriptionList" + ], + "properties": { + "languageCode": { + "type": "string" + }, + "languageDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageDescription" + } + } + }, + "title": "MultiLanguageDetails" + }, + "ProductBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductBasedAction" + }, + "ProductCondition": { + "type": "object", + "required": [ + "criteriaList", + "kpi" + ], + "properties": { + "criteriaList": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductSelectionCriteriaRO" + } + }, + "kpi": { + "type": "string", + "enum": [ + "AMOUNT", + "NONE", + "QUANTITY" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductCondition" + }, + "ProductSelectionCriteriaRO": { + "type": "object", + "required": [ + "entity", + "values" + ], + "properties": { + "attributeName": { + "type": "string" + }, + "entity": { + "type": "string", + "enum": [ + "ATTRIBUTE", + "BRAND", + "CATEGORY", + "SKU" + ] + }, + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "ProductSelectionCriteriaRO" + }, + "PromotionConfigRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "expiry": { + "type": "integer", + "format": "int64" + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "promotionType": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "reward": { + "type": "string" + }, + "ruleId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + } + }, + "title": "PromotionConfigRO" + }, + "PromotionExpiryReminderRO": { + "type": "object", + "required": [ + "communicationChannels", + "numberOfDaysBeforeExpiry" + ], + "properties": { + "active": { + "type": "boolean" + }, + "communicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "integer", + "format": "int64" + }, + "numberOfDaysBeforeExpiry": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionExpiryReminderRO" + }, + "PromotionLanguageRO": { + "type": "object", + "required": [ + "entity", + "entityId", + "multiLanguageDetails" + ], + "properties": { + "entity": { + "type": "string", + "enum": [ + "PROMOTION_META" + ] + }, + "entityId": { + "type": "string" + }, + "multiLanguageDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiLanguageDetails" + } + } + }, + "title": "PromotionLanguageRO" + }, + "PromotionLogRO": { + "type": "object", + "properties": { + "earnedPromotionId": { + "type": "string" + }, + "evaluationStatus": { + "type": "boolean" + }, + "logType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionLogRO" + }, + "PromotionMetaRO": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRO" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRO" + }, + "PromotionMetaROReq": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaROReq" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaROReq" + }, + "PromotionMetaRORes": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRORes" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRORes" + }, + "PromotionRedemptionRO": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "cartEvaluationId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "discount": { + "type": "string" + }, + "discountAppliedQuantity": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "productId": { + "type": "integer", + "format": "int64" + }, + "promotionAppliedQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "promotionMessageLabel": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + }, + "redemptionDate": { + "type": "string", + "format": "date-time" + }, + "redemptionTill": { + "type": "integer", + "format": "int64" + }, + "redemptionType": { + "type": "string", + "enum": [ + "CART", + "LINEITEM" + ] + }, + "sku": { + "type": "string" + }, + "taxEntityId": { + "type": "string" + }, + "transactionEntityIdentifier": { + "type": "string" + }, + "transactionIdentifier": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PromotionRedemptionRO" + }, + "PromotionStrategyRO": { + "type": "object", + "required": [ + "conditionBasedRankingStrategy", + "promotionRankingStrategies", + "rewardStrategy", + "singlePromotionPerLineitem" + ], + "properties": { + "conditionBasedRankingStrategy": { + "type": "string", + "enum": [ + "CART_BASED_FIRST", + "LINE_ITEM_BASED_FIRST" + ] + }, + "decimalRoundingStrategy": { + "$ref": "#/definitions/DecimalRoundingStrategy" + }, + "isActive": { + "type": "boolean" + }, + "promotionRankingStrategies": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "EXPIRY_BASED", + "MAX_DISCOUNT", + "PRIORITY" + ] + } + }, + "rewardStrategy": { + "type": "string", + "enum": [ + "NO_STRATEGY", + "PROMOTION_FIRST", + "REWARDS_FIRST" + ] + }, + "singlePromotionPerLineitem": { + "type": "boolean" + } + }, + "title": "PromotionStrategyRO" + }, + "PromotionSummaryRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "lastEarned": { + "type": "integer", + "format": "int64" + }, + "lastRedeemed": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "targetedCustomerCount": { + "type": "integer", + "format": "int64" + }, + "totalDiscount": { + "type": "string" + }, + "totalDiscountAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalEarned": { + "type": "string" + }, + "totalPromotionAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalRedeemed": { + "type": "integer", + "format": "int64" + }, + "totalTransactions": { + "type": "integer", + "format": "int64" + } + }, + "title": "PromotionSummaryRO" + }, + "PushNotificationCta": { + "type": "object", + "properties": { + "actionLink": { + "type": "string" + }, + "image": { + "type": "string" + }, + "pushNotificationCtaActionList": { + "type": "array", + "items": { + "$ref": "#/definitions/PushNotificationCtaAction" + } + }, + "type": { + "type": "string", + "enum": [ + "DEEP_LINK", + "EXTERNAL_URL" + ] + } + }, + "title": "PushNotificationCta" + }, + "PushNotificationCtaAction": { + "type": "object", + "properties": { + "actionLink": { + "type": "string" + }, + "actionText": { + "type": "string" + }, + "templateCtaId": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "DEEP_LINK", + "EXTERNAL_URL" + ] + } + }, + "title": "PushNotificationCtaAction" + }, + "ResponseWrapper«CartEvaluationRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartEvaluationRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartEvaluationRO»" + }, + "ResponseWrapper«CartRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartRO»" + }, + "ResponseWrapper«CustomerEarnedPromotionRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CustomerEarnedPromotionRO»" + }, + "ResponseWrapper«List«AuditLogVersionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/AuditLogVersionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«AuditLogVersionRO»»" + }, + "ResponseWrapper«List«BulkEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/BulkEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" + }, + "ResponseWrapper«List«CustomMetadataFieldRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomMetadataFieldRO»»" + }, + "ResponseWrapper«List«CustomerPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomerPromotionRO»»" + }, + "ResponseWrapper«List«PromotionConfigRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionConfigRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionConfigRO»»" + }, + "ResponseWrapper«List«PromotionExpiryReminderRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionExpiryReminderRO»»" + }, + "ResponseWrapper«List«PromotionMetaRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionMetaRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionMetaRO»»" + }, + "ResponseWrapper«List«PromotionRedemptionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionRedemptionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionRedemptionRO»»" + }, + "ResponseWrapper«List«PromotionSummaryRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionSummaryRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionSummaryRO»»" + }, + "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + }, + "ResponseWrapper«PromotionExpiryReminderRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionExpiryReminderRO»" + }, + "ResponseWrapper«PromotionLanguageRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionLanguageRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionLanguageRO»" + }, + "ResponseWrapper«PromotionMetaRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionMetaRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionMetaRO»" + }, + "ResponseWrapper«PromotionStrategyRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionStrategyRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionStrategyRO»" + }, + "ResponseWrapper«boolean»": { + "type": "object", + "properties": { + "data": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«boolean»" + }, + "ResponseWrapper«object»": { + "type": "object", + "properties": { + "data": { + "type": "object" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«object»" + }, + "RestrictionKPIRO": { + "type": "object", + "properties": { + "frequency": { + "type": "string", + "enum": [ + "DAYS", + "WEEKS" + ] + }, + "kpi": { + "type": "string", + "enum": [ + "DISCOUNT", + "REDEMPTION", + "TRANSACTION" + ] + }, + "limit": { + "type": "string" + }, + "minTimeBetweenRepeat": { + "type": "integer", + "format": "int64" + } + }, + "title": "RestrictionKPIRO" + }, + "RevokeEarnRequest": { + "type": "object", + "required": [ + "customerId" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnRevokeDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnRevokeDetail" + } + } + }, + "title": "RevokeEarnRequest" + }, + "RevokeEarnResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "message": { + "type": "string" + } + }, + "title": "RevokeEarnResponse" + }, + "StoreCriteria": { + "type": "object", + "required": [ + "operator", + "type", + "values" + ], + "properties": { + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "type": { + "type": "string", + "enum": [ + "CONCEPT", + "STORE", + "ZONE" + ] + }, + "values": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + "title": "StoreCriteria" + }, + "SupplementaryCriteria": { + "type": "object", + "required": [ + "loyaltyProgramId", + "partnerProgramId", + "programType" + ], + "properties": { + "loyaltyProgramId": { + "type": "integer", + "format": "int64" + }, + "partnerProgramId": { + "type": "integer", + "format": "int32" + }, + "programType": { + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + } + }, + "title": "SupplementaryCriteria" + }, + "TimeCriteria": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTime" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteria" + }, + "TimeCriteriaReq": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeReq" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteriaReq" + }, + "TimeCriteriaRes": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeRes" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } } + }, + "title": "TimeCriteriaRes" } + } } From ed9fe7e1c5ecb4b79ddcf162617cdd869bc7d8e7 Mon Sep 17 00:00:00 2001 From: Krishna ManiSankar J Date: Thu, 27 Jan 2022 19:26:16 +0530 Subject: [PATCH 122/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 72ce43c31d5..674b40c9974 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -33,7 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . - fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files csharp="/usr/share/c#/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files c#="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php if [ "$CamelCase" = "Yes" ] From efe678a906ffdf5a8be1f3f6d28a163b3de6b6c0 Mon Sep 17 00:00:00 2001 From: Krishna ManiSankar J Date: Thu, 27 Jan 2022 19:40:04 +0530 Subject: [PATCH 123/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 674b40c9974..7aa45985932 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -33,7 +33,7 @@ then rm -rf intouch_api/csharp_client/c# -DtargetFramework=v$Version \ -o intouch_api/csharp_client/c# tar cvzf intouch_api/csharp_client/c#swagger_sdK_$BUILD_NUMBER.tar.gz -C ./intouch_api/csharp_client/c#/ . - fpm -f -s "dir" -t "deb" -a "all" -n "c#-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files c#="/usr/share/c#/capillary-libs/swagger-sdk" + fpm -f -s "dir" -t "deb" -a "all" -n "csharp-swagger-sdk" -v $BUILD_NUMBER -C ./intouch_api/csharp_client --deb-no-default-config-files c#="/usr/share/c#/capillary-libs/swagger-sdk" elif [ "$Client" = "php" ] then rm -rf intouch_api/php_client/php if [ "$CamelCase" = "Yes" ] From 6683a1491f1beb3dffab5ff3cf83a621724932a2 Mon Sep 17 00:00:00 2001 From: Vishak Udupa Date: Mon, 21 Feb 2022 13:00:36 +0530 Subject: [PATCH 124/150] Update promotion-engine.json --- promotion-engine.json | 974 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 946 insertions(+), 28 deletions(-) diff --git a/promotion-engine.json b/promotion-engine.json index c66f09bc51d..1b84a6e4609 100644 --- a/promotion-engine.json +++ b/promotion-engine.json @@ -22,6 +22,14 @@ "name": "cart-evaluation-log-resource", "description": "Cart Evaluation Log Resource" }, + { + "name": "code-based-promotion-meta-resource", + "description": "Code Based Promotion Meta Resource" + }, + { + "name": "code-based-promotion-resource", + "description": "Code Based Promotion Resource" + }, { "name": "health-check-resource", "description": "Health Check Resource" @@ -119,6 +127,12 @@ "type": "integer", "format": "int64" }, + { + "name": "isLoyaltyOnly", + "in": "query", + "required": false, + "type": "boolean" + }, { "name": "limit", "in": "query", @@ -173,12 +187,23 @@ "TIER" ] }, + { + "name": "promotionMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, { "name": "promotionType", "in": "query", "required": false, "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -478,6 +503,12 @@ "type": "integer", "format": "int64" }, + { + "name": "isLoyaltyOnly", + "in": "query", + "required": false, + "type": "boolean" + }, { "name": "limit", "in": "query", @@ -532,12 +563,23 @@ "TIER" ] }, + { + "name": "promotionMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, { "name": "promotionType", "in": "query", "required": false, "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -768,6 +810,19 @@ "produces": [ "application/json" ], + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], "responses": { "200": { "description": "OK", @@ -964,6 +1019,95 @@ } } }, + "/v1/management/promotions/{promotionId}/code_meta": { + "get": { + "tags": [ + "code-based-promotion-meta-resource" + ], + "summary": "getAllCodeBasedMetaConfigs", + "operationId": "getAllCodeBasedMetaConfigsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "code-based-promotion-meta-resource" + ], + "summary": "createCodeBasedPromotionJob", + "operationId": "createCodeBasedPromotionJobUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "codeBasedPromotionMetaRO", + "description": "codeBasedPromotionMetaRO", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CodeBasedPromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, "/v1/management/promotions/{promotionId}/deactivate": { "put": { "tags": [ @@ -1366,6 +1510,57 @@ } } }, + "/v1/promotions/code": { + "get": { + "tags": [ + "code-based-promotion-resource" + ], + "summary": "getPromotionForCodes", + "operationId": "getPromotionForCodesUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "codes", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "mode", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, "/v1/promotions/config": { "get": { "tags": [ @@ -1451,6 +1646,18 @@ "required": false, "type": "boolean" }, + { + "name": "includeRedemptions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeSupplementaryPromotions", + "in": "query", + "required": false, + "type": "boolean" + }, { "name": "limit", "in": "query", @@ -1458,6 +1665,16 @@ "type": "integer", "format": "int32" }, + { + "name": "mode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, { "name": "order", "in": "query", @@ -1571,7 +1788,7 @@ "description": "cart", "required": true, "schema": { - "$ref": "#/definitions/CartRO" + "$ref": "#/definitions/CartROReq" } } ], @@ -1622,6 +1839,16 @@ "type": "integer", "format": "int32" }, + { + "name": "mode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, { "name": "order", "in": "query", @@ -1788,11 +2015,16 @@ { "name": "customerId", "in": "query", - "description": "customerId", "required": true, "type": "integer", "format": "int64" }, + { + "name": "earnId", + "in": "query", + "required": false, + "type": "string" + }, { "name": "promotionId", "in": "path", @@ -1840,11 +2072,16 @@ { "name": "customerId", "in": "query", - "description": "customerId", "required": true, "type": "integer", "format": "int64" }, + { + "name": "earnId", + "in": "query", + "required": false, + "type": "string" + }, { "name": "promotionId", "in": "path", @@ -1948,13 +2185,17 @@ "productBasedAction": { "$ref": "#/definitions/ProductBasedAction" }, + "tenderBasedAction": { + "$ref": "#/definitions/TenderBasedAction" + }, "type": { "type": "string", "enum": [ "CART_BASED", "FIXED_PRICE", "FREE_PRODUCT", - "PRODUCT_BASED" + "PRODUCT_BASED", + "TENDER" ] } }, @@ -1994,15 +2235,31 @@ "name": { "type": "string" }, + "promoCode": { + "type": "string" + }, "promotionAppliedOnQuantity": { "type": "string" }, "promotionId": { "type": "string" }, + "promotionMode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "redeemableVoucherValue": { + "type": "string" + }, "redemptionCount": { "type": "integer", "format": "int64" + }, + "totalVoucherValue": { + "type": "string" } }, "title": "AppliedPromotionRO" @@ -2169,6 +2426,9 @@ "CartEvaluationRO": { "type": "object", "properties": { + "cartRO": { + "$ref": "#/definitions/CartRO" + }, "createdOn": { "type": "string", "format": "date-time" @@ -2242,13 +2502,18 @@ "type": "object", "required": [ "amount", - "cartItems", - "customerId" + "cartItems" ], "properties": { "amount": { "type": "string" }, + "appliedPaymentVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, "appliedPromotions": { "type": "array", "items": { @@ -2261,41 +2526,440 @@ "$ref": "#/definitions/CartItemRO" } }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, "categoryHierarchySentInPayload": { "type": "boolean" }, "customerId": { "type": "integer", - "format": "int64" + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false }, "evaluationId": { "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLog" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLog" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } } }, "title": "CartRO" }, - "ComboProductConditionRO": { + "CartROReq": { "type": "object", "required": [ - "productConditions" + "amount", + "cartItems" ], "properties": { - "productConditions": { + "amount": { + "type": "string" + }, + "appliedPaymentVouchers": { "type": "array", "items": { - "$ref": "#/definitions/ProductCondition" + "$ref": "#/definitions/AppliedPromotionRO" } - } - }, - "title": "ComboProductConditionRO" - }, - "CommunicationChannelRO": { - "type": "object", - "properties": { - "accountId": { - "type": "string" }, - "channelType": { + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "evaluationId": { + "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogReq" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogReq" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "CartROReq" + }, + "CartRORes": { + "type": "object", + "required": [ + "amount", + "cartItems" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPaymentVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "evaluationId": { + "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogRes" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogRes" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "CartRORes" + }, + "CartTenderRO": { + "type": "object", + "required": [ + "identifier" + ], + "properties": { + "adjustedAmount": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "identifier": { + "type": "string" + } + }, + "title": "CartTenderRO" + }, + "CodeBasedEvaluationLog": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLog" + }, + "CodeBasedEvaluationLogReq": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLogReq" + }, + "CodeBasedEvaluationLogRes": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLogRes" + }, + "CodeBasedPromotionMetaRO": { + "type": "object", + "required": [ + "codeJobType" + ], + "properties": { + "codeJobType": { + "type": "string", + "enum": [ + "AUTO_GENERATED", + "UPLOADED" + ] + }, + "codeLength": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 40, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "errorFileHandle": { + "type": "string" + }, + "errorMessages": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "isAlphaNumeric": { + "type": "boolean" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "savedCount": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string", + "enum": [ + "COMPLETED", + "ERRORED", + "GENERATING_CODE", + "OPEN", + "UPLOADING" + ] + }, + "successFileHandle": { + "type": "string" + }, + "totalCount": { + "type": "integer", + "format": "int64", + "maximum": 10000000, + "exclusiveMaximum": false + }, + "uploadedFile": { + "$ref": "#/definitions/UploadedFileRO" + } + }, + "title": "CodeBasedPromotionMetaRO" + }, + "CodeBasedPromotionRO": { + "type": "object", + "properties": { + "active": { + "type": "boolean" + }, + "apiError": { + "$ref": "#/definitions/ApiError" + }, + "code": { + "type": "string" + }, + "createdOn": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "isRedeemable": { + "type": "boolean" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CodeBasedPromotionRO" + }, + "ComboProductConditionRO": { + "type": "object", + "required": [ + "productConditions" + ], + "properties": { + "productConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductCondition" + } + } + }, + "title": "ComboProductConditionRO" + }, + "CommunicationChannelRO": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "channelType": { "type": "string", "enum": [ "ANDROID", @@ -2352,12 +3016,16 @@ "productCondition": { "$ref": "#/definitions/ProductCondition" }, + "tenderCondition": { + "$ref": "#/definitions/TenderCondition" + }, "type": { "type": "string", "enum": [ "CART", "COMBO_PRODUCT", - "PRODUCT" + "PRODUCT", + "TENDER" ] } }, @@ -2413,6 +3081,9 @@ "REWARD" ] }, + "errorDetails": { + "$ref": "#/definitions/ErrorDetails" + }, "eventDetails": { "$ref": "#/definitions/EventDetailsRO" }, @@ -2436,6 +3107,13 @@ "CustomerPromotionRO": { "type": "object", "properties": { + "applicationMode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, "customFieldValues": { "type": "object", "additionalProperties": { @@ -2487,6 +3165,15 @@ "INACTIVE" ] }, + "restrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionDetailsRO" + } + } + }, "supplementaryCriteria": { "$ref": "#/definitions/SupplementaryCriteria" }, @@ -3091,6 +3778,7 @@ "promotionType": { "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -3201,6 +3889,9 @@ "message": { "type": "string" }, + "promoCode": { + "type": "string" + }, "promotionId": { "type": "string" } @@ -3261,6 +3952,9 @@ "id": { "type": "string" }, + "isLoyaltyOnly": { + "type": "boolean" + }, "languagesConfigured": { "type": "array", "items": { @@ -3283,9 +3977,24 @@ "type": "integer", "format": "int32" }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, "messageLabel": { "type": "string" }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, "name": { "type": "string", "minLength": 1, @@ -3330,6 +4039,7 @@ "type": { "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -3393,6 +4103,9 @@ "id": { "type": "string" }, + "isLoyaltyOnly": { + "type": "boolean" + }, "languagesConfigured": { "type": "array", "items": { @@ -3415,9 +4128,24 @@ "type": "integer", "format": "int32" }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, "messageLabel": { "type": "string" }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, "name": { "type": "string", "minLength": 1, @@ -3462,6 +4190,7 @@ "type": { "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -3525,6 +4254,9 @@ "id": { "type": "string" }, + "isLoyaltyOnly": { + "type": "boolean" + }, "languagesConfigured": { "type": "array", "items": { @@ -3547,9 +4279,24 @@ "type": "integer", "format": "int32" }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, "messageLabel": { "type": "string" }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, "name": { "type": "string", "minLength": 1, @@ -3594,6 +4341,7 @@ "type": { "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -3636,6 +4384,9 @@ "type": "integer", "format": "int64" }, + "promoCode": { + "type": "string" + }, "promotionAppliedQuantity": { "type": "string" }, @@ -3664,7 +4415,8 @@ "type": "string", "enum": [ "CART", - "LINEITEM" + "LINEITEM", + "PAYMENT_VOUCHER" ] }, "sku": { @@ -3688,10 +4440,7 @@ "PromotionStrategyRO": { "type": "object", "required": [ - "conditionBasedRankingStrategy", - "promotionRankingStrategies", - "rewardStrategy", - "singlePromotionPerLineitem" + "promotionRankingStrategies" ], "properties": { "conditionBasedRankingStrategy": { @@ -3707,20 +4456,42 @@ "isActive": { "type": "boolean" }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, "promotionRankingStrategies": { "type": "array", "items": { "type": "string", "enum": [ + "BEST_COMBINATION", "EXPIRY_BASED", "MAX_DISCOUNT", + "MIN_DISCOUNT", "PRIORITY" ] } }, + "rewardRankingStrategies": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "CODE_FIRST", + "NO_STRATEGY", + "PROMOTION_FIRST", + "REWARDS_FIRST" + ] + } + }, "rewardStrategy": { "type": "string", "enum": [ + "CODE_FIRST", "NO_STRATEGY", "PROMOTION_FIRST", "REWARDS_FIRST" @@ -3769,6 +4540,7 @@ "promotionType": { "type": "string", "enum": [ + "CODE", "CUSTOMER", "EARNING", "POS", @@ -3796,6 +4568,14 @@ "totalEarned": { "type": "string" }, + "totalIssuedCount": { + "type": "integer", + "format": "int64" + }, + "totalPromoCodeCreated": { + "type": "integer", + "format": "int64" + }, "totalPromotionAppliedQuantity": { "type": "number", "format": "double" @@ -3877,7 +4657,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/CartRO" + "$ref": "#/definitions/CartRORes" }, "errors": { "type": "array", @@ -3888,6 +4668,21 @@ }, "title": "ResponseWrapper«CartRO»" }, + "ResponseWrapper«CodeBasedPromotionMetaRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CodeBasedPromotionMetaRO»" + }, "ResponseWrapper«CustomerEarnedPromotionRO»": { "type": "object", "properties": { @@ -3939,6 +4734,42 @@ }, "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" }, + "ResponseWrapper«List«CodeBasedPromotionMetaRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CodeBasedPromotionMetaRO»»" + }, + "ResponseWrapper«List«CodeBasedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CodeBasedPromotionRO»»" + }, "ResponseWrapper«List«CustomMetadataFieldRO»»": { "type": "object", "properties": { @@ -4173,6 +5004,34 @@ }, "title": "ResponseWrapper«object»" }, + "RestrictionDetailsRO": { + "type": "object", + "properties": { + "kpi": { + "type": "string", + "enum": [ + "DISCOUNT", + "REDEMPTION", + "TRANSACTION" + ] + }, + "maxLimit": { + "type": "number" + }, + "periodEnd": { + "type": "integer", + "format": "int64" + }, + "periodStart": { + "type": "integer", + "format": "int64" + }, + "remainingRedemption": { + "type": "number" + } + }, + "title": "RestrictionDetailsRO" + }, "RestrictionKPIRO": { "type": "object", "properties": { @@ -4292,6 +5151,49 @@ }, "title": "SupplementaryCriteria" }, + "TenderBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "TenderBasedAction" + }, + "TenderCondition": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "condition": { + "$ref": "#/definitions/Condition" + }, + "identifier": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "CARD", + "CASH", + "PAYMENT_VOUCHER" + ] + } + }, + "title": "TenderCondition" + }, "TimeCriteria": { "type": "object", "properties": { @@ -4420,6 +5322,22 @@ } }, "title": "TimeCriteriaRes" + }, + "UploadedFileRO": { + "type": "object", + "properties": { + "codeColumnIndex": { + "type": "integer", + "format": "int32" + }, + "containsHeader": { + "type": "boolean" + }, + "fileHandle": { + "type": "string" + } + }, + "title": "UploadedFileRO" } } } From aaf1eec23128178ed2bc62a2037cb2c78b9d08c2 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Thu, 24 Feb 2022 13:48:25 +0530 Subject: [PATCH 125/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 7aa45985932..484b96b0620 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -7,8 +7,8 @@ if [ "$Branch" = "snapshot" ] version="https://newapi.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then - url="http://newapi.staging.capillary.in/swagger.json" - version="http://newapi.staging.capillary.in/version.json" + url="https://intouch-api-swagger.crm-staging-new.cc.capillarytech.com/swagger.json" + version="https://newapi.crm-staging-new.cc.capillarytech.com/version" else " No Branch is selected" fi curl -k $version -o config.json From 7283008ec128e3e1b764f2c572e373698d74c59f Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Thu, 24 Feb 2022 13:54:39 +0530 Subject: [PATCH 126/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 484b96b0620..ed638e13465 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -7,7 +7,7 @@ if [ "$Branch" = "snapshot" ] version="https://newapi.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then - url="https://intouch-api-swagger.crm-staging-new.cc.capillarytech.com/swagger.json" + url="https://newapi.crm-staging-new.cc.capillarytech.com/swagger.json" version="https://newapi.crm-staging-new.cc.capillarytech.com/version" else " No Branch is selected" fi From 159388bf60b53ec8f2305083db2338bb1064b220 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Thu, 24 Feb 2022 13:56:29 +0530 Subject: [PATCH 127/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index ed638e13465..fbcb6ef563e 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -7,8 +7,8 @@ if [ "$Branch" = "snapshot" ] version="https://newapi.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then - url="https://newapi.crm-staging-new.cc.capillarytech.com/swagger.json" - version="https://newapi.crm-staging-new.cc.capillarytech.com/version" + url="https://intouch-api-swagger.crm-nightly-new.cc.capillarytech.com/swagger.json" + version="{\"artifactVersion\":\"3.50.14\"}" else " No Branch is selected" fi curl -k $version -o config.json From 133c6c42f78d7c3ae76b88f036485898ef6881d5 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Thu, 24 Feb 2022 13:59:24 +0530 Subject: [PATCH 128/150] Update swagger_sdk_gen.sh --- swagger_sdk_gen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index fbcb6ef563e..484b96b0620 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -7,8 +7,8 @@ if [ "$Branch" = "snapshot" ] version="https://newapi.crm-nightly-new.cc.capillarytech.com/version" elif [ "$Branch" = "production" ] then - url="https://intouch-api-swagger.crm-nightly-new.cc.capillarytech.com/swagger.json" - version="{\"artifactVersion\":\"3.50.14\"}" + url="https://intouch-api-swagger.crm-staging-new.cc.capillarytech.com/swagger.json" + version="https://newapi.crm-staging-new.cc.capillarytech.com/version" else " No Branch is selected" fi curl -k $version -o config.json From b0d8b711c6ffc0f34669a50f57ad0d78702414ff Mon Sep 17 00:00:00 2001 From: Vishak Udupa Date: Tue, 19 Apr 2022 16:42:10 +0530 Subject: [PATCH 129/150] Update promotion-engine.json --- promotion-engine.json | 10753 ++++++++++++++++++++-------------------- 1 file changed, 5452 insertions(+), 5301 deletions(-) diff --git a/promotion-engine.json b/promotion-engine.json index 1b84a6e4609..49974b06e63 100644 --- a/promotion-engine.json +++ b/promotion-engine.json @@ -1,5343 +1,5494 @@ { - "swagger": "2.0", - "info": { - "description": "Api Documentation", - "version": "1.0", - "title": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - } - }, - "host": "promotion-engine-api.crm-nightly-new.cc.capillarytech.com", - "basePath": "/", - "tags": [ - { - "name": "audit-log-resource", - "description": "Audit Log Resource" - }, - { - "name": "cart-evaluation-log-resource", - "description": "Cart Evaluation Log Resource" - }, - { - "name": "code-based-promotion-meta-resource", - "description": "Code Based Promotion Meta Resource" - }, - { - "name": "code-based-promotion-resource", - "description": "Code Based Promotion Resource" - }, - { - "name": "health-check-resource", - "description": "Health Check Resource" - }, - { - "name": "promotion-communication-resource", - "description": "Promotion Communication Resource" - }, - { - "name": "promotion-earning-management-resource", - "description": "Promotion Earning Management Resource" - }, - { - "name": "promotion-earning-resource", - "description": "Promotion Earning Resource" - }, - { - "name": "promotion-language-resource", - "description": "Promotion Language Resource" - }, - { - "name": "promotion-meta-resource", - "description": "Promotion Meta Resource" - }, - { - "name": "promotion-redemption-resource", - "description": "Promotion Redemption Resource" - }, - { - "name": "promotion-resource", - "description": "Promotion Resource" - }, - { - "name": "promotion-settings-resource", - "description": "Promotion Settings Resource" - } - ], - "paths": { - "/health/isalive": { - "get": { - "tags": [ - "health-check-resource" - ], - "summary": "isAlive", - "operationId": "isAliveUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getAllPromotionConfigs", - "operationId": "getAllPromotionConfigsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "active", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "campaignId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "isLoyaltyOnly", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "loyaltyProgramId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "name", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "partnerProgramId", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "programType", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "SUBSCRIPTION", - "TIER" - ] - }, - { - "name": "promotionMode", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - { - "name": "promotionType", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ID", - "NAME", - "START_DATE" - ] - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "createPromotionConfig", - "operationId": "createPromotionConfigUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotion", - "description": "promotion", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionMetaROReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/auditLogs/versions": { - "get": { - "tags": [ - "audit-log-resource" - ], - "summary": "getAuditLogVersions", - "operationId": "getAuditLogVersionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "endDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "entityId", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "entityType", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "PROMOTION_EXPIRY_REMINDER", - "PROMOTION_META", - "PROMOTION_SETTING" - ] - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«AuditLogVersionRO»»" + "swagger": "2.0", + "info": { + "description": "Api Documentation", + "version": "1.0", + "title": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "promotion-engine-api.crm-nightly-new.cc.capillarytech.com", + "basePath": "/", + "tags": [ + { + "name": "audit-log-resource", + "description": "Audit Log Resource" + }, + { + "name": "cart-evaluation-log-resource", + "description": "Cart Evaluation Log Resource" + }, + { + "name": "code-based-promotion-meta-resource", + "description": "Code Based Promotion Meta Resource" + }, + { + "name": "code-based-promotion-resource", + "description": "Code Based Promotion Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "promotion-communication-resource", + "description": "Promotion Communication Resource" + }, + { + "name": "promotion-earning-management-resource", + "description": "Promotion Earning Management Resource" + }, + { + "name": "promotion-earning-resource", + "description": "Promotion Earning Resource" + }, + { + "name": "promotion-language-resource", + "description": "Promotion Language Resource" + }, + { + "name": "promotion-meta-resource", + "description": "Promotion Meta Resource" + }, + { + "name": "promotion-redemption-resource", + "description": "Promotion Redemption Resource" + }, + { + "name": "promotion-resource", + "description": "Promotion Resource" + }, + { + "name": "promotion-settings-resource", + "description": "Promotion Settings Resource" + } + ], + "paths": { + "/health/isalive": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "isAlive", + "operationId": "isAliveUsingGET", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}": { - "get": { - "tags": [ - "audit-log-resource" - ], - "summary": "getAuditLogEntity", - "operationId": "getAuditLogEntityUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "entityId", - "in": "path", - "description": "entityId", - "required": true, - "type": "string" - }, - { - "name": "entityType", - "in": "path", - "description": "entityType", - "required": true, - "type": "string", - "enum": [ - "PROMOTION_EXPIRY_REMINDER", - "PROMOTION_META", - "PROMOTION_SETTING" - ] - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«object»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/evaluationLogs/{evaluationId}": { - "get": { - "tags": [ - "cart-evaluation-log-resource" - ], - "summary": "getEvaluationLogs", - "operationId": "getEvaluationLogsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "evaluationId", - "in": "path", - "description": "evaluationId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CartEvaluationRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/filters": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getFilteredPromotions", - "operationId": "getFilteredPromotionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "active", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "campaignId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "isLoyaltyOnly", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "loyaltyProgramId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "name", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "partnerProgramId", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "programType", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "SUBSCRIPTION", - "TIER" - ] - }, - { - "name": "promotionMode", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - { - "name": "promotionType", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ID", - "NAME", - "START_DATE" - ] - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionSummaryRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/language": { - "get": { - "tags": [ - "promotion-language-resource" - ], - "summary": "getMultiLanguageDetails", - "operationId": "getMultiLanguageDetailsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "entity", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "PROMOTION_META" - ] - }, - { - "name": "entityId", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "languageCodes", - "in": "query", - "required": false, - "type": "array", - "items": { - "type": "string" + }, + "/v1/management/promotions": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getAllPromotionConfigs", + "operationId": "getAllPromotionConfigsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "campaignId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "isLoyaltyOnly", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "loyaltyProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "partnerProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "programType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + }, + { + "name": "promotionMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + { + "name": "promotionType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ID", + "NAME", + "START_DATE" + ] + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-language-resource" - ], - "summary": "saveMultiLanguageDetails", - "operationId": "saveMultiLanguageDetailsUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotionLanguageRO", - "description": "promotionLanguageRO", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionLanguageRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/settings/custom_field": { - "get": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "getPromotionCustomFields", - "operationId": "getPromotionCustomFieldsUsingGET", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "savePromotionCustomFields", - "operationId": "savePromotionCustomFieldsUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "customMetadataFields", - "description": "customMetadataFields", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomMetadataFieldRO" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/settings/strategy": { - "get": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "getPromotionStrategy", - "operationId": "getPromotionStrategyUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "mode", - "required": true, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-settings-resource" - ], - "summary": "savePromotionStrategy", - "operationId": "savePromotionStrategyUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotionStrategy", - "description": "promotionStrategy", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionStrategyRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}": { - "get": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "getPromotionConfig", - "operationId": "getPromotionConfigUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "updatePromotionConfig", - "operationId": "updatePromotionConfigUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotion", - "description": "promotion", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionMetaROReq" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/activate": { - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "activatePromotion", - "operationId": "activatePromotionUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" + "post": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "createPromotionConfig", + "operationId": "createPromotionConfigUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/code_meta": { - "get": { - "tags": [ - "code-based-promotion-meta-resource" - ], - "summary": "getAllCodeBasedMetaConfigs", - "operationId": "getAllCodeBasedMetaConfigsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionMetaRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "code-based-promotion-meta-resource" - ], - "summary": "createCodeBasedPromotionJob", - "operationId": "createCodeBasedPromotionJobUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "codeBasedPromotionMetaRO", - "description": "codeBasedPromotionMetaRO", - "required": true, - "schema": { - "$ref": "#/definitions/CodeBasedPromotionMetaRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CodeBasedPromotionMetaRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/deactivate": { - "put": { - "tags": [ - "promotion-meta-resource" - ], - "summary": "deactivatePromotion", - "operationId": "deactivatePromotionUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/expiryReminders": { - "get": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "getPromotionExpiryReminders", - "operationId": "getPromotionExpiryRemindersUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionExpiryReminderRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "createPromotionExpiryReminder", - "operationId": "createPromotionExpiryReminderUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "promotionExpiryReminder", - "description": "promotionExpiryReminder", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}": { - "get": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "getPromotionExpiryReminder", - "operationId": "getPromotionExpiryReminderUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "updatePromotionExpiryReminder", - "operationId": "updatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "promotionExpiryReminder", - "description": "promotionExpiryReminder", - "required": true, - "schema": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/activate": { - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "activatePromotionExpiryReminder", - "operationId": "activatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" + }, + "/v1/management/promotions/auditLogs/versions": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogVersions", + "operationId": "getAuditLogVersionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«AuditLogVersionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/deactivate": { - "put": { - "tags": [ - "promotion-communication-resource" - ], - "summary": "deactivatePromotionExpiryReminder", - "operationId": "deactivatePromotionExpiryReminderUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "expiryReminderId", - "in": "path", - "description": "expiryReminderId", - "required": true, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" + }, + "/v1/management/promotions/auditLogs/{entityType}/{entityId}/{version}": { + "get": { + "tags": [ + "audit-log-resource" + ], + "summary": "getAuditLogEntity", + "operationId": "getAuditLogEntityUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "entityId", + "in": "path", + "description": "entityId", + "required": true, + "type": "string" + }, + { + "name": "entityType", + "in": "path", + "description": "entityType", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_EXPIRY_REMINDER", + "PROMOTION_META", + "PROMOTION_SETTING" + ] + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«object»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/management/promotions/{promotionId}/issueBulk": { - "post": { - "tags": [ - "promotion-earning-management-resource" - ], - "summary": "issuePromotionsInBulk", - "operationId": "issuePromotionsInBulkUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "contextId", - "in": "query", - "description": "contextId", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "customerIds", - "description": "customerIds", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } + }, + "/v1/management/promotions/evaluationLogs/{evaluationId}": { + "get": { + "tags": [ + "cart-evaluation-log-resource" + ], + "summary": "getEvaluationLogs", + "operationId": "getEvaluationLogsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "evaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartEvaluationRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + }, + "/v1/management/promotions/filters": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getFilteredPromotions", + "operationId": "getFilteredPromotionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "campaignId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "isLoyaltyOnly", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "loyaltyProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "partnerProgramId", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "programType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + }, + { + "name": "promotionMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + { + "name": "promotionType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ID", + "NAME", + "START_DATE" + ] + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionSummaryRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/code": { - "get": { - "tags": [ - "code-based-promotion-resource" - ], - "summary": "getPromotionForCodes", - "operationId": "getPromotionForCodesUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "codes", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" + }, + "/v1/management/promotions/language": { + "get": { + "tags": [ + "promotion-language-resource" + ], + "summary": "getMultiLanguageDetails", + "operationId": "getMultiLanguageDetailsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "entity", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "PROMOTION_META" + ] + }, + { + "name": "entityId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "languageCodes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } }, - "collectionFormat": "multi" - }, - { - "name": "mode", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionRO»»" + "post": { + "tags": [ + "promotion-language-resource" + ], + "summary": "saveMultiLanguageDetails", + "operationId": "saveMultiLanguageDetailsUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionLanguageRO", + "description": "promotionLanguageRO", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionLanguageRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionLanguageRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/config": { - "get": { - "tags": [ - "promotion-resource" - ], - "summary": "getPromotionConfig", - "operationId": "getPromotionConfigUsingGET_1", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "includeExpired", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "includeInactive", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "promotionIds", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "string" + }, + "/v1/management/promotions/settings/custom_field": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionCustomFields", + "operationId": "getPromotionCustomFieldsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "mode", + "required": false, + "type": "string", + "default": "DISCOUNT", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionConfigRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/customer/{customerId}": { - "get": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "getAllForCustomer", - "operationId": "getAllForCustomerUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "description": "customerId", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "entityId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "includeExpired", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "includeRedemptions", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "includeSupplementaryPromotions", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "mode", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "EVENT_TIME", - "VALID_TILL" - ] - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«CustomerPromotionRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/earn/bulk": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "bulkEarnPromotion", - "operationId": "bulkEarnPromotionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "bulkEarnRO", - "description": "bulkEarnRO", - "required": true, - "schema": { - "$ref": "#/definitions/BulkEarnRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«BulkEarnedPromotionRO»»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/evaluate": { - "post": { - "tags": [ - "promotion-redemption-resource" - ], - "summary": "evaluatePromotionOnCart", - "operationId": "evaluatePromotionOnCartUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "cart", - "description": "cart", - "required": true, - "schema": { - "$ref": "#/definitions/CartROReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CartRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/redemptions": { - "get": { - "tags": [ - "promotion-redemption-resource" - ], - "summary": "getRedemptions", - "operationId": "getRedemptionsUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "mode", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - { - "name": "order", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - { - "name": "pageNumber", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "promotionId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "sortOn", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "REDEMPTION_DATE" - ] - }, - { - "name": "transactionEntityIdentifier", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "transactionIdentifier", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/revokeEarn": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "revokeEarn", - "operationId": "revokeEarnUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "revokeEarnRequest", - "description": "revokeEarnRequest", - "required": true, - "schema": { - "$ref": "#/definitions/RevokeEarnRequest" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/till/{tillId}": { - "get": { - "tags": [ - "promotion-resource" - ], - "summary": "getAllActivePosPromotionForTill", - "operationId": "getAllActivePosPromotionForTillUsingGET", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "tillId", - "in": "path", - "description": "tillId", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/{promotionId}/activate": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "activate", - "operationId": "activateUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "earnId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/{promotionId}/deactivate": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "deactivate", - "operationId": "deactivateUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "earnId", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«boolean»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/promotions/{promotionId}/earn": { - "post": { - "tags": [ - "promotion-earning-resource" - ], - "summary": "earnPromotion", - "operationId": "earnPromotionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "customerEarnedPromotion", - "description": "customerEarnedPromotion", - "required": true, - "schema": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionCustomFields", + "operationId": "savePromotionCustomFieldsUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customMetadataFields", + "description": "customMetadataFields", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } + } + }, + { + "name": "mode", + "in": "query", + "description": "mode", + "required": false, + "type": "string", + "default": "DISCOUNT", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomMetadataFieldRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - }, - { - "name": "promotionId", - "in": "path", - "description": "promotionId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - } - }, - "definitions": { - "Action": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "cartBasedAction": { - "$ref": "#/definitions/CartBasedAction" - }, - "fixedPriceAction": { - "$ref": "#/definitions/FixedPriceAction" - }, - "freeProductAction": { - "$ref": "#/definitions/FreeProductAction" - }, - "productBasedAction": { - "$ref": "#/definitions/ProductBasedAction" - }, - "tenderBasedAction": { - "$ref": "#/definitions/TenderBasedAction" - }, - "type": { - "type": "string", - "enum": [ - "CART_BASED", - "FIXED_PRICE", - "FREE_PRODUCT", - "PRODUCT_BASED", - "TENDER" - ] - } - }, - "title": "Action" - }, - "ApiError": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int64" - }, - "message": { - "type": "string" - } - }, - "title": "ApiError" - }, - "AppliedPromotionRO": { - "type": "object", - "properties": { - "discount": { - "type": "string" - }, - "discountAppliedOnQuantity": { - "type": "string" - }, - "earnedPromotionId": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "messageLabel": { - "type": "string" - }, - "name": { - "type": "string" - }, - "promoCode": { - "type": "string" - }, - "promotionAppliedOnQuantity": { - "type": "string" - }, - "promotionId": { - "type": "string" - }, - "promotionMode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "redeemableVoucherValue": { - "type": "string" - }, - "redemptionCount": { - "type": "integer", - "format": "int64" - }, - "totalVoucherValue": { - "type": "string" - } - }, - "title": "AppliedPromotionRO" - }, - "AuditLogVersionRO": { - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "triggeredBy": { - "type": "integer", - "format": "int64" - }, - "triggeredOn": { - "type": "integer", - "format": "int64" - }, - "version": { - "type": "string" - } - }, - "title": "AuditLogVersionRO" - }, - "BulkEarnRO": { - "type": "object", - "required": [ - "customerId", - "earnedFromType", - "eventDetails", - "eventTime" - ], - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "earnedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/EarnedPromotion" - } - }, - "eventDetails": { - "$ref": "#/definitions/EventDetailsRO" - }, - "eventTime": { - "type": "integer", - "format": "int64" - }, - "orgId": { - "type": "integer", - "format": "int64" - } - }, - "title": "BulkEarnRO" - }, - "BulkEarnedPromotionRO": { - "type": "object", - "properties": { - "customerEarnedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - } - }, - "earnedFromId": { - "type": "string" - }, - "errorDetails": { - "$ref": "#/definitions/ErrorDetails" - }, - "failedEarnCount": { - "type": "integer", - "format": "int32" - }, - "promotionId": { - "type": "string" - }, - "successfulEarnCount": { - "type": "integer", - "format": "int32" - } - }, - "title": "BulkEarnedPromotionRO" - }, - "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/RevokeEarnResponse" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/EarnRevokeError" - } - } - }, - "title": "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" - }, - "CartBasedAction": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ABSOLUTE", - "PERCENTAGE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "CartBasedAction" - }, - "CartCondition": { - "type": "object", - "required": [ - "kpi", - "operator", - "value" - ], - "properties": { - "kpi": { - "type": "string", - "enum": [ - "ITEMCOUNT", - "SUBTOTAL" - ] - }, - "operator": { - "type": "string", - "enum": [ - "EQUALS", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "IN", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "NONE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "CartCondition" - }, - "CartEvaluationRO": { - "type": "object", - "properties": { - "cartRO": { - "$ref": "#/definitions/CartRO" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "evaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionLogRO" - } - }, - "id": { - "type": "string" - }, - "isRedeemed": { - "type": "boolean" - } - }, - "title": "CartEvaluationRO" - }, - "CartItemRO": { - "type": "object", - "required": [ - "amount", - "qty", - "sku" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "brandList": { - "type": "array", - "items": { - "type": "string" - } - }, - "categoryList": { - "type": "array", - "items": { - "type": "string" - } - }, - "discount": { - "type": "string" - }, - "qty": { - "type": "string" - }, - "referenceId": { - "type": "string" - }, - "sku": { - "type": "string" - } - }, - "title": "CartItemRO" - }, - "CartRO": { - "type": "object", - "required": [ - "amount", - "cartItems" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPaymentVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "cartItems": { - "type": "array", - "items": { - "$ref": "#/definitions/CartItemRO" - } - }, - "cartTenders": { - "type": "array", - "items": { - "$ref": "#/definitions/CartTenderRO" - } - }, - "categoryHierarchySentInPayload": { - "type": "boolean" - }, - "customerId": { - "type": "integer", - "format": "int64", - "minimum": 1, - "exclusiveMinimum": false - }, - "evaluationId": { - "type": "string" - }, - "paymentVoucherEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLog" - } - }, - "paymentVouchers": { - "type": "array", - "items": { - "type": "string" - } - }, - "promoCodeEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLog" - } - }, - "promoCodes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "CartRO" - }, - "CartROReq": { - "type": "object", - "required": [ - "amount", - "cartItems" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPaymentVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "cartItems": { - "type": "array", - "items": { - "$ref": "#/definitions/CartItemRO" - } - }, - "cartTenders": { - "type": "array", - "items": { - "$ref": "#/definitions/CartTenderRO" - } - }, - "categoryHierarchySentInPayload": { - "type": "boolean" - }, - "customerId": { - "type": "integer", - "format": "int64", - "minimum": 1, - "exclusiveMinimum": false - }, - "evaluationId": { - "type": "string" - }, - "paymentVoucherEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLogReq" - } - }, - "paymentVouchers": { - "type": "array", - "items": { - "type": "string" - } - }, - "promoCodeEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLogReq" - } - }, - "promoCodes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "CartROReq" - }, - "CartRORes": { - "type": "object", - "required": [ - "amount", - "cartItems" - ], - "properties": { - "amount": { - "type": "string" - }, - "appliedPaymentVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "appliedPromotions": { - "type": "array", - "items": { - "$ref": "#/definitions/AppliedPromotionRO" - } - }, - "cartItems": { - "type": "array", - "items": { - "$ref": "#/definitions/CartItemRO" - } - }, - "cartTenders": { - "type": "array", - "items": { - "$ref": "#/definitions/CartTenderRO" - } - }, - "categoryHierarchySentInPayload": { - "type": "boolean" - }, - "customerId": { - "type": "integer", - "format": "int64", - "minimum": 1, - "exclusiveMinimum": false - }, - "evaluationId": { - "type": "string" - }, - "paymentVoucherEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLogRes" - } - }, - "paymentVouchers": { - "type": "array", - "items": { - "type": "string" - } - }, - "promoCodeEvaluationLogs": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedEvaluationLogRes" - } - }, - "promoCodes": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "CartRORes" - }, - "CartTenderRO": { - "type": "object", - "required": [ - "identifier" - ], - "properties": { - "adjustedAmount": { - "type": "string" - }, - "amount": { - "type": "string" - }, - "identifier": { - "type": "string" - } - }, - "title": "CartTenderRO" - }, - "CodeBasedEvaluationLog": { - "type": "object", - "properties": { - "codeType": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "errorCode": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "promoCode": { - "type": "string" - } - }, - "title": "CodeBasedEvaluationLog" - }, - "CodeBasedEvaluationLogReq": { - "type": "object", - "properties": { - "codeType": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "errorCode": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "promoCode": { - "type": "string" - } - }, - "title": "CodeBasedEvaluationLogReq" - }, - "CodeBasedEvaluationLogRes": { - "type": "object", - "properties": { - "codeType": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "errorCode": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "promoCode": { - "type": "string" - } - }, - "title": "CodeBasedEvaluationLogRes" - }, - "CodeBasedPromotionMetaRO": { - "type": "object", - "required": [ - "codeJobType" - ], - "properties": { - "codeJobType": { - "type": "string", - "enum": [ - "AUTO_GENERATED", - "UPLOADED" - ] - }, - "codeLength": { - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 40, - "exclusiveMinimum": false, - "exclusiveMaximum": false - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "errorFileHandle": { - "type": "string" - }, - "errorMessages": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "string" - }, - "isAlphaNumeric": { - "type": "boolean" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "savedCount": { - "type": "integer", - "format": "int64" - }, - "status": { - "type": "string", - "enum": [ - "COMPLETED", - "ERRORED", - "GENERATING_CODE", - "OPEN", - "UPLOADING" - ] - }, - "successFileHandle": { - "type": "string" - }, - "totalCount": { - "type": "integer", - "format": "int64", - "maximum": 10000000, - "exclusiveMaximum": false - }, - "uploadedFile": { - "$ref": "#/definitions/UploadedFileRO" - } - }, - "title": "CodeBasedPromotionMetaRO" - }, - "CodeBasedPromotionRO": { - "type": "object", - "properties": { - "active": { - "type": "boolean" - }, - "apiError": { - "$ref": "#/definitions/ApiError" - }, - "code": { - "type": "string" - }, - "createdOn": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "isRedeemable": { - "type": "boolean" - }, - "mode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "validTill": { - "type": "integer", - "format": "int64" - } - }, - "title": "CodeBasedPromotionRO" - }, - "ComboProductConditionRO": { - "type": "object", - "required": [ - "productConditions" - ], - "properties": { - "productConditions": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductCondition" - } - } - }, - "title": "ComboProductConditionRO" - }, - "CommunicationChannelRO": { - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "channelType": { - "type": "string", - "enum": [ - "ANDROID", - "EMAIL", - "IOS", - "SMS" - ] - }, - "domainPropertyId": { - "type": "string" - }, - "message": { - "type": "string" - }, - "pushNotificationCta": { - "$ref": "#/definitions/PushNotificationCta" - }, - "senderCDMA": { - "type": "string" - }, - "senderEmail": { - "type": "string" - }, - "senderGSM": { - "type": "string" }, - "senderLabel": { - "type": "string" - }, - "senderReplyToEmail": { - "type": "string" - }, - "subject": { - "type": "string" - }, - "unsubscribeLabel": { - "type": "string" - } - }, - "title": "CommunicationChannelRO" - }, - "Condition": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "cartCondition": { - "$ref": "#/definitions/CartCondition" - }, - "comboProductCondition": { - "$ref": "#/definitions/ComboProductConditionRO" - }, - "productCondition": { - "$ref": "#/definitions/ProductCondition" - }, - "tenderCondition": { - "$ref": "#/definitions/TenderCondition" - }, - "type": { - "type": "string", - "enum": [ - "CART", - "COMBO_PRODUCT", - "PRODUCT", - "TENDER" - ] - } - }, - "title": "Condition" - }, - "CustomMetadataFieldRO": { - "type": "object", - "required": [ - "dataType", - "fieldName" - ], - "properties": { - "dataType": { - "type": "string", - "enum": [ - "DATE", - "NUMBER", - "STRING" - ] - }, - "fieldName": { - "type": "string" - }, - "isRequired": { - "type": "boolean" - } - }, - "title": "CustomMetadataFieldRO" - }, - "CustomerEarnedPromotionRO": { - "type": "object", - "required": [ - "customerId", - "earnedFromId", - "earnedFromType", - "eventDetails", - "eventTime" - ], - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromId": { - "type": "string" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "errorDetails": { - "$ref": "#/definitions/ErrorDetails" - }, - "eventDetails": { - "$ref": "#/definitions/EventDetailsRO" - }, - "eventTime": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "promotionId": { - "type": "string" - }, - "validTill": { - "type": "integer", - "format": "int64" - } - }, - "title": "CustomerEarnedPromotionRO" - }, - "CustomerPromotionRO": { - "type": "object", - "properties": { - "applicationMode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnedFromId": { - "type": "string" - }, - "earnedPromotionId": { - "type": "string" - }, - "earnedStatus": { - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED" - ] - }, - "earnedType": { - "type": "string", - "enum": [ - "MILESTONE_EARN", - "NONE", - "REWARD", - "SINGLE_ACTIVITY_EARN", - "SUBSCRIPTION", - "TIER" - ] - }, - "mileStoneId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - }, - "restrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionDetailsRO" + "/v1/management/promotions/settings/strategy": { + "get": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "getPromotionStrategy", + "operationId": "getPromotionStrategyUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "mode", + "in": "query", + "description": "mode", + "required": true, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-settings-resource" + ], + "summary": "savePromotionStrategy", + "operationId": "savePromotionStrategyUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionStrategy", + "description": "promotionStrategy", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionStrategyRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionStrategyRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - } - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - }, - "unlockedDate": { - "type": "integer", - "format": "int64" - }, - "validTill": { - "type": "integer", - "format": "int64" - } - }, - "title": "CustomerPromotionRO" - }, - "DecimalRoundingStrategy": { - "type": "object", - "properties": { - "decimalPlaces": { - "type": "integer", - "format": "int32" - }, - "roundingMode": { - "type": "string", - "enum": [ - "CEILING", - "DOWN", - "FLOOR", - "HALF_DOWN", - "HALF_EVEN", - "HALF_UP", - "UNNECESSARY", - "UP" - ] - } - }, - "title": "DecimalRoundingStrategy" - }, - "Duration": { - "type": "object", - "properties": { - "period": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string", - "enum": [ - "DAYS", - "HOURS", - "MINUTES" - ] - } - }, - "title": "Duration" - }, - "EarnRevokeDetail": { - "type": "object", - "required": [ - "promotionId" - ], - "properties": { - "earnIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "promotionId": { - "type": "string" - } - }, - "title": "EarnRevokeDetail" - }, - "EarnRevokeError": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int64" - }, - "earnIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "message": { - "type": "string" - }, - "promotionId": { - "type": "string" - } - }, - "title": "EarnRevokeError" - }, - "EarnedPromotion": { - "type": "object", - "required": [ - "earnCount", - "earnedFromId", - "promotionId" - ], - "properties": { - "earnCount": { - "type": "integer", - "format": "int32" - }, - "earnedFromId": { - "type": "string" - }, - "promotionId": { - "type": "string" - } - }, - "title": "EarnedPromotion" - }, - "EarningCriteriaRO": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "earningValidTillDays": { - "type": "integer", - "format": "int32", - "minimum": 1, - "exclusiveMinimum": false - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteria" - } - }, - "title": "EarningCriteriaRO" - }, - "EarningCriteriaROReq": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "earningValidTillDays": { - "type": "integer", - "format": "int32", - "minimum": 1, - "exclusiveMinimum": false - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaReq" - } - }, - "title": "EarningCriteriaROReq" - }, - "EarningCriteriaRORes": { - "type": "object", - "required": [ - "earnedFromType" - ], - "properties": { - "active": { - "type": "boolean" - }, - "criteriaDsl": { - "type": "string" - }, - "criteriaDslJson": { - "type": "string" - }, - "criteriaName": { - "type": "string" - }, - "duration": { - "$ref": "#/definitions/Duration" - }, - "earnedFromType": { - "type": "string", - "enum": [ - "ACTIVITY", - "BULK_ISSUE", - "MILESTONE", - "REWARD" - ] - }, - "earningValidTillDays": { - "type": "integer", - "format": "int32", - "minimum": 1, - "exclusiveMinimum": false - }, - "eventType": { - "type": "string", - "enum": [ - "CustomerRegistration", - "CustomerUpdate", - "TransactionAdd" - ] - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaRes" - } - }, - "title": "EarningCriteriaRORes" - }, - "ErrorDetails": { - "type": "object", - "properties": { - "errorCode": { - "type": "integer", - "format": "int64" - }, - "errorMessages": { - "type": "string" - } - }, - "title": "ErrorDetails" - }, - "EventDetailsRO": { - "type": "object", - "properties": { - "eventPayload": { - "type": "object" - }, - "id": { - "type": "string" }, - "type": { - "type": "string" - } - }, - "title": "EventDetailsRO" - }, - "FixedPriceAction": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - }, - "value": { - "type": "string" - } - }, - "title": "FixedPriceAction" - }, - "FreeProductAction": { - "type": "object", - "required": [ - "productBasedCondition" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - } - }, - "title": "FreeProductAction" - }, - "LanguageDescription": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "CUSTOM", - "STANDARD" - ] - }, - "value": { - "type": "string" - } - }, - "title": "LanguageDescription" - }, - "LocalTime": { - "type": "object", - "properties": { - "hour": { - "type": "integer", - "format": "int32" - }, - "minute": { - "type": "integer", - "format": "int32" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "integer", - "format": "int32" - } - }, - "title": "LocalTime" - }, - "LocalTimeReq": { - "type": "object", - "properties": { - "hour": { - "type": "string", - "format": "byte" - }, - "minute": { - "type": "string", - "format": "byte" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "string", - "format": "byte" - } - }, - "title": "LocalTimeReq" - }, - "LocalTimeRes": { - "type": "object", - "properties": { - "hour": { - "type": "integer", - "format": "int32" - }, - "minute": { - "type": "integer", - "format": "int32" - }, - "nano": { - "type": "integer", - "format": "int32" - }, - "second": { - "type": "integer", - "format": "int32" - } - }, - "title": "LocalTimeRes" - }, - "MultiLanguageDetails": { - "type": "object", - "required": [ - "languageCode", - "languageDescriptionList" - ], - "properties": { - "languageCode": { - "type": "string" - }, - "languageDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/LanguageDescription" - } - } - }, - "title": "MultiLanguageDetails" - }, - "ProductBasedAction": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "productBasedCondition": { - "$ref": "#/definitions/Condition" - }, - "type": { - "type": "string", - "enum": [ - "ABSOLUTE", - "PERCENTAGE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "ProductBasedAction" - }, - "ProductCondition": { - "type": "object", - "required": [ - "criteriaList", - "kpi" - ], - "properties": { - "criteriaList": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductSelectionCriteriaRO" - } - }, - "kpi": { - "type": "string", - "enum": [ - "AMOUNT", - "NONE", - "QUANTITY" - ] - }, - "operator": { - "type": "string", - "enum": [ - "EQUALS", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "IN", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "NONE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "ProductCondition" - }, - "ProductSelectionCriteriaRO": { - "type": "object", - "required": [ - "entity", - "values" - ], - "properties": { - "attributeName": { - "type": "string" - }, - "entity": { - "type": "string", - "enum": [ - "ATTRIBUTE", - "BRAND", - "CATEGORY", - "SKU" - ] - }, - "operator": { - "type": "string", - "enum": [ - "IN", - "NOT_IN" - ] - }, - "values": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "ProductSelectionCriteriaRO" - }, - "PromotionConfigRO": { - "type": "object", - "properties": { - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "expiry": { - "type": "integer", - "format": "int64" - }, - "groupId": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "milestoneId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" + "/v1/management/promotions/{promotionId}": { + "get": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "updatePromotionConfig", + "operationId": "updatePromotionConfigUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotion", + "description": "promotion", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionMetaROReq" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - } - }, - "promotionType": { - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - "reward": { - "type": "string" - }, - "ruleId": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - } - }, - "title": "PromotionConfigRO" - }, - "PromotionExpiryReminderRO": { - "type": "object", - "required": [ - "communicationChannels", - "numberOfDaysBeforeExpiry" - ], - "properties": { - "active": { - "type": "boolean" - }, - "communicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "integer", - "format": "int64" - }, - "numberOfDaysBeforeExpiry": { - "type": "integer", - "format": "int32", - "minimum": 0, - "exclusiveMinimum": false - }, - "promotionId": { - "type": "string" - } - }, - "title": "PromotionExpiryReminderRO" - }, - "PromotionLanguageRO": { - "type": "object", - "required": [ - "entity", - "entityId", - "multiLanguageDetails" - ], - "properties": { - "entity": { - "type": "string", - "enum": [ - "PROMOTION_META" - ] - }, - "entityId": { - "type": "string" - }, - "multiLanguageDetails": { - "type": "array", - "items": { - "$ref": "#/definitions/MultiLanguageDetails" - } - } - }, - "title": "PromotionLanguageRO" - }, - "PromotionLogRO": { - "type": "object", - "properties": { - "earnedPromotionId": { - "type": "string" - }, - "evaluationStatus": { - "type": "boolean" }, - "logType": { - "type": "string" - }, - "message": { - "type": "string" - }, - "promoCode": { - "type": "string" - }, - "promotionId": { - "type": "string" - } - }, - "title": "PromotionLogRO" - }, - "PromotionMetaRO": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customerActivationRequired": { - "type": "boolean" - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaRO" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "isLoyaltyOnly": { - "type": "boolean" - }, - "languagesConfigured": { - "type": "array", - "items": { - "type": "string" - } - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "maxIssuancePerCustomer": { - "type": "integer", - "format": "int32", - "minimum": 1, - "maximum": 10, - "exclusiveMinimum": false, - "exclusiveMaximum": false - }, - "messageLabel": { - "type": "string" - }, - "mode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteria" - }, - "type": { - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaRO" - }, - "PromotionMetaROReq": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customerActivationRequired": { - "type": "boolean" - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaROReq" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "isLoyaltyOnly": { - "type": "boolean" - }, - "languagesConfigured": { - "type": "array", - "items": { - "type": "string" - } - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "maxIssuancePerCustomer": { - "type": "integer", - "format": "int32", - "minimum": 1, - "maximum": 10, - "exclusiveMinimum": false, - "exclusiveMaximum": false - }, - "messageLabel": { - "type": "string" - }, - "mode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" + "/v1/management/promotions/{promotionId}/activate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "activatePromotion", + "operationId": "activatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaReq" - }, - "type": { - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaROReq" - }, - "PromotionMetaRORes": { - "type": "object", - "required": [ - "action", - "campaignId", - "endDate", - "name", - "startDate", - "type" - ], - "properties": { - "action": { - "$ref": "#/definitions/Action" - }, - "active": { - "type": "boolean" - }, - "campaignId": { - "type": "integer", - "format": "int64" - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customerActivationRequired": { - "type": "boolean" - }, - "earnLimitedToSpecificAudience": { - "type": "boolean" - }, - "earningCriteria": { - "$ref": "#/definitions/EarningCriteriaRORes" - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "id": { - "type": "string" - }, - "isLoyaltyOnly": { - "type": "boolean" - }, - "languagesConfigured": { - "type": "array", - "items": { - "type": "string" - } - }, - "lastUpdatedBy": { - "type": "integer", - "format": "int64" - }, - "lastUpdatedOn": { - "type": "string", - "format": "date-time" - }, - "loyaltyEarningExpiryDays": { - "type": "integer", - "format": "int32" - }, - "maxEarningPerCustomer": { - "type": "integer", - "format": "int32" - }, - "maxIssuancePerCustomer": { - "type": "integer", - "format": "int32", - "minimum": 1, - "maximum": 10, - "exclusiveMinimum": false, - "exclusiveMaximum": false - }, - "messageLabel": { - "type": "string" - }, - "mode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "name": { - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "onEarnCommunicationChannels": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CommunicationChannelRO" - } - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "promotionRestrictions": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "$ref": "#/definitions/RestrictionKPIRO" - } - } - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "storeCriteria": { - "$ref": "#/definitions/StoreCriteria" - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - }, - "timeCriteria": { - "$ref": "#/definitions/TimeCriteriaRes" - }, - "type": { - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - } - }, - "title": "PromotionMetaRORes" - }, - "PromotionRedemptionRO": { - "type": "object", - "properties": { - "amount": { - "type": "string" - }, - "cartEvaluationId": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" }, - "discount": { - "type": "string" - }, - "discountAppliedQuantity": { - "type": "string" + "/v1/management/promotions/{promotionId}/code_meta": { + "get": { + "tags": [ + "code-based-promotion-meta-resource" + ], + "summary": "getAllCodeBasedMetaConfigs", + "operationId": "getAllCodeBasedMetaConfigsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "code-based-promotion-meta-resource" + ], + "summary": "createCodeBasedPromotionJob", + "operationId": "createCodeBasedPromotionJobUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "codeBasedPromotionMetaRO", + "description": "codeBasedPromotionMetaRO", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CodeBasedPromotionMetaRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "earnedPromotionId": { - "type": "string" + "/v1/management/promotions/{promotionId}/deactivate": { + "put": { + "tags": [ + "promotion-meta-resource" + ], + "summary": "deactivatePromotion", + "operationId": "deactivatePromotionUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "id": { - "type": "string" + "/v1/management/promotions/{promotionId}/expiryReminders": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminders", + "operationId": "getPromotionExpiryRemindersUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionExpiryReminderRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "createPromotionExpiryReminder", + "operationId": "createPromotionExpiryReminderUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "orgId": { - "type": "integer", - "format": "int64" + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}": { + "get": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "getPromotionExpiryReminder", + "operationId": "getPromotionExpiryReminderUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "updatePromotionExpiryReminder", + "operationId": "updatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "promotionExpiryReminder", + "description": "promotionExpiryReminder", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«PromotionExpiryReminderRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "productId": { - "type": "integer", - "format": "int64" + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/activate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "activatePromotionExpiryReminder", + "operationId": "activatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "promoCode": { - "type": "string" + "/v1/management/promotions/{promotionId}/expiryReminders/{expiryReminderId}/deactivate": { + "put": { + "tags": [ + "promotion-communication-resource" + ], + "summary": "deactivatePromotionExpiryReminder", + "operationId": "deactivatePromotionExpiryReminderUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "expiryReminderId", + "in": "path", + "description": "expiryReminderId", + "required": true, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "promotionAppliedQuantity": { - "type": "string" + "/v1/management/promotions/{promotionId}/issueBulk": { + "post": { + "tags": [ + "promotion-earning-management-resource" + ], + "summary": "issuePromotionsInBulk", + "operationId": "issuePromotionsInBulkUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "contextId", + "in": "query", + "description": "contextId", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "customerIds", + "description": "customerIds", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "promotionId": { - "type": "string" + "/v1/promotions/code": { + "get": { + "tags": [ + "code-based-promotion-resource" + ], + "summary": "getPromotionForCodes", + "operationId": "getPromotionForCodesUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "codes", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "includeRedemptions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "mode", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CodeBasedPromotionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "promotionMessageLabel": { - "type": "string" + "/v1/promotions/code/link": { + "post": { + "tags": [ + "code-based-promotion-resource" + ], + "summary": "linkCode", + "operationId": "linkCodeUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "saveCodeRequest", + "description": "saveCodeRequest", + "required": true, + "schema": { + "$ref": "#/definitions/SaveCodeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CodeBasedPromotionRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "promotionName": { - "type": "string" + "/v1/promotions/config": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getPromotionConfig", + "operationId": "getPromotionConfigUsingGET_1", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "promotionIds", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionConfigRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "redemptionCount": { - "type": "integer", - "format": "int64" + "/v1/promotions/customer/{customerId}": { + "get": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "getAllForCustomer", + "operationId": "getAllForCustomerUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "path", + "description": "customerId", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "entityId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "includeCodeLinkedPromotions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeExpired", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeRedemptions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "includeSupplementaryPromotions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "mode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EVENT_TIME", + "VALID_TILL" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«CustomerPromotionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "redemptionDate": { - "type": "string", - "format": "date-time" + "/v1/promotions/earn/bulk": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "bulkEarnPromotion", + "operationId": "bulkEarnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "bulkEarnRO", + "description": "bulkEarnRO", + "required": true, + "schema": { + "$ref": "#/definitions/BulkEarnRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«BulkEarnedPromotionRO»»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "redemptionTill": { - "type": "integer", - "format": "int64" + "/v1/promotions/evaluate": { + "post": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "evaluatePromotionOnCart", + "operationId": "evaluatePromotionOnCartUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "cart", + "description": "cart", + "required": true, + "schema": { + "$ref": "#/definitions/CartROReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CartRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "redemptionType": { - "type": "string", - "enum": [ - "CART", - "LINEITEM", - "PAYMENT_VOUCHER" - ] + "/v1/promotions/redemptions": { + "get": { + "tags": [ + "promotion-redemption-resource" + ], + "summary": "getRedemptions", + "operationId": "getRedemptionsUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "mode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "promotionId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "sortOn", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "REDEMPTION_DATE" + ] + }, + { + "name": "transactionEntityIdentifier", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "transactionIdentifier", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionRedemptionRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "sku": { - "type": "string" + "/v1/promotions/revokeEarn": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "revokeEarn", + "operationId": "revokeEarnUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "revokeEarnRequest", + "description": "revokeEarnRequest", + "required": true, + "schema": { + "$ref": "#/definitions/RevokeEarnRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "taxEntityId": { - "type": "string" + "/v1/promotions/till/{tillId}": { + "get": { + "tags": [ + "promotion-resource" + ], + "summary": "getAllActivePosPromotionForTill", + "operationId": "getAllActivePosPromotionForTillUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "tillId", + "in": "path", + "description": "tillId", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«PromotionMetaRO»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "transactionEntityIdentifier": { - "type": "string" + "/v1/promotions/{promotionId}/activate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "activate", + "operationId": "activateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "earnId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "transactionIdentifier": { - "type": "string" + "/v1/promotions/{promotionId}/deactivate": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "deactivate", + "operationId": "deactivateUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "earnId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } }, - "transactionNumber": { - "type": "string" - } - }, - "title": "PromotionRedemptionRO" - }, - "PromotionStrategyRO": { - "type": "object", - "required": [ - "promotionRankingStrategies" - ], - "properties": { - "conditionBasedRankingStrategy": { - "type": "string", - "enum": [ - "CART_BASED_FIRST", - "LINE_ITEM_BASED_FIRST" - ] - }, - "decimalRoundingStrategy": { - "$ref": "#/definitions/DecimalRoundingStrategy" - }, - "isActive": { - "type": "boolean" - }, - "mode": { - "type": "string", - "enum": [ - "DISCOUNT", - "PAYMENT_VOUCHER" - ] - }, - "promotionRankingStrategies": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "BEST_COMBINATION", - "EXPIRY_BASED", - "MAX_DISCOUNT", - "MIN_DISCOUNT", - "PRIORITY" - ] - } - }, - "rewardRankingStrategies": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "CODE_FIRST", - "NO_STRATEGY", - "PROMOTION_FIRST", - "REWARDS_FIRST" - ] - } - }, - "rewardStrategy": { - "type": "string", - "enum": [ - "CODE_FIRST", - "NO_STRATEGY", - "PROMOTION_FIRST", - "REWARDS_FIRST" - ] - }, - "singlePromotionPerLineitem": { - "type": "boolean" - } - }, - "title": "PromotionStrategyRO" - }, - "PromotionSummaryRO": { - "type": "object", - "properties": { - "customFieldValues": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "endDate": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "lastEarned": { - "type": "integer", - "format": "int64" - }, - "lastRedeemed": { - "type": "integer", - "format": "int64" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "promotionId": { - "type": "string" - }, - "promotionName": { - "type": "string" - }, - "promotionType": { - "type": "string", - "enum": [ - "CODE", - "CUSTOMER", - "EARNING", - "POS", - "REWARD" - ] - }, - "startDate": { - "type": "integer", - "format": "int64" - }, - "supplementaryCriteria": { - "$ref": "#/definitions/SupplementaryCriteria" - }, - "targetedCustomerCount": { - "type": "integer", - "format": "int64" - }, - "totalDiscount": { - "type": "string" - }, - "totalDiscountAppliedQuantity": { - "type": "number", - "format": "double" - }, - "totalEarned": { - "type": "string" - }, - "totalIssuedCount": { - "type": "integer", - "format": "int64" - }, - "totalPromoCodeCreated": { - "type": "integer", - "format": "int64" - }, - "totalPromotionAppliedQuantity": { - "type": "number", - "format": "double" - }, - "totalRedeemed": { - "type": "integer", - "format": "int64" - }, - "totalTransactions": { - "type": "integer", - "format": "int64" - } - }, - "title": "PromotionSummaryRO" - }, - "PushNotificationCta": { - "type": "object", - "properties": { - "actionLink": { - "type": "string" - }, - "image": { - "type": "string" - }, - "pushNotificationCtaActionList": { - "type": "array", - "items": { - "$ref": "#/definitions/PushNotificationCtaAction" - } - }, - "type": { - "type": "string", - "enum": [ - "DEEP_LINK", - "EXTERNAL_URL" - ] - } - }, - "title": "PushNotificationCta" - }, - "PushNotificationCtaAction": { - "type": "object", - "properties": { - "actionLink": { - "type": "string" - }, - "actionText": { - "type": "string" - }, - "templateCtaId": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "DEEP_LINK", - "EXTERNAL_URL" - ] - } - }, - "title": "PushNotificationCtaAction" - }, - "ResponseWrapper«CartEvaluationRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CartEvaluationRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CartEvaluationRO»" - }, - "ResponseWrapper«CartRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CartRORes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CartRO»" - }, - "ResponseWrapper«CodeBasedPromotionMetaRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CodeBasedPromotionMetaRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CodeBasedPromotionMetaRO»" - }, - "ResponseWrapper«CustomerEarnedPromotionRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«CustomerEarnedPromotionRO»" - }, - "ResponseWrapper«List«AuditLogVersionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/AuditLogVersionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«AuditLogVersionRO»»" - }, - "ResponseWrapper«List«BulkEarnedPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/BulkEarnedPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" - }, - "ResponseWrapper«List«CodeBasedPromotionMetaRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedPromotionMetaRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CodeBasedPromotionMetaRO»»" - }, - "ResponseWrapper«List«CodeBasedPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CodeBasedPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CodeBasedPromotionRO»»" - }, - "ResponseWrapper«List«CustomMetadataFieldRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomMetadataFieldRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CustomMetadataFieldRO»»" - }, - "ResponseWrapper«List«CustomerPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«CustomerPromotionRO»»" - }, - "ResponseWrapper«List«PromotionConfigRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionConfigRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionConfigRO»»" - }, - "ResponseWrapper«List«PromotionExpiryReminderRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionExpiryReminderRO»»" - }, - "ResponseWrapper«List«PromotionMetaRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionMetaRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionMetaRO»»" - }, - "ResponseWrapper«List«PromotionRedemptionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionRedemptionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionRedemptionRO»»" - }, - "ResponseWrapper«List«PromotionSummaryRO»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/PromotionSummaryRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«List«PromotionSummaryRO»»" - }, - "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CustomerEarnedPromotionRO" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" - }, - "ResponseWrapper«PromotionExpiryReminderRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionExpiryReminderRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionExpiryReminderRO»" - }, - "ResponseWrapper«PromotionLanguageRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionLanguageRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionLanguageRO»" - }, - "ResponseWrapper«PromotionMetaRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionMetaRORes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionMetaRO»" - }, - "ResponseWrapper«PromotionStrategyRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PromotionStrategyRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«PromotionStrategyRO»" - }, - "ResponseWrapper«boolean»": { - "type": "object", - "properties": { - "data": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«boolean»" - }, - "ResponseWrapper«object»": { - "type": "object", - "properties": { - "data": { - "type": "object" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiError" - } - } - }, - "title": "ResponseWrapper«object»" - }, - "RestrictionDetailsRO": { - "type": "object", - "properties": { - "kpi": { - "type": "string", - "enum": [ - "DISCOUNT", - "REDEMPTION", - "TRANSACTION" - ] - }, - "maxLimit": { - "type": "number" - }, - "periodEnd": { - "type": "integer", - "format": "int64" - }, - "periodStart": { - "type": "integer", - "format": "int64" - }, - "remainingRedemption": { - "type": "number" - } - }, - "title": "RestrictionDetailsRO" - }, - "RestrictionKPIRO": { - "type": "object", - "properties": { - "frequency": { - "type": "string", - "enum": [ - "DAYS", - "WEEKS" - ] - }, - "kpi": { - "type": "string", - "enum": [ - "DISCOUNT", - "REDEMPTION", - "TRANSACTION" - ] - }, - "limit": { - "type": "string" - }, - "minTimeBetweenRepeat": { - "type": "integer", - "format": "int64" - } - }, - "title": "RestrictionKPIRO" - }, - "RevokeEarnRequest": { - "type": "object", - "required": [ - "customerId" - ], - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "earnRevokeDetails": { - "type": "array", - "items": { - "$ref": "#/definitions/EarnRevokeDetail" - } - } - }, - "title": "RevokeEarnRequest" - }, - "RevokeEarnResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int64" - }, - "message": { - "type": "string" - } - }, - "title": "RevokeEarnResponse" - }, - "StoreCriteria": { - "type": "object", - "required": [ - "operator", - "type", - "values" - ], - "properties": { - "operator": { - "type": "string", - "enum": [ - "IN", - "NOT_IN" - ] - }, - "type": { - "type": "string", - "enum": [ - "CONCEPT", - "STORE", - "ZONE" - ] - }, - "values": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - } - }, - "title": "StoreCriteria" - }, - "SupplementaryCriteria": { - "type": "object", - "required": [ - "loyaltyProgramId", - "partnerProgramId", - "programType" - ], - "properties": { - "loyaltyProgramId": { - "type": "integer", - "format": "int64" - }, - "partnerProgramId": { - "type": "integer", - "format": "int32" - }, - "programType": { - "type": "string", - "enum": [ - "SUBSCRIPTION", - "TIER" - ] - } - }, - "title": "SupplementaryCriteria" - }, - "TenderBasedAction": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ABSOLUTE", - "PERCENTAGE" - ] - }, - "value": { - "type": "string" - } - }, - "title": "TenderBasedAction" - }, - "TenderCondition": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "condition": { - "$ref": "#/definitions/Condition" - }, - "identifier": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "CARD", - "CASH", - "PAYMENT_VOUCHER" - ] - } - }, - "title": "TenderCondition" - }, - "TimeCriteria": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTime" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } - } - }, - "title": "TimeCriteria" - }, - "TimeCriteriaReq": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTimeReq" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } - } - }, - "title": "TimeCriteriaReq" - }, - "TimeCriteriaRes": { - "type": "object", - "properties": { - "durationInHours": { - "type": "integer", - "format": "int32" - }, - "monthlyDayValues": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "repeatFrequency": { - "type": "string", - "enum": [ - "DAYS", - "DOES_NOT_REPEAT", - "WEEKS" - ] - }, - "startTime": { - "$ref": "#/definitions/LocalTimeRes" - }, - "weeklyValues": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "FRIDAY", - "MONDAY", - "SATURDAY", - "SUNDAY", - "THURSDAY", - "TUESDAY", - "WEDNESDAY" - ] - } + "/v1/promotions/{promotionId}/earn": { + "post": { + "tags": [ + "promotion-earning-resource" + ], + "summary": "earnPromotion", + "operationId": "earnPromotionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "customerEarnedPromotion", + "description": "customerEarnedPromotion", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + { + "name": "promotionId", + "in": "path", + "description": "promotionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«CustomerEarnedPromotionRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } } - }, - "title": "TimeCriteriaRes" }, - "UploadedFileRO": { - "type": "object", - "properties": { - "codeColumnIndex": { - "type": "integer", - "format": "int32" - }, - "containsHeader": { - "type": "boolean" - }, - "fileHandle": { - "type": "string" + "definitions": { + "Action": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartBasedAction": { + "$ref": "#/definitions/CartBasedAction" + }, + "fixedPriceAction": { + "$ref": "#/definitions/FixedPriceAction" + }, + "freeProductAction": { + "$ref": "#/definitions/FreeProductAction" + }, + "productBasedAction": { + "$ref": "#/definitions/ProductBasedAction" + }, + "tenderBasedAction": { + "$ref": "#/definitions/TenderBasedAction" + }, + "type": { + "type": "string", + "enum": [ + "CART_BASED", + "FIXED_PRICE", + "FREE_PRODUCT", + "PRODUCT_BASED", + "TENDER" + ] + } + }, + "title": "Action" + }, + "ApiError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "message": { + "type": "string" + } + }, + "title": "ApiError" + }, + "AppliedPromotionRO": { + "type": "object", + "properties": { + "discount": { + "type": "string" + }, + "discountAppliedOnQuantity": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "messageLabel": { + "type": "string" + }, + "name": { + "type": "string" + }, + "promoCode": { + "type": "string" + }, + "promotionAppliedOnQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "promotionMode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "redeemableVoucherValue": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + }, + "tenderIdentifier": { + "type": "string" + }, + "tenderType": { + "type": "string", + "enum": [ + "CARD", + "CASH", + "PAYMENT_VOUCHER" + ] + }, + "totalVoucherValue": { + "type": "string" + } + }, + "title": "AppliedPromotionRO" + }, + "AuditLogVersionRO": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "triggeredBy": { + "type": "integer", + "format": "int64" + }, + "triggeredOn": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + } + }, + "title": "AuditLogVersionRO" + }, + "BulkEarnRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnedPromotion" + } + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + } + }, + "title": "BulkEarnRO" + }, + "BulkEarnedPromotionRO": { + "type": "object", + "properties": { + "customerEarnedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "earnedFromId": { + "type": "string" + }, + "errorDetails": { + "$ref": "#/definitions/ErrorDetails" + }, + "failedEarnCount": { + "type": "integer", + "format": "int32" + }, + "promotionId": { + "type": "string" + }, + "successfulEarnCount": { + "type": "integer", + "format": "int32" + } + }, + "title": "BulkEarnedPromotionRO" + }, + "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/RevokeEarnResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnRevokeError" + } + } + }, + "title": "BulkResponseWrapper«RevokeEarnResponse,EarnRevokeError»" + }, + "CartBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartBasedAction" + }, + "CartCondition": { + "type": "object", + "required": [ + "kpi", + "operator", + "value" + ], + "properties": { + "kpi": { + "type": "string", + "enum": [ + "ITEMCOUNT", + "SUBTOTAL" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "CartCondition" + }, + "CartEvaluationRO": { + "type": "object", + "properties": { + "cartRO": { + "$ref": "#/definitions/CartRO" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "evaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionLogRO" + } + }, + "id": { + "type": "string" + }, + "isRedeemed": { + "type": "boolean" + } + }, + "title": "CartEvaluationRO" + }, + "CartItemRO": { + "type": "object", + "required": [ + "amount", + "qty", + "sku" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "brandList": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryList": { + "type": "array", + "items": { + "type": "string" + } + }, + "discount": { + "type": "string" + }, + "qty": { + "type": "string" + }, + "referenceId": { + "type": "string" + }, + "sku": { + "type": "string" + } + }, + "title": "CartItemRO" + }, + "CartRO": { + "type": "object", + "required": [ + "amount", + "cartItems" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPaymentVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "evaluationId": { + "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLog" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLog" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "CartRO" + }, + "CartROReq": { + "type": "object", + "required": [ + "amount", + "cartItems" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPaymentVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "evaluationId": { + "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogReq" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogReq" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "CartROReq" + }, + "CartRORes": { + "type": "object", + "required": [ + "amount", + "cartItems" + ], + "properties": { + "amount": { + "type": "string" + }, + "appliedPaymentVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "appliedPromotions": { + "type": "array", + "items": { + "$ref": "#/definitions/AppliedPromotionRO" + } + }, + "cartItems": { + "type": "array", + "items": { + "$ref": "#/definitions/CartItemRO" + } + }, + "cartTenders": { + "type": "array", + "items": { + "$ref": "#/definitions/CartTenderRO" + } + }, + "categoryHierarchySentInPayload": { + "type": "boolean" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "evaluationId": { + "type": "string" + }, + "paymentVoucherEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogRes" + } + }, + "paymentVouchers": { + "type": "array", + "items": { + "type": "string" + } + }, + "promoCodeEvaluationLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedEvaluationLogRes" + } + }, + "promoCodes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "CartRORes" + }, + "CartTenderRO": { + "type": "object", + "required": [ + "identifier" + ], + "properties": { + "adjustedAmount": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "identifier": { + "type": "string" + } + }, + "title": "CartTenderRO" + }, + "CodeBasedEvaluationLog": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLog" + }, + "CodeBasedEvaluationLogReq": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLogReq" + }, + "CodeBasedEvaluationLogRes": { + "type": "object", + "properties": { + "codeType": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + } + }, + "title": "CodeBasedEvaluationLogRes" + }, + "CodeBasedPromotionMetaRO": { + "type": "object", + "required": [ + "codeJobType" + ], + "properties": { + "codeJobType": { + "type": "string", + "enum": [ + "AUTO_GENERATED", + "UPLOADED" + ] + }, + "codeLength": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 40, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "errorFileHandle": { + "type": "string" + }, + "errorMessages": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "isAlphaNumeric": { + "type": "boolean" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "savedCount": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string", + "enum": [ + "COMPLETED", + "ERRORED", + "GENERATING_CODE", + "OPEN", + "UPLOADING" + ] + }, + "successFileHandle": { + "type": "string" + }, + "totalCount": { + "type": "integer", + "format": "int64", + "maximum": 10000000, + "exclusiveMaximum": false + }, + "uploadedFile": { + "$ref": "#/definitions/UploadedFileRO" + } + }, + "title": "CodeBasedPromotionMetaRO" + }, + "CodeBasedPromotionRO": { + "type": "object", + "properties": { + "active": { + "type": "boolean" + }, + "apiError": { + "$ref": "#/definitions/ApiError" + }, + "code": { + "type": "string" + }, + "createdOn": { + "type": "integer", + "format": "int64" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "restrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionDetailsRO" + } + } + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CodeBasedPromotionRO" + }, + "ComboProductConditionRO": { + "type": "object", + "required": [ + "productConditions" + ], + "properties": { + "productConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductCondition" + } + } + }, + "title": "ComboProductConditionRO" + }, + "CommunicationChannelRO": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "channelType": { + "type": "string", + "enum": [ + "ANDROID", + "EMAIL", + "IOS", + "SMS" + ] + }, + "domainPropertyId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "pushNotificationCta": { + "$ref": "#/definitions/PushNotificationCtaRO" + }, + "senderCDMA": { + "type": "string" + }, + "senderEmail": { + "type": "string" + }, + "senderGSM": { + "type": "string" + }, + "senderLabel": { + "type": "string" + }, + "senderReplyToEmail": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "unsubscribeLabel": { + "type": "string" + } + }, + "title": "CommunicationChannelRO" + }, + "Condition": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "cartCondition": { + "$ref": "#/definitions/CartCondition" + }, + "comboProductCondition": { + "$ref": "#/definitions/ComboProductConditionRO" + }, + "productCondition": { + "$ref": "#/definitions/ProductCondition" + }, + "tenderCondition": { + "$ref": "#/definitions/TenderCondition" + }, + "type": { + "type": "string", + "enum": [ + "CART", + "COMBO_PRODUCT", + "PRODUCT", + "TENDER" + ] + } + }, + "title": "Condition" + }, + "CustomMetadataFieldRO": { + "type": "object", + "required": [ + "dataType", + "fieldName" + ], + "properties": { + "dataType": { + "type": "string", + "enum": [ + "DATE", + "NUMBER", + "STRING" + ] + }, + "fieldName": { + "type": "string" + }, + "isRequired": { + "type": "boolean" + } + }, + "title": "CustomMetadataFieldRO" + }, + "CustomerEarnedPromotionRO": { + "type": "object", + "required": [ + "customerId", + "earnedFromId", + "earnedFromType", + "eventDetails", + "eventTime" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "errorDetails": { + "$ref": "#/definitions/ErrorDetails" + }, + "eventDetails": { + "$ref": "#/definitions/EventDetailsRO" + }, + "eventTime": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerEarnedPromotionRO" + }, + "CustomerPromotionRO": { + "type": "object", + "properties": { + "applicationMode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "code": { + "type": "string" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnedFromId": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "earnedStatus": { + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED" + ] + }, + "earnedType": { + "type": "string", + "enum": [ + "CODE", + "MILESTONE_EARN", + "NONE", + "REWARD", + "SINGLE_ACTIVITY_EARN", + "SUBSCRIPTION", + "TIER" + ] + }, + "mileStoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionStatus": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + }, + "restrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionDetailsRO" + } + } + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "unlockedDate": { + "type": "integer", + "format": "int64" + }, + "validTill": { + "type": "integer", + "format": "int64" + } + }, + "title": "CustomerPromotionRO" + }, + "DecimalRoundingStrategy": { + "type": "object", + "properties": { + "decimalPlaces": { + "type": "integer", + "format": "int32" + }, + "roundingMode": { + "type": "string", + "enum": [ + "CEILING", + "DOWN", + "FLOOR", + "HALF_DOWN", + "HALF_EVEN", + "HALF_UP", + "UNNECESSARY", + "UP" + ] + } + }, + "title": "DecimalRoundingStrategy" + }, + "Duration": { + "type": "object", + "properties": { + "period": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "DAYS", + "HOURS", + "MINUTES" + ] + } + }, + "title": "Duration" + }, + "EarnRevokeDetail": { + "type": "object", + "required": [ + "promotionId" + ], + "properties": { + "earnIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnRevokeDetail" + }, + "EarnRevokeError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "earnIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnRevokeError" + }, + "EarnedPromotion": { + "type": "object", + "required": [ + "earnCount", + "earnedFromId", + "promotionId" + ], + "properties": { + "earnCount": { + "type": "integer", + "format": "int32" + }, + "earnedFromId": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "EarnedPromotion" + }, + "EarningCriteriaRO": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + } + }, + "title": "EarningCriteriaRO" + }, + "EarningCriteriaROReq": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + } + }, + "title": "EarningCriteriaROReq" + }, + "EarningCriteriaRORes": { + "type": "object", + "required": [ + "earnedFromType" + ], + "properties": { + "active": { + "type": "boolean" + }, + "criteriaDsl": { + "type": "string" + }, + "criteriaDslJson": { + "type": "string" + }, + "criteriaName": { + "type": "string" + }, + "duration": { + "$ref": "#/definitions/Duration" + }, + "earnedFromType": { + "type": "string", + "enum": [ + "ACTIVITY", + "BULK_ISSUE", + "MILESTONE", + "REWARD" + ] + }, + "earningValidTillDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false + }, + "eventType": { + "type": "string", + "enum": [ + "CustomerRegistration", + "CustomerUpdate", + "TransactionAdd" + ] + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + } + }, + "title": "EarningCriteriaRORes" + }, + "ErrorDetails": { + "type": "object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int64" + }, + "errorMessages": { + "type": "string" + } + }, + "title": "ErrorDetails" + }, + "EventDetailsRO": { + "type": "object", + "properties": { + "eventPayload": { + "type": "object" + }, + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "title": "EventDetailsRO" + }, + "FixedPriceAction": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "value": { + "type": "string" + } + }, + "title": "FixedPriceAction" + }, + "FreeProductAction": { + "type": "object", + "required": [ + "productBasedCondition" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + } + }, + "title": "FreeProductAction" + }, + "LanguageDescription": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "CUSTOM", + "STANDARD" + ] + }, + "value": { + "type": "string" + } + }, + "title": "LanguageDescription" + }, + "LocalTime": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTime" + }, + "LocalTimeReq": { + "type": "object", + "properties": { + "hour": { + "type": "string", + "format": "byte" + }, + "minute": { + "type": "string", + "format": "byte" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "string", + "format": "byte" + } + }, + "title": "LocalTimeReq" + }, + "LocalTimeRes": { + "type": "object", + "properties": { + "hour": { + "type": "integer", + "format": "int32" + }, + "minute": { + "type": "integer", + "format": "int32" + }, + "nano": { + "type": "integer", + "format": "int32" + }, + "second": { + "type": "integer", + "format": "int32" + } + }, + "title": "LocalTimeRes" + }, + "MultiLanguageDetails": { + "type": "object", + "required": [ + "languageCode", + "languageDescriptionList" + ], + "properties": { + "languageCode": { + "type": "string" + }, + "languageDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageDescription" + } + } + }, + "title": "MultiLanguageDetails" + }, + "ProductBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "productBasedCondition": { + "$ref": "#/definitions/Condition" + }, + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductBasedAction" + }, + "ProductCondition": { + "type": "object", + "required": [ + "criteriaList", + "kpi" + ], + "properties": { + "criteriaList": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductSelectionCriteriaRO" + } + }, + "kpi": { + "type": "string", + "enum": [ + "AMOUNT", + "NONE", + "QUANTITY" + ] + }, + "operator": { + "type": "string", + "enum": [ + "EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "IN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NONE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "ProductCondition" + }, + "ProductSelectionCriteriaRO": { + "type": "object", + "required": [ + "entity", + "values" + ], + "properties": { + "attributeName": { + "type": "string" + }, + "entity": { + "type": "string", + "enum": [ + "ATTRIBUTE", + "BRAND", + "CATEGORY", + "SKU" + ] + }, + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "ProductSelectionCriteriaRO" + }, + "PromotionConfigRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "expiry": { + "type": "integer", + "format": "int64" + }, + "groupId": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "milestoneId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "promotionType": { + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "reward": { + "type": "string" + }, + "ruleId": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + } + }, + "title": "PromotionConfigRO" + }, + "PromotionExpiryReminderRO": { + "type": "object", + "required": [ + "communicationChannels", + "numberOfDaysBeforeExpiry" + ], + "properties": { + "active": { + "type": "boolean" + }, + "communicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "integer", + "format": "int64" + }, + "numberOfDaysBeforeExpiry": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionExpiryReminderRO" + }, + "PromotionLanguageRO": { + "type": "object", + "required": [ + "entity", + "entityId", + "multiLanguageDetails" + ], + "properties": { + "entity": { + "type": "string", + "enum": [ + "PROMOTION_META" + ] + }, + "entityId": { + "type": "string" + }, + "multiLanguageDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiLanguageDetails" + } + } + }, + "title": "PromotionLanguageRO" + }, + "PromotionLogRO": { + "type": "object", + "properties": { + "earnedPromotionId": { + "type": "string" + }, + "evaluationStatus": { + "type": "boolean" + }, + "logType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "promoCode": { + "type": "string" + }, + "promotionId": { + "type": "string" + } + }, + "title": "PromotionLogRO" + }, + "PromotionMetaRO": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRO" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "isLoyaltyOnly": { + "type": "boolean" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "messageLabel": { + "type": "string" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteria" + }, + "type": { + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRO" + }, + "PromotionMetaROReq": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaROReq" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "isLoyaltyOnly": { + "type": "boolean" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "messageLabel": { + "type": "string" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaReq" + }, + "type": { + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaROReq" + }, + "PromotionMetaRORes": { + "type": "object", + "required": [ + "action", + "campaignId", + "endDate", + "name", + "startDate", + "type" + ], + "properties": { + "action": { + "$ref": "#/definitions/Action" + }, + "active": { + "type": "boolean" + }, + "campaignId": { + "type": "integer", + "format": "int64" + }, + "condition": { + "$ref": "#/definitions/Condition" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "customerActivationRequired": { + "type": "boolean" + }, + "earnLimitedToSpecificAudience": { + "type": "boolean" + }, + "earningCriteria": { + "$ref": "#/definitions/EarningCriteriaRORes" + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "isLoyaltyOnly": { + "type": "boolean" + }, + "languagesConfigured": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedBy": { + "type": "integer", + "format": "int64" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time" + }, + "loyaltyEarningExpiryDays": { + "type": "integer", + "format": "int32" + }, + "maxEarningPerCustomer": { + "type": "integer", + "format": "int32" + }, + "maxIssuancePerCustomer": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 10, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "messageLabel": { + "type": "string" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "onEarnCommunicationChannels": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CommunicationChannelRO" + } + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "promotionRestrictions": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RestrictionKPIRO" + } + } + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "storeCriteria": { + "$ref": "#/definitions/StoreCriteria" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "timeCriteria": { + "$ref": "#/definitions/TimeCriteriaRes" + }, + "type": { + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + } + }, + "title": "PromotionMetaRORes" + }, + "PromotionRedemptionRO": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "cartEvaluationId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "discount": { + "type": "string" + }, + "discountAppliedQuantity": { + "type": "string" + }, + "earnedPromotionId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "productId": { + "type": "integer", + "format": "int64" + }, + "promoCode": { + "type": "string" + }, + "promotionAppliedQuantity": { + "type": "string" + }, + "promotionId": { + "type": "string" + }, + "promotionMessageLabel": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "redemptionCount": { + "type": "integer", + "format": "int64" + }, + "redemptionDate": { + "type": "string", + "format": "date-time" + }, + "redemptionTill": { + "type": "integer", + "format": "int64" + }, + "redemptionType": { + "type": "string", + "enum": [ + "CART", + "LINEITEM", + "PAYMENT_VOUCHER" + ] + }, + "sku": { + "type": "string" + }, + "taxEntityId": { + "type": "string" + }, + "transactionEntityIdentifier": { + "type": "string" + }, + "transactionIdentifier": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PromotionRedemptionRO" + }, + "PromotionStrategyRO": { + "type": "object", + "required": [ + "promotionRankingStrategies" + ], + "properties": { + "conditionBasedRankingStrategy": { + "type": "string", + "enum": [ + "CART_BASED_FIRST", + "LINE_ITEM_BASED_FIRST" + ] + }, + "decimalRoundingStrategy": { + "$ref": "#/definitions/DecimalRoundingStrategy" + }, + "isActive": { + "type": "boolean" + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + }, + "promotionRankingStrategies": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "BEST_COMBINATION", + "EXPIRY_BASED", + "MAX_DISCOUNT", + "MIN_DISCOUNT", + "PRIORITY" + ] + } + }, + "rewardRankingStrategies": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "CODE_FIRST", + "NO_STRATEGY", + "PROMOTION_FIRST", + "REWARDS_FIRST" + ] + } + }, + "rewardStrategy": { + "type": "string", + "enum": [ + "CODE_FIRST", + "NO_STRATEGY", + "PROMOTION_FIRST", + "REWARDS_FIRST" + ] + }, + "singlePromotionPerLineitem": { + "type": "boolean" + } + }, + "title": "PromotionStrategyRO" + }, + "PromotionSummaryRO": { + "type": "object", + "properties": { + "customFieldValues": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "endDate": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "lastEarned": { + "type": "integer", + "format": "int64" + }, + "lastRedeemed": { + "type": "integer", + "format": "int64" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "promotionId": { + "type": "string" + }, + "promotionName": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "CODE", + "CUSTOMER", + "EARNING", + "POS", + "REWARD" + ] + }, + "startDate": { + "type": "integer", + "format": "int64" + }, + "supplementaryCriteria": { + "$ref": "#/definitions/SupplementaryCriteria" + }, + "targetedCustomerCount": { + "type": "integer", + "format": "int64" + }, + "totalDiscount": { + "type": "string" + }, + "totalDiscountAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalEarned": { + "type": "string" + }, + "totalIssuedCount": { + "type": "integer", + "format": "int64" + }, + "totalPromoCodeCreated": { + "type": "integer", + "format": "int64" + }, + "totalPromotionAppliedQuantity": { + "type": "number", + "format": "double" + }, + "totalRedeemed": { + "type": "integer", + "format": "int64" + }, + "totalTransactions": { + "type": "integer", + "format": "int64" + } + }, + "title": "PromotionSummaryRO" + }, + "PushNotificationCtaActionRO": { + "type": "object", + "properties": { + "actionLink": { + "type": "string" + }, + "actionText": { + "type": "string" + }, + "templateCtaId": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "DEEP_LINK", + "EXTERNAL_URL" + ] + } + }, + "title": "PushNotificationCtaActionRO" + }, + "PushNotificationCtaRO": { + "type": "object", + "properties": { + "actionLink": { + "type": "string" + }, + "image": { + "type": "string" + }, + "pushNotificationCtaActionList": { + "type": "array", + "items": { + "$ref": "#/definitions/PushNotificationCtaActionRO" + } + }, + "type": { + "type": "string", + "enum": [ + "DEEP_LINK", + "EXTERNAL_URL" + ] + } + }, + "title": "PushNotificationCtaRO" + }, + "ResponseWrapper«CartEvaluationRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartEvaluationRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartEvaluationRO»" + }, + "ResponseWrapper«CartRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CartRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CartRO»" + }, + "ResponseWrapper«CodeBasedPromotionMetaRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CodeBasedPromotionMetaRO»" + }, + "ResponseWrapper«CodeBasedPromotionRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CodeBasedPromotionRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CodeBasedPromotionRO»" + }, + "ResponseWrapper«CustomerEarnedPromotionRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«CustomerEarnedPromotionRO»" + }, + "ResponseWrapper«List«AuditLogVersionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/AuditLogVersionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«AuditLogVersionRO»»" + }, + "ResponseWrapper«List«BulkEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/BulkEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«BulkEarnedPromotionRO»»" + }, + "ResponseWrapper«List«CodeBasedPromotionMetaRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedPromotionMetaRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CodeBasedPromotionMetaRO»»" + }, + "ResponseWrapper«List«CodeBasedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeBasedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CodeBasedPromotionRO»»" + }, + "ResponseWrapper«List«CustomMetadataFieldRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetadataFieldRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomMetadataFieldRO»»" + }, + "ResponseWrapper«List«CustomerPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«CustomerPromotionRO»»" + }, + "ResponseWrapper«List«PromotionConfigRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionConfigRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionConfigRO»»" + }, + "ResponseWrapper«List«PromotionExpiryReminderRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionExpiryReminderRO»»" + }, + "ResponseWrapper«List«PromotionMetaRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionMetaRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionMetaRO»»" + }, + "ResponseWrapper«List«PromotionRedemptionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionRedemptionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionRedemptionRO»»" + }, + "ResponseWrapper«List«PromotionSummaryRO»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/PromotionSummaryRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«List«PromotionSummaryRO»»" + }, + "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomerEarnedPromotionRO" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«Map«long,CustomerEarnedPromotionRO»»" + }, + "ResponseWrapper«PromotionExpiryReminderRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionExpiryReminderRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionExpiryReminderRO»" + }, + "ResponseWrapper«PromotionLanguageRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionLanguageRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionLanguageRO»" + }, + "ResponseWrapper«PromotionMetaRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionMetaRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionMetaRO»" + }, + "ResponseWrapper«PromotionStrategyRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PromotionStrategyRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«PromotionStrategyRO»" + }, + "ResponseWrapper«boolean»": { + "type": "object", + "properties": { + "data": { + "type": "boolean" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«boolean»" + }, + "ResponseWrapper«object»": { + "type": "object", + "properties": { + "data": { + "type": "object" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiError" + } + } + }, + "title": "ResponseWrapper«object»" + }, + "RestrictionDetailsRO": { + "type": "object", + "properties": { + "kpi": { + "type": "string", + "enum": [ + "DISCOUNT", + "REDEMPTION", + "TRANSACTION" + ] + }, + "maxLimit": { + "type": "string" + }, + "periodEnd": { + "type": "integer", + "format": "int64" + }, + "periodStart": { + "type": "integer", + "format": "int64" + }, + "remainingRedemption": { + "type": "string" + } + }, + "title": "RestrictionDetailsRO" + }, + "RestrictionKPIRO": { + "type": "object", + "properties": { + "frequency": { + "type": "string", + "enum": [ + "DAYS", + "WEEKS" + ] + }, + "kpi": { + "type": "string", + "enum": [ + "DISCOUNT", + "REDEMPTION", + "TRANSACTION" + ] + }, + "limit": { + "type": "string" + }, + "minTimeBetweenRepeat": { + "type": "integer", + "format": "int64" + } + }, + "title": "RestrictionKPIRO" + }, + "RevokeEarnRequest": { + "type": "object", + "required": [ + "customerId" + ], + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "earnRevokeDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/EarnRevokeDetail" + } + } + }, + "title": "RevokeEarnRequest" + }, + "RevokeEarnResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int64" + }, + "message": { + "type": "string" + } + }, + "title": "RevokeEarnResponse" + }, + "SaveCodeRequest": { + "type": "object", + "required": [ + "code", + "customerId", + "mode" + ], + "properties": { + "code": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64", + "minimum": 1, + "exclusiveMinimum": false + }, + "mode": { + "type": "string", + "enum": [ + "DISCOUNT", + "PAYMENT_VOUCHER" + ] + } + }, + "title": "SaveCodeRequest" + }, + "StoreCriteria": { + "type": "object", + "required": [ + "operator", + "type", + "values" + ], + "properties": { + "operator": { + "type": "string", + "enum": [ + "IN", + "NOT_IN" + ] + }, + "type": { + "type": "string", + "enum": [ + "CONCEPT", + "STORE", + "ZONE" + ] + }, + "values": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + "title": "StoreCriteria" + }, + "SupplementaryCriteria": { + "type": "object", + "required": [ + "loyaltyProgramId", + "partnerProgramId", + "programType" + ], + "properties": { + "loyaltyProgramId": { + "type": "integer", + "format": "int64" + }, + "partnerProgramId": { + "type": "integer", + "format": "int32" + }, + "programType": { + "type": "string", + "enum": [ + "SUBSCRIPTION", + "TIER" + ] + } + }, + "title": "SupplementaryCriteria" + }, + "TenderBasedAction": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "ABSOLUTE", + "PERCENTAGE" + ] + }, + "value": { + "type": "string" + } + }, + "title": "TenderBasedAction" + }, + "TenderCondition": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "condition": { + "$ref": "#/definitions/Condition" + }, + "identifier": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "CARD", + "CASH", + "PAYMENT_VOUCHER" + ] + } + }, + "title": "TenderCondition" + }, + "TimeCriteria": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTime" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteria" + }, + "TimeCriteriaReq": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeReq" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteriaReq" + }, + "TimeCriteriaRes": { + "type": "object", + "properties": { + "durationInHours": { + "type": "integer", + "format": "int32" + }, + "monthlyDayValues": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "repeatFrequency": { + "type": "string", + "enum": [ + "DAYS", + "DOES_NOT_REPEAT", + "WEEKS" + ] + }, + "startTime": { + "$ref": "#/definitions/LocalTimeRes" + }, + "weeklyValues": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "FRIDAY", + "MONDAY", + "SATURDAY", + "SUNDAY", + "THURSDAY", + "TUESDAY", + "WEDNESDAY" + ] + } + } + }, + "title": "TimeCriteriaRes" + }, + "UploadedFileRO": { + "type": "object", + "properties": { + "codeColumnIndex": { + "type": "integer", + "format": "int32" + }, + "containsHeader": { + "type": "boolean" + }, + "fileHandle": { + "type": "string" + } + }, + "title": "UploadedFileRO" } - }, - "title": "UploadedFileRO" } - } } From d2a225fdd85d8ddc125060cf26728b4daf9f816e Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:10:54 +0530 Subject: [PATCH 130/150] Create swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 43 +++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 swagger_orchestrator_sdk.sh diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh new file mode 100644 index 00000000000..aea35a69876 --- /dev/null +++ b/swagger_orchestrator_sdk.sh @@ -0,0 +1,43 @@ +if $Build_Codegen; then + mvn3 clean package -Dmaven.test.skip=true +fi + +echo "{\"artifactVersion\":\"1.42-SNAPSHOT\"}" >config.json +echo "GENERATING SDK" + +if [ "$Branch" = "snapshot" ]; then + url="https://orchestratoradmin.crm-nightly-new.cctools.capillarytech.com/v3/api-docs" + version="https://orchestratoradmin.crm-nightly-new.cctools.capillarytech.com/v3/meta/version" +elif [ "$Branch" = "production" ]; then + url="https://orchestratoradmin.crm-staging-new.cctools.capillarytech.com/v2/api-docs" + version="https://orchestratoradmin.crm-staging-new.cctools.capillarytech.com/v3/meta/version" +else + "No Branch is selected" +fi + +if [ "$Client" = "java" ]; then + rm -rf promotion_engine/java_client/java + mkdir -p promotion_engine/java_client/java + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i promotion-engine.json \ + -l java \ + -DdateLibrary=java11 \ + -o promotion_engine/java_client/java \ + -c config.json --group-id com.capillary.promotion.engine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk + tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . + mvn3 clean deploy -f promotion_engine/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_promotion_engine" + +elif [ "$Client" = "php" ]; then + rm -rf orchestrator/php_client/php + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i orchestrator.json \ + -l php \ + -o orchestrator/php_client/php \ + -c config_php.json + tar cvzf orchestrator/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./orchestrator/php_client/php/ . + fpm -f -s "dir" -t "deb" -a "all" -n "swagger-orchestrator-sdk" -v $BUILD_NUMBER -C ./orchestrator/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-orchestrator-sdk" +else + "no client is selected" +fi +echo "SWAGGER SDK SUCCESSFULLY GENERATED" From 32499fd1919d5aa1e5453dbf654e3d7bffd11a72 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:12:42 +0530 Subject: [PATCH 131/150] Create orchestrator.json --- orchestrator.json | 4934 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 4934 insertions(+) create mode 100644 orchestrator.json diff --git a/orchestrator.json b/orchestrator.json new file mode 100644 index 00000000000..4485b90910d --- /dev/null +++ b/orchestrator.json @@ -0,0 +1,4934 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Api Documentation", + "description": "Api Documentation", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + }, + "version": "1.0" + }, + "servers": [ + { + "url": "http://localhost:8100", + "description": "Inferred Url" + } + ], + "tags": [ + { + "name": "_2c-2p-callback-resource", + "description": "_2c 2p Callback Resource" + }, + { + "name": "admin-workflow-resource", + "description": "Admin Workflow Resource" + }, + { + "name": "basic-error-controller", + "description": "Basic Error Controller" + }, + { + "name": "cancel-sandbox", + "description": "Cancel Sandbox" + }, + { + "name": "eghl-call-back-resource", + "description": "Eghl Call Back Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "mobile-card-registration-resource", + "description": "Mobile Card Registration Resource" + }, + { + "name": "operation-handler", + "description": "Operation Handler" + }, + { + "name": "payments-resource", + "description": "Payments Resource" + }, + { + "name": "psp-callback-resource", + "description": "Psp Callback Resource" + }, + { + "name": "psp-performance-resource", + "description": "Psp Performance Resource" + }, + { + "name": "psp-reconciliation", + "description": "PSP Reconciliation" + }, + { + "name": "pump-life-cycle-resource", + "description": "Pump Life Cycle Resource" + }, + { + "name": "pump-performance-resource", + "description": "Pump Performance Resource" + }, + { + "name": "shell-server-to-server-resource", + "description": "Shell Server To Server Resource" + }, + { + "name": "test-fuelling-workflow-resource", + "description": "Test Fuelling Workflow Resource" + }, + { + "name": "transaction-status-resource", + "description": "Transaction Status Resource" + }, + { + "name": "txn-status-resource", + "description": "Txn Status Resource" + }, + { + "name": "web-mvc-links-handler", + "description": "Web Mvc Links Handler" + } + ], + "paths": { + "/orchestrator/payments/webhooks/2c2p/fuelling-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "fuellingCallBack", + "operationId": "fuellingCallBackUsingPOST", + "parameters": [ + { + "name": "defaultCard", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "boolean" + } + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + }, + { + "name": "orgId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + }, + { + "name": "userId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_2c2pCallbackRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/webhooks/2c2p/register-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "registerCallBack", + "operationId": "registerCallBackUsingPOST", + "parameters": [ + { + "name": "defaultCard", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "boolean" + } + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + }, + { + "name": "orgId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + }, + { + "name": "userId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_2c2pCallbackRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/workflow": { + "get": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "get", + "operationId": "getUsingGET", + "parameters": [ + { + "name": "allVersions", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "boolean" + } + }, + { + "name": "name", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetEntityResponse" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "create", + "operationId": "createUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowProcess" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleResponse«WorkFlowCreationResponse»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/workflow/promotion": { + "put": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "promoteWorkFlow", + "operationId": "promoteWorkFlowUsingPUT", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkFlowPromote" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UpdatedEntityResponse" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/error": { + "get": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingGET", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPUT", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "post": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPOST", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "delete": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingDELETE", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "options": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingOPTIONS", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "head": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingHEAD", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "patch": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPATCH", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "trace": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingTRACE", + "responses": { + "200": { + "description": "OK", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ModelAndView" + } + } + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/orchestrator/payments/v1/site/cancel": { + "post": { + "tags": [ + "cancel-sandbox" + ], + "summary": "cancel", + "operationId": "cancelUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/webhooks/eghl/callback": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "saveToken", + "operationId": "saveTokenUsingPOST", + "parameters": [ + { + "name": "shouldSave", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/webhooks/eghl/payment-identifier": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenizeRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/webhooks/eghl/transaction": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "callback", + "operationId": "callbackUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/ping": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "application health check", + "operationId": "healthCheckUsingGET", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/register-paymentIdV1": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "registerPaymentId", + "operationId": "registerPaymentIdUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CardRegisterROReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«CardRegisterRO»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/register-paymentId": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "generatePaymentIdentifier", + "operationId": "generatePaymentIdentifierUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenizeRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/actuator/health": { + "get": { + "tags": [ + "operation-handler" + ], + "summary": "handle", + "operationId": "handleUsingGET", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v3+json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json": { + "schema": { + "type": "object" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/actuator/health/**": { + "get": { + "tags": [ + "operation-handler" + ], + "summary": "handle", + "operationId": "handleUsingGET_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v3+json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json": { + "schema": { + "type": "object" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/actuator/info": { + "get": { + "tags": [ + "operation-handler" + ], + "summary": "handle", + "operationId": "handleUsingGET_2", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v3+json": { + "schema": { + "type": "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json": { + "schema": { + "type": "object" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/actuator/prometheus": { + "get": { + "tags": [ + "operation-handler" + ], + "summary": "handle", + "operationId": "handleUsingGET_3", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain;version=0.0.4;charset=utf-8": { + "schema": { + "type": "object" + } + }, + "application/openmetrics-text;version=1.0.0;charset=utf-8": { + "schema": { + "type": "object" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/workflow/shell/billing/evaluateOffer": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "evaluateOffers", + "operationId": "evaluateOffersUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OfferEvaluationReq" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleResponse«OfferEvaluation»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/workflow/shell/billing/transactionAdd": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "txnAdd", + "operationId": "txnAddUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionAddRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionAddResponse" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1/workflow/psp/payment-identifier": { + "post": { + "tags": [ + "psp-callback-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenizeRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/failure-rate/bank": { + "get": { + "tags": [ + "psp-performance-resource" + ], + "summary": "pspStat", + "operationId": "pspStatUsingGET", + "parameters": [ + { + "name": "bankName", + "in": "query", + "required": false, + "style": "pipeDelimited", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "durationHours", + "in": "query", + "required": false, + "style": "form", + "schema": { + "maximum": 12, + "exclusiveMaximum": false, + "type": "integer", + "format": "int32" + } + }, + { + "name": "psp", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/StatResponse«Map«string,PerformanceBo»»" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/reconciliation/capture": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationCapture", + "operationId": "reconciliationCaptureUsingPOST", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/reconciliation/registration-reversal": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationRegistrationReversal", + "operationId": "reconciliationRegistrationReversalUsingPOST", + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/pump-activate": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "activatePump", + "operationId": "activatePumpUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreAuthorizeStep" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«PreAuthorizeStep»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/pump-cancel": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "cancelPump", + "operationId": "cancelPumpUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CancelResponse" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/pump-reserve": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "pumpReserve", + "operationId": "pumpReserveUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PumpReserve" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«PumpReserve»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/failure-rate/pump": { + "get": { + "tags": [ + "pump-performance-resource" + ], + "summary": "pumpStat", + "operationId": "pumpStatUsingGET", + "parameters": [ + { + "name": "durationHours", + "in": "query", + "required": false, + "style": "form", + "schema": { + "maximum": 12, + "exclusiveMaximum": false, + "type": "integer", + "format": "int32" + } + }, + { + "name": "siteId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/StatResponse«Map«string,PerformanceBo»»" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/v1/site/finalize-txn": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "finalizeTransaction", + "operationId": "finalizeTransactionUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionAddRO" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/v1/site/get-offers": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "offerEvaluation", + "operationId": "offerEvaluationUsingPOST", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OfferEvaluation" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/OfferEvaluation" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/pumpReserve/{version}": { + "post": { + "tags": [ + "test-fuelling-workflow-resource" + ], + "summary": "pumpReserveWithGivenVersion", + "operationId": "pumpReserveWithGivenVersionUsingPOST", + "parameters": [ + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PumpReserve" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MobileResponseBody«PumpReserve»" + } + } + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/app/v1/fuelling-status": { + "get": { + "tags": [ + "transaction-status-resource" + ], + "summary": "status", + "operationId": "statusUsingGET", + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": true, + "style": "form", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "paymentId", + "in": "query", + "required": false, + "style": "form", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AppTransactionStatusResponse" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "getStatusByPaymentId", + "operationId": "getStatusByPaymentIdUsingGET", + "parameters": [ + { + "name": "paymentId", + "in": "path", + "description": "paymentId", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleResponse«TxnStatusBo»" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/orchestrator/payments/intouch/txn-status/user-id/{userId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "getStatusByUserId", + "operationId": "getStatusByUserIdUsingGET", + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "userId", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SingleResponse«UserTxnsBo»" + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/actuator": { + "get": { + "tags": [ + "web-mvc-links-handler" + ], + "summary": "links", + "operationId": "linksUsingGET", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "application/vnd.spring-boot.actuator.v3+json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "application/vnd.spring-boot.actuator.v2+json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + } + }, + "components": { + "schemas": { + "ActionInput": { + "title": "ActionInput", + "type": "object", + "properties": { + "actionName": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "entityId": { + "type": "integer", + "format": "int64" + }, + "input": { + "type": "object" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processInstanceId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + } + }, + "AppTransactionStatusResponse": { + "title": "AppTransactionStatusResponse", + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "stationId": { + "type": "string" + }, + "transactionState": { + "type": "string", + "enum": [ + "BILL_GENERATED", + "FUELING_CANCELLED_BY_CUSTOMER", + "FUELING_CANCELLED_BY_STATION", + "PUMP_ACTIVATION_FAIL", + "PUMP_ACTIVATION_SUCCESS", + "PUMP_RESERVE_FAIL", + "PUMP_RESERVE_SUCCESS", + "TXN_STATE_UNKNOWN" + ] + } + } + }, + "ApplicableVoucher": { + "title": "ApplicableVoucher", + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "ApplicableVoucherReq": { + "title": "ApplicableVoucherReq", + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "string" + } + } + }, + "ApplicableVoucherRes": { + "title": "ApplicableVoucherRes", + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "Authorization": { + "title": "Authorization", + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "batch": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "coupons": { + "type": "string" + }, + "merchantName": { + "type": "string" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalID": { + "type": "string" + } + } + }, + "CallBackLogsDto": { + "title": "CallBackLogsDto", + "type": "object", + "properties": { + "callbackVerified": { + "type": "boolean" + }, + "captureAmount": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "currencyCode": { + "type": "string" + }, + "finalStatus": { + "type": "string", + "enum": [ + "FAILED", + "IN_PROGRESS", + "SUCCESS" + ] + }, + "id": { + "type": "integer", + "format": "int64" + }, + "metaData": { + "type": "string" + }, + "nextStep": { + "type": "string" + }, + "nonTerminatingErrorLocation": { + "type": "string" + }, + "nonTerminatingErrorMessage": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "requestId": { + "type": "string" + }, + "terminatingErrorLocation": { + "type": "string" + }, + "terminatingErrorMessage": { + "type": "string" + }, + "transactionErrorMessage": { + "type": "string" + }, + "transactionFailureFlag": { + "type": "string", + "enum": [ + "CALLBACK_SOURCE_UNKNOWN", + "FRAUD_AUTH_NOT_EXIST", + "FUELLING_AUTH_CONFIRMED", + "FUELLING_CALLBACK_PROCESSED", + "FUELLING_CAPTURE", + "FUELLING_CAPTURE_AMOUNT_MORE_THAN_AUTH", + "FUELLING_CAPTURE_FAIL", + "NON", + "PAYMENT_ID_GENERATED", + "PAYMENT_ID_MISSING_IN_DB", + "PSP_AUTH_FAIL", + "REGISTRATION_CALLBACK_PROCESSED", + "REGISTRATION_CARD_REVERSAL", + "REGISTRATION_REVERSAL_FAIL_RETRY", + "REVERSAL_AMOUNT_BELOW_MIN", + "ROLLBACK_REVERSAL", + "ROLLBACK_REVERSAL_FAIL_RETRY", + "TAMPERED_DATA" + ] + }, + "txnProcessingState": { + "type": "string", + "enum": [ + "CALLBACK_SOURCE_UNKNOWN", + "FRAUD_AUTH_NOT_EXIST", + "FUELLING_AUTH_CONFIRMED", + "FUELLING_CALLBACK_PROCESSED", + "FUELLING_CAPTURE", + "FUELLING_CAPTURE_AMOUNT_MORE_THAN_AUTH", + "FUELLING_CAPTURE_FAIL", + "NON", + "PAYMENT_ID_GENERATED", + "PAYMENT_ID_MISSING_IN_DB", + "PSP_AUTH_FAIL", + "REGISTRATION_CALLBACK_PROCESSED", + "REGISTRATION_CARD_REVERSAL", + "REGISTRATION_REVERSAL_FAIL_RETRY", + "REVERSAL_AMOUNT_BELOW_MIN", + "ROLLBACK_REVERSAL", + "ROLLBACK_REVERSAL_FAIL_RETRY", + "TAMPERED_DATA" + ] + }, + "txnReferenceNumber": { + "type": "string" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "userId": { + "type": "integer", + "format": "int64" + }, + "workflowName": { + "type": "string" + } + } + }, + "CancelRO": { + "title": "CancelRO", + "type": "object", + "properties": { + "mobilePaymentData": { + "$ref": "#/components/schemas/MobilePaymentData" + }, + "requestData": { + "$ref": "#/components/schemas/RequestData" + } + } + }, + "CancelRequest": { + "title": "CancelRequest", + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + } + } + }, + "CancelResponse": { + "title": "CancelResponse", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "CardRegisterROReq": { + "title": "CardRegisterROReq", + "required": [ + "currencyCode", + "customerInfo", + "paymentProviderName", + "registrationAmount" + ], + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + } + }, + "CardRegisterRORes": { + "title": "CardRegisterRORes", + "required": [ + "currencyCode", + "customerInfo", + "paymentProviderName", + "registrationAmount" + ], + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + } + }, + "CardValue": { + "title": "CardValue", + "type": "object", + "properties": { + "cardCircuit": { + "type": "string" + }, + "cardEntryMode": { + "type": "string" + }, + "cardID": { + "type": "string" + }, + "inString": { + "type": "string" + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "string" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tracker" + } + } + } + }, + "CustomerData": { + "title": "CustomerData", + "required": [ + "customerDataType", + "customerDataValue" + ], + "type": "object", + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "CustomerDataReq": { + "title": "CustomerDataReq", + "type": "object", + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "CustomerDataRes": { + "title": "CustomerDataRes", + "required": [ + "customerDataType", + "customerDataValue" + ], + "type": "object", + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "CustomerInfo": { + "title": "CustomerInfo", + "required": [ + "identifierName" + ], + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "identifierName": { + "type": "string", + "enum": [ + "cardnumber", + "email", + "externalId", + "mobile", + "wechat" + ] + }, + "identifierValue": { + "type": "string" + }, + "source": { + "type": "string" + } + } + }, + "GetEntityResponse": { + "title": "GetEntityResponse", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "workflowMeta": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrgWorkflowMetaDto" + } + } + } + }, + "Link": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "templated": { + "type": "boolean" + } + } + }, + "LoyaltyDetails": { + "title": "LoyaltyDetails", + "type": "object", + "properties": { + "loyaltyPAN": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tracker" + } + } + } + }, + "LoyaltyOffer": { + "title": "LoyaltyOffer", + "type": "object", + "properties": { + "loyaltyOfferDescription": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "Cart", + "lineitem" + ] + }, + "referenceID": { + "type": "string" + } + } + }, + "Message": { + "title": "Message", + "type": "object", + "properties": { + "cashierMessage": { + "type": "string" + } + } + }, + "MobilePaymentData": { + "title": "MobilePaymentData", + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "globalRetailSiteID": { + "type": "string" + }, + "loyaltyDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyDetails" + } + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "merchantID": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "paymentData": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "MobileResponseBody«CardRegisterRO»": { + "title": "MobileResponseBody«CardRegisterRO»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CardRegisterRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "MobileResponseBody«PreAuthorizeStep»": { + "title": "MobileResponseBody«PreAuthorizeStep»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PreAuthorizeStep" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "MobileResponseBody«PumpReserve»": { + "title": "MobileResponseBody«PumpReserve»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PumpReserve" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "MobileResponseBody«TokenizeRO»": { + "title": "MobileResponseBody«TokenizeRO»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TokenizeRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "ModelAndView": { + "title": "ModelAndView", + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "model": { + "type": "object" + }, + "modelMap": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "reference": { + "type": "boolean" + }, + "status": { + "type": "string", + "enum": [ + "ACCEPTED", + "ALREADY_REPORTED", + "BAD_GATEWAY", + "BAD_REQUEST", + "BANDWIDTH_LIMIT_EXCEEDED", + "CHECKPOINT", + "CONFLICT", + "CONTINUE", + "CREATED", + "DESTINATION_LOCKED", + "EXPECTATION_FAILED", + "FAILED_DEPENDENCY", + "FORBIDDEN", + "FOUND", + "GATEWAY_TIMEOUT", + "GONE", + "HTTP_VERSION_NOT_SUPPORTED", + "IM_USED", + "INSUFFICIENT_SPACE_ON_RESOURCE", + "INSUFFICIENT_STORAGE", + "INTERNAL_SERVER_ERROR", + "I_AM_A_TEAPOT", + "LENGTH_REQUIRED", + "LOCKED", + "LOOP_DETECTED", + "METHOD_FAILURE", + "METHOD_NOT_ALLOWED", + "MOVED_PERMANENTLY", + "MOVED_TEMPORARILY", + "MULTIPLE_CHOICES", + "MULTI_STATUS", + "NETWORK_AUTHENTICATION_REQUIRED", + "NON_AUTHORITATIVE_INFORMATION", + "NOT_ACCEPTABLE", + "NOT_EXTENDED", + "NOT_FOUND", + "NOT_IMPLEMENTED", + "NOT_MODIFIED", + "NO_CONTENT", + "OK", + "PARTIAL_CONTENT", + "PAYLOAD_TOO_LARGE", + "PAYMENT_REQUIRED", + "PERMANENT_REDIRECT", + "PRECONDITION_FAILED", + "PRECONDITION_REQUIRED", + "PROCESSING", + "PROXY_AUTHENTICATION_REQUIRED", + "REQUESTED_RANGE_NOT_SATISFIABLE", + "REQUEST_ENTITY_TOO_LARGE", + "REQUEST_HEADER_FIELDS_TOO_LARGE", + "REQUEST_TIMEOUT", + "REQUEST_URI_TOO_LONG", + "RESET_CONTENT", + "SEE_OTHER", + "SERVICE_UNAVAILABLE", + "SWITCHING_PROTOCOLS", + "TEMPORARY_REDIRECT", + "TOO_EARLY", + "TOO_MANY_REQUESTS", + "UNAUTHORIZED", + "UNAVAILABLE_FOR_LEGAL_REASONS", + "UNPROCESSABLE_ENTITY", + "UNSUPPORTED_MEDIA_TYPE", + "UPGRADE_REQUIRED", + "URI_TOO_LONG", + "USE_PROXY", + "VARIANT_ALSO_NEGOTIATES" + ] + }, + "view": { + "$ref": "#/components/schemas/View" + }, + "viewName": { + "type": "string" + } + } + }, + "OfferEvaluation": { + "title": "OfferEvaluation", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicableVoucher" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerData" + } + }, + "messages": { + "$ref": "#/components/schemas/Message" + }, + "posData": { + "$ref": "#/components/schemas/PosData" + }, + "predictedTender": { + "$ref": "#/components/schemas/PredictedTender" + }, + "receipt": { + "$ref": "#/components/schemas/Receipt" + }, + "requestData": { + "$ref": "#/components/schemas/RequestData" + }, + "responseData": { + "$ref": "#/components/schemas/ResponseData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleItem" + } + }, + "siteData": { + "$ref": "#/components/schemas/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tender" + } + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherCodesResult" + } + } + } + }, + "OfferEvaluationReq": { + "title": "OfferEvaluationReq", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicableVoucherReq" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerDataReq" + } + }, + "messages": { + "$ref": "#/components/schemas/Message" + }, + "posData": { + "$ref": "#/components/schemas/PosDataReq" + }, + "predictedTender": { + "$ref": "#/components/schemas/PredictedTender" + }, + "receipt": { + "$ref": "#/components/schemas/ReceiptReq" + }, + "requestData": { + "$ref": "#/components/schemas/RequestDataReq" + }, + "responseData": { + "$ref": "#/components/schemas/ResponseDataReq" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleItemReq" + } + }, + "siteData": { + "$ref": "#/components/schemas/SiteDataReq" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TenderReq" + } + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherCodesResult" + } + } + } + }, + "OfferEvaluationRes": { + "title": "OfferEvaluationRes", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicableVoucherRes" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerDataRes" + } + }, + "messages": { + "$ref": "#/components/schemas/Message" + }, + "posData": { + "$ref": "#/components/schemas/PosDataRes" + }, + "predictedTender": { + "$ref": "#/components/schemas/PredictedTender" + }, + "receipt": { + "$ref": "#/components/schemas/ReceiptRes" + }, + "requestData": { + "$ref": "#/components/schemas/RequestDataRes" + }, + "responseData": { + "$ref": "#/components/schemas/ResponseDataRes" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleItemRes" + } + }, + "siteData": { + "$ref": "#/components/schemas/SiteDataRes" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TenderRes" + } + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherCodesResult" + } + } + } + }, + "OrgWorkflowMetaDto": { + "title": "OrgWorkflowMetaDto", + "type": "object", + "properties": { + "autoUpdateTime": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "isApproved": { + "type": "boolean" + }, + "isAsync": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processId": { + "type": "string" + }, + "promotedOn": { + "type": "string", + "format": "date-time" + }, + "versionName": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + } + }, + "OriginalTransaction": { + "title": "OriginalTransaction", + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "authorizationToken": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "timeStamp": { + "type": "string", + "format": "date-time" + } + } + }, + "PerformanceBo": { + "title": "PerformanceBo", + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int64" + }, + "failurePercentage": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "PosData": { + "title": "PosData", + "required": [ + "posTimeStamp" + ], + "type": "object", + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + } + }, + "PosDataReq": { + "title": "PosDataReq", + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "clerkID": { + "type": "string" + }, + "originalSalePosTimeStamp": { + "type": "string" + }, + "posTimeStamp": { + "type": "string", + "format": "date-time" + }, + "pumpNumber": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + } + }, + "PosDataRes": { + "title": "PosDataRes", + "required": [ + "posTimeStamp" + ], + "type": "object", + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + } + }, + "PreAuthorizeStep": { + "title": "PreAuthorizeStep", + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + }, + "pspReferenceNumber": { + "type": "string" + } + } + }, + "PredictedTender": { + "title": "PredictedTender", + "type": "object", + "properties": { + "acquire": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "subtractDiscountAmount": { + "type": "boolean" + } + } + }, + "PriceAdjustment": { + "title": "PriceAdjustment", + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "PriceAdjustmentReq": { + "title": "PriceAdjustmentReq", + "required": [ + "amount", + "loyaltyOfferID", + "reason", + "referenceID" + ], + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "netAmount": { + "type": "number", + "format": "bigdecimal" + }, + "originalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "originalNetAmount": { + "type": "number", + "format": "bigdecimal" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "productCode": { + "type": "string" + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "taxSplit": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxSplit" + } + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + }, + "vat": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "PriceAdjustmentRes": { + "title": "PriceAdjustmentRes", + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "ProcessInstanceDetails": { + "title": "ProcessInstanceDetails", + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "tillId": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + } + }, + "Product": { + "title": "Product", + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "categoryCode": { + "type": "string" + }, + "productCode": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + } + } + }, + "PumpReserve": { + "title": "PumpReserve", + "required": [ + "currencyCode", + "customerInfo", + "methodOfPaymentId", + "paymentProviderName", + "preAuthAmount", + "siteId" + ], + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "languageCode": { + "type": "string" + }, + "loyaltyPan": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "siteId": { + "type": "string" + } + } + }, + "Receipt": { + "title": "Receipt", + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReceiptReq": { + "title": "ReceiptReq", + "required": [ + "receiptLines" + ], + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReceiptRes": { + "title": "ReceiptRes", + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RequestData": { + "title": "RequestData", + "required": [ + "requestID", + "requestType", + "workstationID" + ], + "type": "object", + "properties": { + "cartEvaluationID": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + } + }, + "RequestDataReq": { + "title": "RequestDataReq", + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "countryCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + } + }, + "RequestDataRes": { + "title": "RequestDataRes", + "type": "object", + "properties": { + "overallResult": { + "type": "string" + }, + "requestID": { + "type": "string" + } + } + }, + "ResponseData": { + "title": "ResponseData", + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + } + }, + "ResponseDataReq": { + "title": "ResponseDataReq", + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + } + }, + "ResponseDataRes": { + "title": "ResponseDataRes", + "type": "object", + "properties": { + "requestType": { + "type": "string" + } + } + }, + "SaleItem": { + "title": "SaleItem", + "required": [ + "additionalProductInfo", + "amount", + "originalAmount", + "quantity", + "saleItemType", + "unitMeasure", + "unitPrice" + ], + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceAdjustment" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + }, + "vatRate": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "SaleItemReq": { + "title": "SaleItemReq", + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "lineNo": { + "type": "string" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "netAmount": { + "type": "number", + "format": "bigdecimal" + }, + "originalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "originalNetAmount": { + "type": "number", + "format": "bigdecimal" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceAdjustmentReq" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "saleChannel": { + "type": "string" + }, + "saleItemType": { + "type": "string" + }, + "taxAmount": { + "type": "number", + "format": "bigdecimal" + }, + "taxCode": { + "type": "string" + }, + "taxRate": { + "type": "number", + "format": "bigdecimal" + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + }, + "vatRate": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "SaleItemRes": { + "title": "SaleItemRes", + "required": [ + "additionalProductInfo", + "amount", + "originalAmount", + "quantity", + "saleItemType", + "unitMeasure", + "unitPrice" + ], + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceAdjustmentRes" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number", + "format": "bigdecimal" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number", + "format": "bigdecimal" + }, + "vatRate": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "SaleTransaction": { + "title": "SaleTransaction", + "required": [ + "totalAmount" + ], + "type": "object", + "properties": { + "authorization": { + "$ref": "#/components/schemas/Authorization" + }, + "coupons": { + "type": "array", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string" + }, + "currencyCode": { + "type": "string" + }, + "extraDiscountAmount": { + "type": "number", + "format": "double" + }, + "loyaltyPointAmount": { + "type": "integer", + "format": "int32" + }, + "merchantName": { + "type": "string" + }, + "netAmount": { + "type": "number", + "format": "double" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "taxReferenceNumber": { + "type": "string" + }, + "timeStamp": { + "type": "string" + }, + "totalAmount": { + "type": "number", + "format": "double" + }, + "totalDiscountAmount": { + "type": "number", + "format": "double" + }, + "totalTaxAmount": { + "type": "number", + "format": "double" + }, + "transactionNumber": { + "type": "string" + } + } + }, + "ShellTransactionResponse": { + "title": "ShellTransactionResponse", + "type": "object", + "properties": { + "requestData": { + "$ref": "#/components/schemas/RequestDataRes" + }, + "responseData": { + "$ref": "#/components/schemas/ResponseDataRes" + } + } + }, + "SingleResponse«OfferEvaluation»": { + "title": "SingleResponse«OfferEvaluation»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OfferEvaluationRes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "SingleResponse«TxnStatusBo»": { + "title": "SingleResponse«TxnStatusBo»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TxnStatusBo" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "SingleResponse«UserTxnsBo»": { + "title": "SingleResponse«UserTxnsBo»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserTxnsBo" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "SingleResponse«WorkFlowCreationResponse»": { + "title": "SingleResponse«WorkFlowCreationResponse»", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WorkFlowCreationResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "SiteData": { + "title": "SiteData", + "required": [ + "countryCode", + "siteID" + ], + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + } + }, + "SiteDataReq": { + "title": "SiteDataReq", + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteId": { + "type": "string" + } + } + }, + "SiteDataRes": { + "title": "SiteDataRes", + "required": [ + "countryCode", + "siteID" + ], + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + } + }, + "StatResponse«Map«string,PerformanceBo»»": { + "title": "StatResponse«Map«string,PerformanceBo»»", + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/PerformanceBo" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "StatusCode": { + "title": "StatusCode", + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "isWarning": { + "type": "boolean" + }, + "message": { + "type": "string" + } + } + }, + "TaxSplit": { + "title": "TaxSplit", + "type": "object", + "properties": { + "additionalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "amount": { + "type": "number", + "format": "bigdecimal" + }, + "code": { + "type": "string" + }, + "rate": { + "type": "number", + "format": "bigdecimal" + }, + "taxID": { + "type": "integer", + "format": "int32" + } + } + }, + "Tender": { + "title": "Tender", + "required": [ + "acquirerID" + ], + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number", + "format": "bigdecimal" + }, + "pointsRedeemed": { + "type": "number", + "format": "bigdecimal" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherRule" + } + } + } + }, + "TenderReq": { + "title": "TenderReq", + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "netTenderAmount": { + "type": "string" + }, + "pointsRedeemed": { + "type": "string" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "string" + }, + "totalAmount": { + "type": "string" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherRuleReq" + } + } + } + }, + "TenderRes": { + "title": "TenderRes", + "required": [ + "acquirerID" + ], + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number", + "format": "bigdecimal" + }, + "pointsRedeemed": { + "type": "number", + "format": "bigdecimal" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VoucherRuleRes" + } + } + } + }, + "Terminal": { + "title": "Terminal", + "type": "object", + "properties": { + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + } + } + }, + "TokenizeRO": { + "title": "TokenizeRO", + "required": [ + "currencyCode", + "customerInfo", + "loyaltyPan", + "paymentProviderName", + "registrationAmount" + ], + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/components/schemas/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + } + }, + "Tracker": { + "title": "Tracker", + "type": "object", + "properties": { + "trackerEarned": { + "type": "string" + }, + "trackerRedeemed": { + "type": "string" + }, + "trackerType": { + "type": "string" + }, + "trackerValue": { + "type": "string" + } + } + }, + "TransactionAddRO": { + "title": "TransactionAddRO", + "required": [ + "cardValues", + "receipt", + "requestData", + "saleItems", + "saleTransaction" + ], + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicableVoucher" + } + }, + "cardValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CardValue" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerData" + } + }, + "mobilePaymentData": { + "$ref": "#/components/schemas/MobilePaymentData" + }, + "originalTransaction": { + "$ref": "#/components/schemas/OriginalTransaction" + }, + "posData": { + "$ref": "#/components/schemas/PosData" + }, + "receipt": { + "$ref": "#/components/schemas/Receipt" + }, + "requestData": { + "$ref": "#/components/schemas/RequestData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleItem" + } + }, + "saleTransaction": { + "$ref": "#/components/schemas/SaleTransaction" + }, + "siteData": { + "$ref": "#/components/schemas/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tender" + } + }, + "terminal": { + "$ref": "#/components/schemas/Terminal" + }, + "totalAmount": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "TransactionAddResponse": { + "title": "TransactionAddResponse", + "type": "object", + "properties": { + "shellResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShellTransactionResponse" + } + } + } + }, + "TxnStatusBo": { + "title": "TxnStatusBo", + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "finalStatus": { + "type": "string" + }, + "instanceVariables": { + "type": "object" + }, + "languageCode": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "siteId": { + "type": "string" + }, + "status": { + "type": "string" + }, + "stepRequests": { + "type": "object" + }, + "workFlowDetails": { + "$ref": "#/components/schemas/ProcessInstanceDetails" + } + } + }, + "UpdatedEntityResponse": { + "title": "UpdatedEntityResponse", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusCode" + } + } + } + }, + "UserTxnsBo": { + "title": "UserTxnsBo", + "type": "object", + "properties": { + "failedTxns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CallBackLogsDto" + } + }, + "inProgressTxns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CallBackLogsDto" + } + }, + "successTxns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CallBackLogsDto" + } + } + } + }, + "View": { + "title": "View", + "type": "object", + "properties": { + "contentType": { + "type": "string" + } + } + }, + "Violation": { + "title": "Violation", + "type": "object", + "properties": { + "fieldName": { + "type": "string" + }, + "invalidValue": { + "type": "object" + }, + "message": { + "type": "string" + } + } + }, + "VoucherCodesResult": { + "title": "VoucherCodesResult", + "type": "object", + "properties": { + "actionCode": { + "type": "integer", + "format": "int32" + }, + "actionCodeDescription": { + "type": "string" + }, + "voucherCode": { + "type": "string" + } + } + }, + "VoucherRule": { + "title": "VoucherRule", + "required": [ + "voucherCode" + ], + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "VoucherRuleReq": { + "title": "VoucherRuleReq", + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "referenceId": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "VoucherRuleRes": { + "title": "VoucherRuleRes", + "required": [ + "voucherCode" + ], + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number", + "format": "bigdecimal" + } + } + }, + "WorkFlowCreationResponse": { + "title": "WorkFlowCreationResponse", + "type": "object", + "properties": { + "deploymentId": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "WorkFlowPromote": { + "title": "WorkFlowPromote", + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + } + }, + "WorkflowInputAction": { + "title": "WorkflowInputAction", + "required": [ + "httpCallInputProperties" + ], + "type": "object", + "properties": { + "actionGroupType": { + "type": "string", + "enum": [ + "PARALLEL", + "SERIAL", + "XOR" + ] + }, + "delayTimeInRetrial": { + "type": "integer", + "format": "int32" + }, + "httpCallInputProperties": { + "$ref": "#/components/schemas/ActionInput" + }, + "httpCallInputPropertiesRollback": { + "$ref": "#/components/schemas/ActionInput" + }, + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "properties": { + "type": "object" + }, + "retrialCount": { + "type": "integer", + "format": "int32" + }, + "rollBackProperties": { + "type": "object" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "CCCaptureAction", + "addTransactionAction", + "authorizePaymentWithPsp", + "confirmAuthWithPSPAction", + "eghlCapturePaymentAction", + "eghlTokenizationAction", + "emptyAction", + "generatePaymentIdAction", + "ifredeemPointsAction", + "invalid", + "oAuthHttpAction", + "offerEvaluationAction", + "redeemPointsAction", + "saveCCardAction" + ] + } + } + }, + "WorkflowProcess": { + "title": "WorkflowProcess", + "type": "object", + "properties": { + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowStep" + } + } + } + }, + "WorkflowStep": { + "title": "WorkflowStep", + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowInputAction" + } + }, + "maxWaitTimeInMillis": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + } + } + }, + "_2c2pCallbackRequest": { + "title": "_2c2pCallbackRequest", + "type": "object", + "properties": { + "payload": { + "type": "string" + } + } + } + } + } +} From 7cfa8ddef8886c4150071934c32a7abc08f82a0f Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:15:13 +0530 Subject: [PATCH 132/150] Update swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index aea35a69876..7fea4f5e54b 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -14,6 +14,7 @@ elif [ "$Branch" = "production" ]; then else "No Branch is selected" fi +mkdir orchestrator/php_client if [ "$Client" = "java" ]; then rm -rf promotion_engine/java_client/java From c182f6d7e199adabddd5a10ed0d04205bacfc40c Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:22:19 +0530 Subject: [PATCH 133/150] Update swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index 7fea4f5e54b..b9f0a30fd67 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -14,7 +14,6 @@ elif [ "$Branch" = "production" ]; then else "No Branch is selected" fi -mkdir orchestrator/php_client if [ "$Client" = "java" ]; then rm -rf promotion_engine/java_client/java @@ -31,6 +30,7 @@ if [ "$Client" = "java" ]; then elif [ "$Client" = "php" ]; then rm -rf orchestrator/php_client/php + mkdir -p orchestrator/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ -i orchestrator.json \ -l php \ From 37e8a2a3180a415c1e876967ea25ba31ea1cb91f Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:36:17 +0530 Subject: [PATCH 134/150] Update swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index b9f0a30fd67..5e3a7efc491 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -35,7 +35,7 @@ elif [ "$Client" = "php" ]; then -i orchestrator.json \ -l php \ -o orchestrator/php_client/php \ - -c config_php.json + -c config.json tar cvzf orchestrator/php_client/php_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./orchestrator/php_client/php/ . fpm -f -s "dir" -t "deb" -a "all" -n "swagger-orchestrator-sdk" -v $BUILD_NUMBER -C ./orchestrator/php_client --deb-no-default-config-files php="/usr/share/php/capillary-libs/swagger-orchestrator-sdk" else From f7b6ae84b98f466a9198b8e4965327c3504e062c Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:42:13 +0530 Subject: [PATCH 135/150] Update orchestrator.json --- orchestrator.json | 4935 +-------------------------------------------- 1 file changed, 1 insertion(+), 4934 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index 4485b90910d..19bf224315e 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -1,4934 +1 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Api Documentation", - "description": "Api Documentation", - "termsOfService": "urn:tos", - "contact": {}, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0" - }, - "version": "1.0" - }, - "servers": [ - { - "url": "http://localhost:8100", - "description": "Inferred Url" - } - ], - "tags": [ - { - "name": "_2c-2p-callback-resource", - "description": "_2c 2p Callback Resource" - }, - { - "name": "admin-workflow-resource", - "description": "Admin Workflow Resource" - }, - { - "name": "basic-error-controller", - "description": "Basic Error Controller" - }, - { - "name": "cancel-sandbox", - "description": "Cancel Sandbox" - }, - { - "name": "eghl-call-back-resource", - "description": "Eghl Call Back Resource" - }, - { - "name": "health-check-resource", - "description": "Health Check Resource" - }, - { - "name": "mobile-card-registration-resource", - "description": "Mobile Card Registration Resource" - }, - { - "name": "operation-handler", - "description": "Operation Handler" - }, - { - "name": "payments-resource", - "description": "Payments Resource" - }, - { - "name": "psp-callback-resource", - "description": "Psp Callback Resource" - }, - { - "name": "psp-performance-resource", - "description": "Psp Performance Resource" - }, - { - "name": "psp-reconciliation", - "description": "PSP Reconciliation" - }, - { - "name": "pump-life-cycle-resource", - "description": "Pump Life Cycle Resource" - }, - { - "name": "pump-performance-resource", - "description": "Pump Performance Resource" - }, - { - "name": "shell-server-to-server-resource", - "description": "Shell Server To Server Resource" - }, - { - "name": "test-fuelling-workflow-resource", - "description": "Test Fuelling Workflow Resource" - }, - { - "name": "transaction-status-resource", - "description": "Transaction Status Resource" - }, - { - "name": "txn-status-resource", - "description": "Txn Status Resource" - }, - { - "name": "web-mvc-links-handler", - "description": "Web Mvc Links Handler" - } - ], - "paths": { - "/orchestrator/payments/webhooks/2c2p/fuelling-callback": { - "post": { - "tags": [ - "_2c-2p-callback-resource" - ], - "summary": "fuellingCallBack", - "operationId": "fuellingCallBackUsingPOST", - "parameters": [ - { - "name": "defaultCard", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "boolean" - } - }, - { - "name": "extCorrelationID", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - }, - { - "name": "orgId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "paymentProvider", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - }, - { - "name": "userId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_2c2pCallbackRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/webhooks/2c2p/register-callback": { - "post": { - "tags": [ - "_2c-2p-callback-resource" - ], - "summary": "registerCallBack", - "operationId": "registerCallBackUsingPOST", - "parameters": [ - { - "name": "defaultCard", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "boolean" - } - }, - { - "name": "extCorrelationID", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - }, - { - "name": "orgId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "paymentProvider", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - }, - { - "name": "userId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/_2c2pCallbackRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/workflow": { - "get": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "get", - "operationId": "getUsingGET", - "parameters": [ - { - "name": "allVersions", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "boolean" - } - }, - { - "name": "name", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/GetEntityResponse" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "create", - "operationId": "createUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowProcess" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleResponse«WorkFlowCreationResponse»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/workflow/promotion": { - "put": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "promoteWorkFlow", - "operationId": "promoteWorkFlowUsingPUT", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkFlowPromote" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/UpdatedEntityResponse" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/error": { - "get": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingGET", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "put": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPUT", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "post": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPOST", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - }, - "delete": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingDELETE", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - }, - "options": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingOPTIONS", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - }, - "head": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingHEAD", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - }, - "patch": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPATCH", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - }, - "trace": { - "tags": [ - "basic-error-controller" - ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingTRACE", - "responses": { - "200": { - "description": "OK", - "content": { - "text/html": { - "schema": { - "$ref": "#/components/schemas/ModelAndView" - } - } - } - }, - "204": { - "description": "No Content" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/orchestrator/payments/v1/site/cancel": { - "post": { - "tags": [ - "cancel-sandbox" - ], - "summary": "cancel", - "operationId": "cancelUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CancelRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK" - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/webhooks/eghl/callback": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "saveToken", - "operationId": "saveTokenUsingPOST", - "parameters": [ - { - "name": "shouldSave", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/webhooks/eghl/payment-identifier": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TokenizeRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/webhooks/eghl/transaction": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "callback", - "operationId": "callbackUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/ping": { - "get": { - "tags": [ - "health-check-resource" - ], - "summary": "application health check", - "operationId": "healthCheckUsingGET", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/register-paymentIdV1": { - "post": { - "tags": [ - "mobile-card-registration-resource" - ], - "summary": "registerPaymentId", - "operationId": "registerPaymentIdUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CardRegisterROReq" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«CardRegisterRO»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/register-paymentId": { - "post": { - "tags": [ - "mobile-card-registration-resource" - ], - "summary": "generatePaymentIdentifier", - "operationId": "generatePaymentIdentifierUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TokenizeRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/actuator/health": { - "get": { - "tags": [ - "operation-handler" - ], - "summary": "handle", - "operationId": "handleUsingGET", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v3+json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json": { - "schema": { - "type": "object" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/actuator/health/**": { - "get": { - "tags": [ - "operation-handler" - ], - "summary": "handle", - "operationId": "handleUsingGET_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v3+json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json": { - "schema": { - "type": "object" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/actuator/info": { - "get": { - "tags": [ - "operation-handler" - ], - "summary": "handle", - "operationId": "handleUsingGET_2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v3+json": { - "schema": { - "type": "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json": { - "schema": { - "type": "object" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/actuator/prometheus": { - "get": { - "tags": [ - "operation-handler" - ], - "summary": "handle", - "operationId": "handleUsingGET_3", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain;version=0.0.4;charset=utf-8": { - "schema": { - "type": "object" - } - }, - "application/openmetrics-text;version=1.0.0;charset=utf-8": { - "schema": { - "type": "object" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/workflow/shell/billing/evaluateOffer": { - "post": { - "tags": [ - "payments-resource" - ], - "summary": "evaluateOffers", - "operationId": "evaluateOffersUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OfferEvaluationReq" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleResponse«OfferEvaluation»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/workflow/shell/billing/transactionAdd": { - "post": { - "tags": [ - "payments-resource" - ], - "summary": "txnAdd", - "operationId": "txnAddUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionAddRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/TransactionAddResponse" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1/workflow/psp/payment-identifier": { - "post": { - "tags": [ - "psp-callback-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TokenizeRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«TokenizeRO»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/failure-rate/bank": { - "get": { - "tags": [ - "psp-performance-resource" - ], - "summary": "pspStat", - "operationId": "pspStatUsingGET", - "parameters": [ - { - "name": "bankName", - "in": "query", - "required": false, - "style": "pipeDelimited", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "durationHours", - "in": "query", - "required": false, - "style": "form", - "schema": { - "maximum": 12, - "exclusiveMaximum": false, - "type": "integer", - "format": "int32" - } - }, - { - "name": "psp", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/StatResponse«Map«string,PerformanceBo»»" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/reconciliation/capture": { - "post": { - "tags": [ - "psp-reconciliation" - ], - "summary": "reconciliationCapture", - "operationId": "reconciliationCaptureUsingPOST", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/reconciliation/registration-reversal": { - "post": { - "tags": [ - "psp-reconciliation" - ], - "summary": "reconciliationRegistrationReversal", - "operationId": "reconciliationRegistrationReversalUsingPOST", - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/pump-activate": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "activatePump", - "operationId": "activatePumpUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreAuthorizeStep" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«PreAuthorizeStep»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/pump-cancel": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "cancelPump", - "operationId": "cancelPumpUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CancelRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/CancelResponse" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/pump-reserve": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "pumpReserve", - "operationId": "pumpReserveUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PumpReserve" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«PumpReserve»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/failure-rate/pump": { - "get": { - "tags": [ - "pump-performance-resource" - ], - "summary": "pumpStat", - "operationId": "pumpStatUsingGET", - "parameters": [ - { - "name": "durationHours", - "in": "query", - "required": false, - "style": "form", - "schema": { - "maximum": 12, - "exclusiveMaximum": false, - "type": "integer", - "format": "int32" - } - }, - { - "name": "siteId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/StatResponse«Map«string,PerformanceBo»»" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/v1/site/finalize-txn": { - "post": { - "tags": [ - "shell-server-to-server-resource" - ], - "summary": "finalizeTransaction", - "operationId": "finalizeTransactionUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionAddRO" - } - } - } - }, - "responses": { - "200": { - "description": "OK" - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/v1/site/get-offers": { - "post": { - "tags": [ - "shell-server-to-server-resource" - ], - "summary": "offerEvaluation", - "operationId": "offerEvaluationUsingPOST", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OfferEvaluation" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/OfferEvaluation" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/pumpReserve/{version}": { - "post": { - "tags": [ - "test-fuelling-workflow-resource" - ], - "summary": "pumpReserveWithGivenVersion", - "operationId": "pumpReserveWithGivenVersionUsingPOST", - "parameters": [ - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PumpReserve" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MobileResponseBody«PumpReserve»" - } - } - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/app/v1/fuelling-status": { - "get": { - "tags": [ - "transaction-status-resource" - ], - "summary": "status", - "operationId": "statusUsingGET", - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": true, - "style": "form", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "paymentId", - "in": "query", - "required": false, - "style": "form", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/AppTransactionStatusResponse" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}": { - "get": { - "tags": [ - "txn-status-resource" - ], - "summary": "getStatusByPaymentId", - "operationId": "getStatusByPaymentIdUsingGET", - "parameters": [ - { - "name": "paymentId", - "in": "path", - "description": "paymentId", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleResponse«TxnStatusBo»" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/orchestrator/payments/intouch/txn-status/user-id/{userId}": { - "get": { - "tags": [ - "txn-status-resource" - ], - "summary": "getStatusByUserId", - "operationId": "getStatusByUserIdUsingGET", - "parameters": [ - { - "name": "userId", - "in": "path", - "description": "userId", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SingleResponse«UserTxnsBo»" - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/actuator": { - "get": { - "tags": [ - "web-mvc-links-handler" - ], - "summary": "links", - "operationId": "linksUsingGET", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "application/vnd.spring-boot.actuator.v3+json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "application/vnd.spring-boot.actuator.v2+json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - } - }, - "components": { - "schemas": { - "ActionInput": { - "title": "ActionInput", - "type": "object", - "properties": { - "actionName": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "entityId": { - "type": "integer", - "format": "int64" - }, - "input": { - "type": "object" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "processInstanceId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "workFlowName": { - "type": "string" - } - } - }, - "AppTransactionStatusResponse": { - "title": "AppTransactionStatusResponse", - "type": "object", - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "paymentId": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "pumpNumber": { - "type": "string" - }, - "stationId": { - "type": "string" - }, - "transactionState": { - "type": "string", - "enum": [ - "BILL_GENERATED", - "FUELING_CANCELLED_BY_CUSTOMER", - "FUELING_CANCELLED_BY_STATION", - "PUMP_ACTIVATION_FAIL", - "PUMP_ACTIVATION_SUCCESS", - "PUMP_RESERVE_FAIL", - "PUMP_RESERVE_SUCCESS", - "TXN_STATE_UNKNOWN" - ] - } - } - }, - "ApplicableVoucher": { - "title": "ApplicableVoucher", - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "ApplicableVoucherReq": { - "title": "ApplicableVoucherReq", - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string", - "format": "date-time" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "string" - } - } - }, - "ApplicableVoucherRes": { - "title": "ApplicableVoucherRes", - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "Authorization": { - "title": "Authorization", - "type": "object", - "properties": { - "approvalCode": { - "type": "string" - }, - "batch": { - "type": "string" - }, - "couponCode": { - "type": "string" - }, - "coupons": { - "type": "string" - }, - "merchantName": { - "type": "string" - }, - "siteAddress": { - "type": "string" - }, - "siteName": { - "type": "string" - }, - "stan": { - "type": "string" - }, - "terminalID": { - "type": "string" - } - } - }, - "CallBackLogsDto": { - "title": "CallBackLogsDto", - "type": "object", - "properties": { - "callbackVerified": { - "type": "boolean" - }, - "captureAmount": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "currencyCode": { - "type": "string" - }, - "finalStatus": { - "type": "string", - "enum": [ - "FAILED", - "IN_PROGRESS", - "SUCCESS" - ] - }, - "id": { - "type": "integer", - "format": "int64" - }, - "metaData": { - "type": "string" - }, - "nextStep": { - "type": "string" - }, - "nonTerminatingErrorLocation": { - "type": "string" - }, - "nonTerminatingErrorMessage": { - "type": "string" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "requestId": { - "type": "string" - }, - "terminatingErrorLocation": { - "type": "string" - }, - "terminatingErrorMessage": { - "type": "string" - }, - "transactionErrorMessage": { - "type": "string" - }, - "transactionFailureFlag": { - "type": "string", - "enum": [ - "CALLBACK_SOURCE_UNKNOWN", - "FRAUD_AUTH_NOT_EXIST", - "FUELLING_AUTH_CONFIRMED", - "FUELLING_CALLBACK_PROCESSED", - "FUELLING_CAPTURE", - "FUELLING_CAPTURE_AMOUNT_MORE_THAN_AUTH", - "FUELLING_CAPTURE_FAIL", - "NON", - "PAYMENT_ID_GENERATED", - "PAYMENT_ID_MISSING_IN_DB", - "PSP_AUTH_FAIL", - "REGISTRATION_CALLBACK_PROCESSED", - "REGISTRATION_CARD_REVERSAL", - "REGISTRATION_REVERSAL_FAIL_RETRY", - "REVERSAL_AMOUNT_BELOW_MIN", - "ROLLBACK_REVERSAL", - "ROLLBACK_REVERSAL_FAIL_RETRY", - "TAMPERED_DATA" - ] - }, - "txnProcessingState": { - "type": "string", - "enum": [ - "CALLBACK_SOURCE_UNKNOWN", - "FRAUD_AUTH_NOT_EXIST", - "FUELLING_AUTH_CONFIRMED", - "FUELLING_CALLBACK_PROCESSED", - "FUELLING_CAPTURE", - "FUELLING_CAPTURE_AMOUNT_MORE_THAN_AUTH", - "FUELLING_CAPTURE_FAIL", - "NON", - "PAYMENT_ID_GENERATED", - "PAYMENT_ID_MISSING_IN_DB", - "PSP_AUTH_FAIL", - "REGISTRATION_CALLBACK_PROCESSED", - "REGISTRATION_CARD_REVERSAL", - "REGISTRATION_REVERSAL_FAIL_RETRY", - "REVERSAL_AMOUNT_BELOW_MIN", - "ROLLBACK_REVERSAL", - "ROLLBACK_REVERSAL_FAIL_RETRY", - "TAMPERED_DATA" - ] - }, - "txnReferenceNumber": { - "type": "string" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - }, - "userId": { - "type": "integer", - "format": "int64" - }, - "workflowName": { - "type": "string" - } - } - }, - "CancelRO": { - "title": "CancelRO", - "type": "object", - "properties": { - "mobilePaymentData": { - "$ref": "#/components/schemas/MobilePaymentData" - }, - "requestData": { - "$ref": "#/components/schemas/RequestData" - } - } - }, - "CancelRequest": { - "title": "CancelRequest", - "type": "object", - "properties": { - "processInstanceId": { - "type": "string" - } - } - }, - "CancelResponse": { - "title": "CancelResponse", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "CardRegisterROReq": { - "title": "CardRegisterROReq", - "required": [ - "currencyCode", - "customerInfo", - "paymentProviderName", - "registrationAmount" - ], - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - } - }, - "CardRegisterRORes": { - "title": "CardRegisterRORes", - "required": [ - "currencyCode", - "customerInfo", - "paymentProviderName", - "registrationAmount" - ], - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - } - }, - "CardValue": { - "title": "CardValue", - "type": "object", - "properties": { - "cardCircuit": { - "type": "string" - }, - "cardEntryMode": { - "type": "string" - }, - "cardID": { - "type": "string" - }, - "inString": { - "type": "string" - }, - "loyaltyExceptionIndicator": { - "type": "integer", - "format": "int32" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "pointsRedeemed": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "string" - }, - "trackers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tracker" - } - } - } - }, - "CustomerData": { - "title": "CustomerData", - "required": [ - "customerDataType", - "customerDataValue" - ], - "type": "object", - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "CustomerDataReq": { - "title": "CustomerDataReq", - "type": "object", - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "CustomerDataRes": { - "title": "CustomerDataRes", - "required": [ - "customerDataType", - "customerDataValue" - ], - "type": "object", - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "CustomerInfo": { - "title": "CustomerInfo", - "required": [ - "identifierName" - ], - "type": "object", - "properties": { - "accountId": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "identifierName": { - "type": "string", - "enum": [ - "cardnumber", - "email", - "externalId", - "mobile", - "wechat" - ] - }, - "identifierValue": { - "type": "string" - }, - "source": { - "type": "string" - } - } - }, - "GetEntityResponse": { - "title": "GetEntityResponse", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "workflowMeta": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrgWorkflowMetaDto" - } - } - } - }, - "Link": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "templated": { - "type": "boolean" - } - } - }, - "LoyaltyDetails": { - "title": "LoyaltyDetails", - "type": "object", - "properties": { - "loyaltyPAN": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "pointsRedeemed": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "trackers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tracker" - } - } - } - }, - "LoyaltyOffer": { - "title": "LoyaltyOffer", - "type": "object", - "properties": { - "loyaltyOfferDescription": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "promotionType": { - "type": "string", - "enum": [ - "Cart", - "lineitem" - ] - }, - "referenceID": { - "type": "string" - } - } - }, - "Message": { - "title": "Message", - "type": "object", - "properties": { - "cashierMessage": { - "type": "string" - } - } - }, - "MobilePaymentData": { - "title": "MobilePaymentData", - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "globalRetailSiteID": { - "type": "string" - }, - "loyaltyDetails": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LoyaltyDetails" - } - }, - "loyaltyExceptionIndicator": { - "type": "integer", - "format": "int32" - }, - "merchantID": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "paymentData": { - "type": "string" - }, - "paymentServiceProvider": { - "type": "string" - }, - "pumpNumber": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "MobileResponseBody«CardRegisterRO»": { - "title": "MobileResponseBody«CardRegisterRO»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CardRegisterRORes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "MobileResponseBody«PreAuthorizeStep»": { - "title": "MobileResponseBody«PreAuthorizeStep»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PreAuthorizeStep" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "MobileResponseBody«PumpReserve»": { - "title": "MobileResponseBody«PumpReserve»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PumpReserve" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "MobileResponseBody«TokenizeRO»": { - "title": "MobileResponseBody«TokenizeRO»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TokenizeRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "ModelAndView": { - "title": "ModelAndView", - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "model": { - "type": "object" - }, - "modelMap": { - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "reference": { - "type": "boolean" - }, - "status": { - "type": "string", - "enum": [ - "ACCEPTED", - "ALREADY_REPORTED", - "BAD_GATEWAY", - "BAD_REQUEST", - "BANDWIDTH_LIMIT_EXCEEDED", - "CHECKPOINT", - "CONFLICT", - "CONTINUE", - "CREATED", - "DESTINATION_LOCKED", - "EXPECTATION_FAILED", - "FAILED_DEPENDENCY", - "FORBIDDEN", - "FOUND", - "GATEWAY_TIMEOUT", - "GONE", - "HTTP_VERSION_NOT_SUPPORTED", - "IM_USED", - "INSUFFICIENT_SPACE_ON_RESOURCE", - "INSUFFICIENT_STORAGE", - "INTERNAL_SERVER_ERROR", - "I_AM_A_TEAPOT", - "LENGTH_REQUIRED", - "LOCKED", - "LOOP_DETECTED", - "METHOD_FAILURE", - "METHOD_NOT_ALLOWED", - "MOVED_PERMANENTLY", - "MOVED_TEMPORARILY", - "MULTIPLE_CHOICES", - "MULTI_STATUS", - "NETWORK_AUTHENTICATION_REQUIRED", - "NON_AUTHORITATIVE_INFORMATION", - "NOT_ACCEPTABLE", - "NOT_EXTENDED", - "NOT_FOUND", - "NOT_IMPLEMENTED", - "NOT_MODIFIED", - "NO_CONTENT", - "OK", - "PARTIAL_CONTENT", - "PAYLOAD_TOO_LARGE", - "PAYMENT_REQUIRED", - "PERMANENT_REDIRECT", - "PRECONDITION_FAILED", - "PRECONDITION_REQUIRED", - "PROCESSING", - "PROXY_AUTHENTICATION_REQUIRED", - "REQUESTED_RANGE_NOT_SATISFIABLE", - "REQUEST_ENTITY_TOO_LARGE", - "REQUEST_HEADER_FIELDS_TOO_LARGE", - "REQUEST_TIMEOUT", - "REQUEST_URI_TOO_LONG", - "RESET_CONTENT", - "SEE_OTHER", - "SERVICE_UNAVAILABLE", - "SWITCHING_PROTOCOLS", - "TEMPORARY_REDIRECT", - "TOO_EARLY", - "TOO_MANY_REQUESTS", - "UNAUTHORIZED", - "UNAVAILABLE_FOR_LEGAL_REASONS", - "UNPROCESSABLE_ENTITY", - "UNSUPPORTED_MEDIA_TYPE", - "UPGRADE_REQUIRED", - "URI_TOO_LONG", - "USE_PROXY", - "VARIANT_ALSO_NEGOTIATES" - ] - }, - "view": { - "$ref": "#/components/schemas/View" - }, - "viewName": { - "type": "string" - } - } - }, - "OfferEvaluation": { - "title": "OfferEvaluation", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "type": "object", - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicableVoucher" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerData" - } - }, - "messages": { - "$ref": "#/components/schemas/Message" - }, - "posData": { - "$ref": "#/components/schemas/PosData" - }, - "predictedTender": { - "$ref": "#/components/schemas/PredictedTender" - }, - "receipt": { - "$ref": "#/components/schemas/Receipt" - }, - "requestData": { - "$ref": "#/components/schemas/RequestData" - }, - "responseData": { - "$ref": "#/components/schemas/ResponseData" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleItem" - } - }, - "siteData": { - "$ref": "#/components/schemas/SiteData" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tender" - } - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherCodesResult" - } - } - } - }, - "OfferEvaluationReq": { - "title": "OfferEvaluationReq", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "type": "object", - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicableVoucherReq" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerDataReq" - } - }, - "messages": { - "$ref": "#/components/schemas/Message" - }, - "posData": { - "$ref": "#/components/schemas/PosDataReq" - }, - "predictedTender": { - "$ref": "#/components/schemas/PredictedTender" - }, - "receipt": { - "$ref": "#/components/schemas/ReceiptReq" - }, - "requestData": { - "$ref": "#/components/schemas/RequestDataReq" - }, - "responseData": { - "$ref": "#/components/schemas/ResponseDataReq" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleItemReq" - } - }, - "siteData": { - "$ref": "#/components/schemas/SiteDataReq" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TenderReq" - } - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherCodesResult" - } - } - } - }, - "OfferEvaluationRes": { - "title": "OfferEvaluationRes", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "type": "object", - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicableVoucherRes" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerDataRes" - } - }, - "messages": { - "$ref": "#/components/schemas/Message" - }, - "posData": { - "$ref": "#/components/schemas/PosDataRes" - }, - "predictedTender": { - "$ref": "#/components/schemas/PredictedTender" - }, - "receipt": { - "$ref": "#/components/schemas/ReceiptRes" - }, - "requestData": { - "$ref": "#/components/schemas/RequestDataRes" - }, - "responseData": { - "$ref": "#/components/schemas/ResponseDataRes" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleItemRes" - } - }, - "siteData": { - "$ref": "#/components/schemas/SiteDataRes" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TenderRes" - } - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherCodesResult" - } - } - } - }, - "OrgWorkflowMetaDto": { - "title": "OrgWorkflowMetaDto", - "type": "object", - "properties": { - "autoUpdateTime": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "isApproved": { - "type": "boolean" - }, - "isAsync": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "processId": { - "type": "string" - }, - "promotedOn": { - "type": "string", - "format": "date-time" - }, - "versionName": { - "type": "string" - }, - "workflowName": { - "type": "string" - } - } - }, - "OriginalTransaction": { - "title": "OriginalTransaction", - "type": "object", - "properties": { - "approvalCode": { - "type": "string" - }, - "authorizationToken": { - "type": "string" - }, - "stan": { - "type": "string" - }, - "terminalBatch": { - "type": "string" - }, - "terminalID": { - "type": "string" - }, - "timeStamp": { - "type": "string", - "format": "date-time" - } - } - }, - "PerformanceBo": { - "title": "PerformanceBo", - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int64" - }, - "failurePercentage": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "PosData": { - "title": "PosData", - "required": [ - "posTimeStamp" - ], - "type": "object", - "properties": { - "languageCode": { - "type": "string" - }, - "posTimeStamp": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - } - }, - "PosDataReq": { - "title": "PosDataReq", - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "clerkID": { - "type": "string" - }, - "originalSalePosTimeStamp": { - "type": "string" - }, - "posTimeStamp": { - "type": "string", - "format": "date-time" - }, - "pumpNumber": { - "type": "string" - }, - "terminalID": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - } - }, - "PosDataRes": { - "title": "PosDataRes", - "required": [ - "posTimeStamp" - ], - "type": "object", - "properties": { - "languageCode": { - "type": "string" - }, - "posTimeStamp": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - } - }, - "PreAuthorizeStep": { - "title": "PreAuthorizeStep", - "type": "object", - "properties": { - "processInstanceId": { - "type": "string" - }, - "pspReferenceNumber": { - "type": "string" - } - } - }, - "PredictedTender": { - "title": "PredictedTender", - "type": "object", - "properties": { - "acquire": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "subtractDiscountAmount": { - "type": "boolean" - } - } - }, - "PriceAdjustment": { - "title": "PriceAdjustment", - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "PriceAdjustmentReq": { - "title": "PriceAdjustmentReq", - "required": [ - "amount", - "loyaltyOfferID", - "reason", - "referenceID" - ], - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "netAmount": { - "type": "number", - "format": "bigdecimal" - }, - "originalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "originalNetAmount": { - "type": "number", - "format": "bigdecimal" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "productCode": { - "type": "string" - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "taxSplit": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxSplit" - } - }, - "unitOfMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - }, - "vat": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "PriceAdjustmentRes": { - "title": "PriceAdjustmentRes", - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "ProcessInstanceDetails": { - "title": "ProcessInstanceDetails", - "type": "object", - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "tillId": { - "type": "integer", - "format": "int64" - }, - "version": { - "type": "string" - }, - "workflowName": { - "type": "string" - } - } - }, - "Product": { - "title": "Product", - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "categoryCode": { - "type": "string" - }, - "productCode": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - } - } - }, - "PumpReserve": { - "title": "PumpReserve", - "required": [ - "currencyCode", - "customerInfo", - "methodOfPaymentId", - "paymentProviderName", - "preAuthAmount", - "siteId" - ], - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "languageCode": { - "type": "string" - }, - "loyaltyPan": { - "type": "string" - }, - "methodOfPaymentId": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "pumpNumber": { - "type": "string" - }, - "siteId": { - "type": "string" - } - } - }, - "Receipt": { - "title": "Receipt", - "type": "object", - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ReceiptReq": { - "title": "ReceiptReq", - "required": [ - "receiptLines" - ], - "type": "object", - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ReceiptRes": { - "title": "ReceiptRes", - "type": "object", - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "RequestData": { - "title": "RequestData", - "required": [ - "requestID", - "requestType", - "workstationID" - ], - "type": "object", - "properties": { - "cartEvaluationID": { - "type": "string" - }, - "payTokenID": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - } - }, - "RequestDataReq": { - "title": "RequestDataReq", - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "countryCode": { - "type": "string" - }, - "extCorrelationId": { - "type": "string" - }, - "payTokenID": { - "type": "string" - }, - "paymentServiceProvider": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - } - }, - "RequestDataRes": { - "title": "RequestDataRes", - "type": "object", - "properties": { - "overallResult": { - "type": "string" - }, - "requestID": { - "type": "string" - } - } - }, - "ResponseData": { - "title": "ResponseData", - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "overallResult": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - } - }, - "ResponseDataReq": { - "title": "ResponseDataReq", - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "overallResult": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - } - }, - "ResponseDataRes": { - "title": "ResponseDataRes", - "type": "object", - "properties": { - "requestType": { - "type": "string" - } - } - }, - "SaleItem": { - "title": "SaleItem", - "required": [ - "additionalProductInfo", - "amount", - "originalAmount", - "quantity", - "saleItemType", - "unitMeasure", - "unitPrice" - ], - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "itemID": { - "type": "integer", - "format": "int32" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "originalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PriceAdjustment" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "saleChannel": { - "type": "integer", - "format": "int32" - }, - "saleItemType": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - }, - "unitMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - }, - "vatRate": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "SaleItemReq": { - "title": "SaleItemReq", - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "lineNo": { - "type": "string" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "netAmount": { - "type": "number", - "format": "bigdecimal" - }, - "originalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "originalNetAmount": { - "type": "number", - "format": "bigdecimal" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PriceAdjustmentReq" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "saleChannel": { - "type": "string" - }, - "saleItemType": { - "type": "string" - }, - "taxAmount": { - "type": "number", - "format": "bigdecimal" - }, - "taxCode": { - "type": "string" - }, - "taxRate": { - "type": "number", - "format": "bigdecimal" - }, - "unitOfMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - }, - "vatRate": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "SaleItemRes": { - "title": "SaleItemRes", - "required": [ - "additionalProductInfo", - "amount", - "originalAmount", - "quantity", - "saleItemType", - "unitMeasure", - "unitPrice" - ], - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "categoryCode": { - "type": "string" - }, - "itemID": { - "type": "integer", - "format": "int32" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "originalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PriceAdjustmentRes" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number", - "format": "bigdecimal" - }, - "saleChannel": { - "type": "integer", - "format": "int32" - }, - "saleItemType": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - }, - "unitMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number", - "format": "bigdecimal" - }, - "vatRate": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "SaleTransaction": { - "title": "SaleTransaction", - "required": [ - "totalAmount" - ], - "type": "object", - "properties": { - "authorization": { - "$ref": "#/components/schemas/Authorization" - }, - "coupons": { - "type": "array", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string" - }, - "currencyCode": { - "type": "string" - }, - "extraDiscountAmount": { - "type": "number", - "format": "double" - }, - "loyaltyPointAmount": { - "type": "integer", - "format": "int32" - }, - "merchantName": { - "type": "string" - }, - "netAmount": { - "type": "number", - "format": "double" - }, - "siteAddress": { - "type": "string" - }, - "siteName": { - "type": "string" - }, - "taxReferenceNumber": { - "type": "string" - }, - "timeStamp": { - "type": "string" - }, - "totalAmount": { - "type": "number", - "format": "double" - }, - "totalDiscountAmount": { - "type": "number", - "format": "double" - }, - "totalTaxAmount": { - "type": "number", - "format": "double" - }, - "transactionNumber": { - "type": "string" - } - } - }, - "ShellTransactionResponse": { - "title": "ShellTransactionResponse", - "type": "object", - "properties": { - "requestData": { - "$ref": "#/components/schemas/RequestDataRes" - }, - "responseData": { - "$ref": "#/components/schemas/ResponseDataRes" - } - } - }, - "SingleResponse«OfferEvaluation»": { - "title": "SingleResponse«OfferEvaluation»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OfferEvaluationRes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "SingleResponse«TxnStatusBo»": { - "title": "SingleResponse«TxnStatusBo»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TxnStatusBo" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "SingleResponse«UserTxnsBo»": { - "title": "SingleResponse«UserTxnsBo»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserTxnsBo" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "SingleResponse«WorkFlowCreationResponse»": { - "title": "SingleResponse«WorkFlowCreationResponse»", - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WorkFlowCreationResponse" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "SiteData": { - "title": "SiteData", - "required": [ - "countryCode", - "siteID" - ], - "type": "object", - "properties": { - "countryCode": { - "type": "string" - }, - "siteID": { - "type": "string" - } - } - }, - "SiteDataReq": { - "title": "SiteDataReq", - "type": "object", - "properties": { - "countryCode": { - "type": "string" - }, - "siteId": { - "type": "string" - } - } - }, - "SiteDataRes": { - "title": "SiteDataRes", - "required": [ - "countryCode", - "siteID" - ], - "type": "object", - "properties": { - "countryCode": { - "type": "string" - }, - "siteID": { - "type": "string" - } - } - }, - "StatResponse«Map«string,PerformanceBo»»": { - "title": "StatResponse«Map«string,PerformanceBo»»", - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/PerformanceBo" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "StatusCode": { - "title": "StatusCode", - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "isWarning": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "TaxSplit": { - "title": "TaxSplit", - "type": "object", - "properties": { - "additionalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "amount": { - "type": "number", - "format": "bigdecimal" - }, - "code": { - "type": "string" - }, - "rate": { - "type": "number", - "format": "bigdecimal" - }, - "taxID": { - "type": "integer", - "format": "int32" - } - } - }, - "Tender": { - "title": "Tender", - "required": [ - "acquirerID" - ], - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "integer", - "format": "int32" - }, - "netTenderAmount": { - "type": "number", - "format": "bigdecimal" - }, - "pointsRedeemed": { - "type": "number", - "format": "bigdecimal" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherRule" - } - } - } - }, - "TenderReq": { - "title": "TenderReq", - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "netTenderAmount": { - "type": "string" - }, - "pointsRedeemed": { - "type": "string" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "string" - }, - "totalAmount": { - "type": "string" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherRuleReq" - } - } - } - }, - "TenderRes": { - "title": "TenderRes", - "required": [ - "acquirerID" - ], - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "integer", - "format": "int32" - }, - "netTenderAmount": { - "type": "number", - "format": "bigdecimal" - }, - "pointsRedeemed": { - "type": "number", - "format": "bigdecimal" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VoucherRuleRes" - } - } - } - }, - "Terminal": { - "title": "Terminal", - "type": "object", - "properties": { - "stan": { - "type": "string" - }, - "terminalBatch": { - "type": "string" - } - } - }, - "TokenizeRO": { - "title": "TokenizeRO", - "required": [ - "currencyCode", - "customerInfo", - "loyaltyPan", - "paymentProviderName", - "registrationAmount" - ], - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/components/schemas/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - } - }, - "Tracker": { - "title": "Tracker", - "type": "object", - "properties": { - "trackerEarned": { - "type": "string" - }, - "trackerRedeemed": { - "type": "string" - }, - "trackerType": { - "type": "string" - }, - "trackerValue": { - "type": "string" - } - } - }, - "TransactionAddRO": { - "title": "TransactionAddRO", - "required": [ - "cardValues", - "receipt", - "requestData", - "saleItems", - "saleTransaction" - ], - "type": "object", - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicableVoucher" - } - }, - "cardValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CardValue" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerData" - } - }, - "mobilePaymentData": { - "$ref": "#/components/schemas/MobilePaymentData" - }, - "originalTransaction": { - "$ref": "#/components/schemas/OriginalTransaction" - }, - "posData": { - "$ref": "#/components/schemas/PosData" - }, - "receipt": { - "$ref": "#/components/schemas/Receipt" - }, - "requestData": { - "$ref": "#/components/schemas/RequestData" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleItem" - } - }, - "saleTransaction": { - "$ref": "#/components/schemas/SaleTransaction" - }, - "siteData": { - "$ref": "#/components/schemas/SiteData" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tender" - } - }, - "terminal": { - "$ref": "#/components/schemas/Terminal" - }, - "totalAmount": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "TransactionAddResponse": { - "title": "TransactionAddResponse", - "type": "object", - "properties": { - "shellResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShellTransactionResponse" - } - } - } - }, - "TxnStatusBo": { - "title": "TxnStatusBo", - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "extCorrelationId": { - "type": "string" - }, - "finalStatus": { - "type": "string" - }, - "instanceVariables": { - "type": "object" - }, - "languageCode": { - "type": "string" - }, - "methodOfPaymentId": { - "type": "string" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "pumpNumber": { - "type": "integer", - "format": "int32" - }, - "siteId": { - "type": "string" - }, - "status": { - "type": "string" - }, - "stepRequests": { - "type": "object" - }, - "workFlowDetails": { - "$ref": "#/components/schemas/ProcessInstanceDetails" - } - } - }, - "UpdatedEntityResponse": { - "title": "UpdatedEntityResponse", - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusCode" - } - } - } - }, - "UserTxnsBo": { - "title": "UserTxnsBo", - "type": "object", - "properties": { - "failedTxns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CallBackLogsDto" - } - }, - "inProgressTxns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CallBackLogsDto" - } - }, - "successTxns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CallBackLogsDto" - } - } - } - }, - "View": { - "title": "View", - "type": "object", - "properties": { - "contentType": { - "type": "string" - } - } - }, - "Violation": { - "title": "Violation", - "type": "object", - "properties": { - "fieldName": { - "type": "string" - }, - "invalidValue": { - "type": "object" - }, - "message": { - "type": "string" - } - } - }, - "VoucherCodesResult": { - "title": "VoucherCodesResult", - "type": "object", - "properties": { - "actionCode": { - "type": "integer", - "format": "int32" - }, - "actionCodeDescription": { - "type": "string" - }, - "voucherCode": { - "type": "string" - } - } - }, - "VoucherRule": { - "title": "VoucherRule", - "required": [ - "voucherCode" - ], - "type": "object", - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "VoucherRuleReq": { - "title": "VoucherRuleReq", - "type": "object", - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string", - "format": "date-time" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "referenceId": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "VoucherRuleRes": { - "title": "VoucherRuleRes", - "required": [ - "voucherCode" - ], - "type": "object", - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number", - "format": "bigdecimal" - } - } - }, - "WorkFlowCreationResponse": { - "title": "WorkFlowCreationResponse", - "type": "object", - "properties": { - "deploymentId": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "WorkFlowPromote": { - "title": "WorkFlowPromote", - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "workFlowName": { - "type": "string" - } - } - }, - "WorkflowInputAction": { - "title": "WorkflowInputAction", - "required": [ - "httpCallInputProperties" - ], - "type": "object", - "properties": { - "actionGroupType": { - "type": "string", - "enum": [ - "PARALLEL", - "SERIAL", - "XOR" - ] - }, - "delayTimeInRetrial": { - "type": "integer", - "format": "int32" - }, - "httpCallInputProperties": { - "$ref": "#/components/schemas/ActionInput" - }, - "httpCallInputPropertiesRollback": { - "$ref": "#/components/schemas/ActionInput" - }, - "isAsync": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "properties": { - "type": "object" - }, - "retrialCount": { - "type": "integer", - "format": "int32" - }, - "rollBackProperties": { - "type": "object" - }, - "serialNumber": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string", - "enum": [ - "CCCaptureAction", - "addTransactionAction", - "authorizePaymentWithPsp", - "confirmAuthWithPSPAction", - "eghlCapturePaymentAction", - "eghlTokenizationAction", - "emptyAction", - "generatePaymentIdAction", - "ifredeemPointsAction", - "invalid", - "oAuthHttpAction", - "offerEvaluationAction", - "redeemPointsAction", - "saveCCardAction" - ] - } - } - }, - "WorkflowProcess": { - "title": "WorkflowProcess", - "type": "object", - "properties": { - "isAsync": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "steps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowStep" - } - } - } - }, - "WorkflowStep": { - "title": "WorkflowStep", - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowInputAction" - } - }, - "maxWaitTimeInMillis": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "serialNumber": { - "type": "integer", - "format": "int32" - } - } - }, - "_2c2pCallbackRequest": { - "title": "_2c2pCallbackRequest", - "type": "object", - "properties": { - "payload": { - "type": "string" - } - } - } - } - } -} +{"openapi":"3.0.3","info":{"title":"POTATO","description":"Potato OTA Transaction Orchestrator","contact":{"name":"Capillary Technologies","url":"https://www.capillarytech.com"},"license":{},"version":"1.0"},"servers":[{"url":"https://orchestratoradmin.crm-nightly-new.cctools.capillarytech.com:443","description":"Inferred Url"}],"tags":[{"name":"_2c-2p-callback-resource","description":"_2c 2p Callback Resource"},{"name":"admin-workflow-resource","description":"Admin Workflow Resource"},{"name":"cancel-sandbox","description":"Cancel Sandbox"},{"name":"eghl-call-back-resource","description":"Eghl Call Back Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"mobile-card-registration-resource","description":"Mobile Card Registration Resource"},{"name":"payments-resource","description":"Payments Resource"},{"name":"psp-callback-resource","description":"Psp Callback Resource"},{"name":"psp-performance-resource","description":"Psp Performance Resource"},{"name":"psp-reconciliation","description":"PSP Reconciliation"},{"name":"pump-life-cycle-resource","description":"Pump Life Cycle Resource"},{"name":"pump-performance-resource","description":"Pump Performance Resource"},{"name":"shell-server-to-server-resource","description":"Shell Server To Server Resource"},{"name":"test-fuelling-workflow-resource","description":"Test Fuelling Workflow Resource"},{"name":"transaction-status-resource","description":"Transaction Status Resource"},{"name":"txn-status-resource","description":"Txn Status Resource"}],"paths":{"/orchestrator/payments/webhooks/2c2p/fuelling-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"fuellingCallBack","operationId":"fuellingCallBackUsingPOST","parameters":[{"name":"defaultCard","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"extCorrelationID","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"orgId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentProvider","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"userId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_2c2pCallbackRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/register-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"registerCallBack","operationId":"registerCallBackUsingPOST","parameters":[{"name":"defaultCard","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"extCorrelationID","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"orgId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentProvider","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"userId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_2c2pCallbackRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow":{"get":{"tags":["admin-workflow-resource"],"summary":"get","operationId":"getUsingGET","parameters":[{"name":"allVersions","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"name","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetEntityResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]},"post":{"tags":["admin-workflow-resource"],"summary":"create","operationId":"createUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowProcess"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«WorkFlowCreationResponse»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/promotion":{"put":{"tags":["admin-workflow-resource"],"summary":"promoteWorkFlow","operationId":"promoteWorkFlowUsingPUT","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkFlowPromote"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdatedEntityResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/cancel":{"post":{"tags":["cancel-sandbox"],"summary":"cancel","operationId":"cancelUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRO"}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/callback":{"post":{"tags":["eghl-call-back-resource"],"summary":"saveToken","operationId":"saveTokenUsingPOST","parameters":[{"name":"shouldSave","in":"query","required":false,"style":"form","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/payment-identifier":{"post":{"tags":["eghl-call-back-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/transaction":{"post":{"tags":["eghl-call-back-resource"],"summary":"callback","operationId":"callbackUsingPOST","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/ping":{"get":{"tags":["health-check-resource"],"summary":"application health check","operationId":"healthCheckUsingGET","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/register-paymentIdV1":{"post":{"tags":["mobile-card-registration-resource"],"summary":"registerPaymentId","operationId":"registerPaymentIdUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRegisterROReq"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«CardRegisterRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/register-paymentId":{"post":{"tags":["mobile-card-registration-resource"],"summary":"generatePaymentIdentifier","operationId":"generatePaymentIdentifierUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/evaluateOffer":{"post":{"tags":["payments-resource"],"summary":"evaluateOffers","operationId":"evaluateOffersUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferEvaluationReq"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«OfferEvaluation»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/transactionAdd":{"post":{"tags":["payments-resource"],"summary":"txnAdd","operationId":"txnAddUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAddRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransactionAddResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/psp/payment-identifier":{"post":{"tags":["psp-callback-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/bank":{"get":{"tags":["psp-performance-resource"],"summary":"pspStat","operationId":"pspStatUsingGET","parameters":[{"name":"bankName","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},{"name":"durationHours","in":"query","required":false,"style":"form","schema":{"maximum":12,"exclusiveMaximum":false,"type":"integer","format":"int32"}},{"name":"psp","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatResponse«Map«string,PerformanceBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/capture":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationCapture","operationId":"reconciliationCaptureUsingPOST","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/registration-reversal":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationRegistrationReversal","operationId":"reconciliationRegistrationReversalUsingPOST","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-activate":{"post":{"tags":["pump-life-cycle-resource"],"summary":"activatePump","operationId":"activatePumpUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthorizeStep"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PreAuthorizeStep»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-cancel":{"post":{"tags":["pump-life-cycle-resource"],"summary":"cancelPump","operationId":"cancelPumpUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CancelResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-reserve":{"post":{"tags":["pump-life-cycle-resource"],"summary":"pumpReserve","operationId":"pumpReserveUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PumpReserve"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PumpReserve»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/pump":{"get":{"tags":["pump-performance-resource"],"summary":"pumpStat","operationId":"pumpStatUsingGET","parameters":[{"name":"durationHours","in":"query","required":false,"style":"form","schema":{"maximum":12,"exclusiveMaximum":false,"type":"integer","format":"int32"}},{"name":"siteId","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatResponse«Map«string,PerformanceBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/finalize-txn":{"post":{"tags":["shell-server-to-server-resource"],"summary":"finalizeTransaction","operationId":"finalizeTransactionUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAddRO"}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/get-offers":{"post":{"tags":["shell-server-to-server-resource"],"summary":"offerEvaluation","operationId":"offerEvaluationUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferEvaluation"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OfferEvaluation"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/pumpReserve/{version}":{"post":{"tags":["test-fuelling-workflow-resource"],"summary":"pumpReserveWithGivenVersion","operationId":"pumpReserveWithGivenVersionUsingPOST","parameters":[{"name":"version","in":"path","description":"version","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PumpReserve"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PumpReserve»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/fuelling-status":{"get":{"tags":["transaction-status-resource"],"summary":"status","operationId":"statusUsingGET","parameters":[{"name":"customerId","in":"query","required":true,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentId","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppTransactionStatusResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}":{"get":{"tags":["txn-status-resource"],"summary":"getStatusByPaymentId","operationId":"getStatusByPaymentIdUsingGET","parameters":[{"name":"paymentId","in":"path","description":"paymentId","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«TxnStatusBo»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/user-id/{userId}":{"get":{"tags":["txn-status-resource"],"summary":"OTATransactionsByUserId","operationId":"OTATransactionsByUserIdUsingGET","parameters":[{"name":"userId","in":"path","description":"userId","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«List«UserTransactionBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}}},"components":{"schemas":{"ActionInput":{"title":"ActionInput","type":"object","properties":{"actionName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"entityId":{"type":"integer","format":"int64"},"input":{"type":"object"},"orgId":{"type":"integer","format":"int64"},"processInstanceId":{"type":"string"},"version":{"type":"string"},"workFlowName":{"type":"string"}}},"AppTransactionStatusResponse":{"title":"AppTransactionStatusResponse","type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"processInstanceId":{"type":"string"},"pumpNumber":{"type":"string"},"stationId":{"type":"string"},"transactionState":{"type":"string","enum":["BILL_GENERATED","FUELING_CANCELLED_BY_CUSTOMER","FUELING_CANCELLED_BY_STATION","PUMP_ACTIVATION_FAIL","PUMP_ACTIVATION_SUCCESS","PUMP_RESERVE_FAIL","PUMP_RESERVE_SUCCESS","TXN_STATE_UNKNOWN"]}}},"ApplicableVoucher":{"title":"ApplicableVoucher","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"ApplicableVoucherReq":{"title":"ApplicableVoucherReq","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"string"}}},"ApplicableVoucherRes":{"title":"ApplicableVoucherRes","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"Authorization":{"title":"Authorization","type":"object","properties":{"approvalCode":{"type":"string"},"batch":{"type":"string"},"couponCode":{"type":"string"},"coupons":{"type":"string"},"merchantName":{"type":"string"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"stan":{"type":"string"},"terminalID":{"type":"string"}}},"CancelRO":{"title":"CancelRO","type":"object","properties":{"mobilePaymentData":{"$ref":"#/components/schemas/MobilePaymentData"},"requestData":{"$ref":"#/components/schemas/RequestData"}}},"CancelRequest":{"title":"CancelRequest","type":"object","properties":{"processInstanceId":{"type":"string"}}},"CancelResponse":{"title":"CancelResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"CardRegisterROReq":{"title":"CardRegisterROReq","required":["currencyCode","customerInfo","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"CardRegisterRORes":{"title":"CardRegisterRORes","required":["currencyCode","customerInfo","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"CardValue":{"title":"CardValue","type":"object","properties":{"cardCircuit":{"type":"string"},"cardEntryMode":{"type":"string"},"cardID":{"type":"string"},"inString":{"type":"string"},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"string"},"trackers":{"type":"array","items":{"$ref":"#/components/schemas/Tracker"}}}},"CustomerData":{"title":"CustomerData","required":["customerDataType","customerDataValue"],"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerDataReq":{"title":"CustomerDataReq","type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerDataRes":{"title":"CustomerDataRes","required":["customerDataType","customerDataValue"],"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerInfo":{"title":"CustomerInfo","required":["identifierName"],"type":"object","properties":{"accountId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"identifierName":{"type":"string","enum":["cardnumber","email","externalId","mobile","wechat"]},"identifierValue":{"type":"string"},"source":{"type":"string"}}},"GetEntityResponse":{"title":"GetEntityResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"workflowMeta":{"type":"array","items":{"$ref":"#/components/schemas/OrgWorkflowMetaDto"}}}},"LoyaltyDetails":{"title":"LoyaltyDetails","type":"object","properties":{"loyaltyPAN":{"type":"string"},"loyaltyType":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"trackers":{"type":"array","items":{"$ref":"#/components/schemas/Tracker"}}}},"LoyaltyOffer":{"title":"LoyaltyOffer","type":"object","properties":{"loyaltyOfferDescription":{"type":"string"},"loyaltyOfferID":{"type":"string"},"promotionType":{"type":"string","enum":["Cart","lineitem"]},"referenceID":{"type":"string"}}},"Message":{"title":"Message","type":"object","properties":{"cashierMessage":{"type":"string"}}},"MobilePaymentData":{"title":"MobilePaymentData","type":"object","properties":{"acquirerID":{"type":"string"},"globalRetailSiteID":{"type":"string"},"loyaltyDetails":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyDetails"}},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"merchantID":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"paymentData":{"type":"string"},"paymentServiceProvider":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"}}},"MobileResponseBody«CardRegisterRO»":{"title":"MobileResponseBody«CardRegisterRO»","type":"object","properties":{"data":{"$ref":"#/components/schemas/CardRegisterRORes"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«PreAuthorizeStep»":{"title":"MobileResponseBody«PreAuthorizeStep»","type":"object","properties":{"data":{"$ref":"#/components/schemas/PreAuthorizeStep"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«PumpReserve»":{"title":"MobileResponseBody«PumpReserve»","type":"object","properties":{"data":{"$ref":"#/components/schemas/PumpReserve"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«TokenizeRO»":{"title":"MobileResponseBody«TokenizeRO»","type":"object","properties":{"data":{"$ref":"#/components/schemas/TokenizeRO"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"OfferEvaluation":{"title":"OfferEvaluation","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucher"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerData"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosData"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/Receipt"},"requestData":{"$ref":"#/components/schemas/RequestData"},"responseData":{"$ref":"#/components/schemas/ResponseData"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItem"}},"siteData":{"$ref":"#/components/schemas/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/Tender"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OfferEvaluationReq":{"title":"OfferEvaluationReq","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucherReq"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDataReq"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosDataReq"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/ReceiptReq"},"requestData":{"$ref":"#/components/schemas/RequestDataReq"},"responseData":{"$ref":"#/components/schemas/ResponseDataReq"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItemReq"}},"siteData":{"$ref":"#/components/schemas/SiteDataReq"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/TenderReq"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OfferEvaluationRes":{"title":"OfferEvaluationRes","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucherRes"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDataRes"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosDataRes"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/ReceiptRes"},"requestData":{"$ref":"#/components/schemas/RequestDataRes"},"responseData":{"$ref":"#/components/schemas/ResponseDataRes"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItemRes"}},"siteData":{"$ref":"#/components/schemas/SiteDataRes"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/TenderRes"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OrgWorkflowMetaDto":{"title":"OrgWorkflowMetaDto","type":"object","properties":{"autoUpdateTime":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"isApproved":{"type":"boolean"},"isAsync":{"type":"boolean"},"isDefault":{"type":"boolean"},"orgId":{"type":"integer","format":"int64"},"processId":{"type":"string"},"promotedOn":{"type":"string","format":"date-time"},"versionName":{"type":"string"},"workflowName":{"type":"string"}}},"OriginalTransaction":{"title":"OriginalTransaction","type":"object","properties":{"approvalCode":{"type":"string"},"authorizationToken":{"type":"string"},"stan":{"type":"string"},"terminalBatch":{"type":"string"},"terminalID":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}}},"PerformanceBo":{"title":"PerformanceBo","type":"object","properties":{"count":{"type":"integer","format":"int64"},"failurePercentage":{"type":"number","format":"bigdecimal"}}},"PosData":{"title":"PosData","required":["posTimeStamp"],"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}}},"PosDataReq":{"title":"PosDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"clerkID":{"type":"string"},"originalSalePosTimeStamp":{"type":"string"},"posTimeStamp":{"type":"string","format":"date-time"},"pumpNumber":{"type":"string"},"terminalID":{"type":"string"},"transactionNumber":{"type":"string"}}},"PosDataRes":{"title":"PosDataRes","required":["posTimeStamp"],"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}}},"PreAuthorizeStep":{"title":"PreAuthorizeStep","type":"object","properties":{"processInstanceId":{"type":"string"},"pspReferenceNumber":{"type":"string"}}},"PredictedTender":{"title":"PredictedTender","type":"object","properties":{"acquire":{"type":"string"},"methodOfPayment":{"type":"string"},"subtractDiscountAmount":{"type":"boolean"}}},"PriceAdjustment":{"title":"PriceAdjustment","type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"}}},"PriceAdjustmentReq":{"title":"PriceAdjustmentReq","required":["amount","loyaltyOfferID","reason","referenceID"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"netAmount":{"type":"number","format":"bigdecimal"},"originalAmount":{"type":"number","format":"bigdecimal"},"originalNetAmount":{"type":"number","format":"bigdecimal"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"productCode":{"type":"string"},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"taxSplit":{"type":"array","items":{"$ref":"#/components/schemas/TaxSplit"}},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vat":{"type":"number","format":"bigdecimal"}}},"PriceAdjustmentRes":{"title":"PriceAdjustmentRes","type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"}}},"ProcessInstanceDetails":{"title":"ProcessInstanceDetails","type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"tillId":{"type":"integer","format":"int64"},"version":{"type":"string"},"workflowName":{"type":"string"}}},"Product":{"title":"Product","type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"categoryCode":{"type":"string"},"productCode":{"type":"string"},"subCategoryCode":{"type":"string"}}},"PumpReserve":{"title":"PumpReserve","required":["currencyCode","customerInfo","methodOfPaymentId","paymentProviderName","preAuthAmount","siteId"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"languageCode":{"type":"string"},"loyaltyPan":{"type":"string"},"methodOfPaymentId":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"string"},"siteId":{"type":"string"}}},"Receipt":{"title":"Receipt","type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"ReceiptReq":{"title":"ReceiptReq","required":["receiptLines"],"type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"ReceiptRes":{"title":"ReceiptRes","type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"RequestData":{"title":"RequestData","required":["requestID","requestType","workstationID"],"type":"object","properties":{"cartEvaluationID":{"type":"string"},"payTokenID":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"RequestDataReq":{"title":"RequestDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"countryCode":{"type":"string"},"extCorrelationId":{"type":"string"},"payTokenID":{"type":"string"},"paymentServiceProvider":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"transactionNumber":{"type":"string"},"workstationID":{"type":"string"}}},"RequestDataRes":{"title":"RequestDataRes","type":"object","properties":{"overallResult":{"type":"string"},"requestID":{"type":"string"}}},"ResponseData":{"title":"ResponseData","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"ResponseDataReq":{"title":"ResponseDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"ResponseDataRes":{"title":"ResponseDataRes","type":"object","properties":{"requestType":{"type":"string"}}},"SaleItem":{"title":"SaleItem","required":["additionalProductInfo","amount","originalAmount","quantity","saleItemType","unitMeasure","unitPrice"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustment"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleItemReq":{"title":"SaleItemReq","type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"lineNo":{"type":"string"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"netAmount":{"type":"number","format":"bigdecimal"},"originalAmount":{"type":"number","format":"bigdecimal"},"originalNetAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustmentReq"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"string"},"saleItemType":{"type":"string"},"taxAmount":{"type":"number","format":"bigdecimal"},"taxCode":{"type":"string"},"taxRate":{"type":"number","format":"bigdecimal"},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleItemRes":{"title":"SaleItemRes","required":["additionalProductInfo","amount","originalAmount","quantity","saleItemType","unitMeasure","unitPrice"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustmentRes"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleTransaction":{"title":"SaleTransaction","required":["totalAmount"],"type":"object","properties":{"authorization":{"$ref":"#/components/schemas/Authorization"},"coupons":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"currencyCode":{"type":"string"},"extraDiscountAmount":{"type":"number","format":"double"},"loyaltyPointAmount":{"type":"integer","format":"int32"},"merchantName":{"type":"string"},"netAmount":{"type":"number","format":"double"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"taxReferenceNumber":{"type":"string"},"timeStamp":{"type":"string"},"totalAmount":{"type":"number","format":"double"},"totalDiscountAmount":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"transactionNumber":{"type":"string"}}},"ShellTransactionResponse":{"title":"ShellTransactionResponse","type":"object","properties":{"requestData":{"$ref":"#/components/schemas/RequestDataRes"},"responseData":{"$ref":"#/components/schemas/ResponseDataRes"}}},"SingleResponse«List«UserTransactionBo»»":{"title":"SingleResponse«List«UserTransactionBo»»","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserTransactionBo"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«OfferEvaluation»":{"title":"SingleResponse«OfferEvaluation»","type":"object","properties":{"data":{"$ref":"#/components/schemas/OfferEvaluationRes"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«TxnStatusBo»":{"title":"SingleResponse«TxnStatusBo»","type":"object","properties":{"data":{"$ref":"#/components/schemas/TxnStatusBo"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«WorkFlowCreationResponse»":{"title":"SingleResponse«WorkFlowCreationResponse»","type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkFlowCreationResponse"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SiteData":{"title":"SiteData","required":["countryCode","siteID"],"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}}},"SiteDataReq":{"title":"SiteDataReq","type":"object","properties":{"countryCode":{"type":"string"},"siteId":{"type":"string"}}},"SiteDataRes":{"title":"SiteDataRes","required":["countryCode","siteID"],"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}}},"StatResponse«Map«string,PerformanceBo»»":{"title":"StatResponse«Map«string,PerformanceBo»»","type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PerformanceBo"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"StatusCode":{"title":"StatusCode","type":"object","properties":{"code":{"type":"integer","format":"int32"},"isWarning":{"type":"boolean"},"message":{"type":"string"}}},"TaxSplit":{"title":"TaxSplit","type":"object","properties":{"additionalAmount":{"type":"number","format":"bigdecimal"},"amount":{"type":"number","format":"bigdecimal"},"code":{"type":"string"},"rate":{"type":"number","format":"bigdecimal"},"taxID":{"type":"integer","format":"int32"}}},"Tender":{"title":"Tender","required":["acquirerID"],"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number","format":"bigdecimal"},"pointsRedeemed":{"type":"number","format":"bigdecimal"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRule"}}}},"TenderReq":{"title":"TenderReq","type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"string"},"netTenderAmount":{"type":"string"},"pointsRedeemed":{"type":"string"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"string"},"totalAmount":{"type":"string"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRuleReq"}}}},"TenderRes":{"title":"TenderRes","required":["acquirerID"],"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number","format":"bigdecimal"},"pointsRedeemed":{"type":"number","format":"bigdecimal"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRuleRes"}}}},"Terminal":{"title":"Terminal","type":"object","properties":{"stan":{"type":"string"},"terminalBatch":{"type":"string"}}},"TokenizeRO":{"title":"TokenizeRO","required":["currencyCode","customerInfo","loyaltyPan","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"Tracker":{"title":"Tracker","type":"object","properties":{"trackerEarned":{"type":"string"},"trackerRedeemed":{"type":"string"},"trackerType":{"type":"string"},"trackerValue":{"type":"string"}}},"TransactionAddRO":{"title":"TransactionAddRO","required":["cardValues","receipt","requestData","saleItems","saleTransaction"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucher"}},"cardValues":{"type":"array","items":{"$ref":"#/components/schemas/CardValue"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerData"}},"mobilePaymentData":{"$ref":"#/components/schemas/MobilePaymentData"},"originalTransaction":{"$ref":"#/components/schemas/OriginalTransaction"},"posData":{"$ref":"#/components/schemas/PosData"},"receipt":{"$ref":"#/components/schemas/Receipt"},"requestData":{"$ref":"#/components/schemas/RequestData"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItem"}},"saleTransaction":{"$ref":"#/components/schemas/SaleTransaction"},"siteData":{"$ref":"#/components/schemas/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/Tender"}},"terminal":{"$ref":"#/components/schemas/Terminal"},"totalAmount":{"type":"number","format":"bigdecimal"}}},"TransactionAddResponse":{"title":"TransactionAddResponse","type":"object","properties":{"shellResponse":{"type":"array","items":{"$ref":"#/components/schemas/ShellTransactionResponse"}}}},"TxnStatusBo":{"title":"TxnStatusBo","type":"object","properties":{"currencyCode":{"type":"string"},"extCorrelationId":{"type":"string"},"finalStatus":{"type":"string"},"instanceVariables":{"type":"object"},"languageCode":{"type":"string"},"methodOfPaymentId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"status":{"type":"string"},"stepRequests":{"type":"object"},"workFlowDetails":{"$ref":"#/components/schemas/ProcessInstanceDetails"}}},"UpdatedEntityResponse":{"title":"UpdatedEntityResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"UserTransactionBo":{"title":"UserTransactionBo","type":"object","properties":{"extCorrelationId":{"type":"string"},"id":{"type":"integer","format":"int64"},"invoice":{"type":"string"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpId":{"type":"string"},"siteId":{"type":"string"},"startTimestamp":{"type":"string","format":"date-time"},"status":{"type":"string"},"type":{"type":"string"}}},"Violation":{"title":"Violation","type":"object","properties":{"fieldName":{"type":"string"},"invalidValue":{"type":"object"},"message":{"type":"string"}}},"VoucherCodesResult":{"title":"VoucherCodesResult","type":"object","properties":{"actionCode":{"type":"integer","format":"int32"},"actionCodeDescription":{"type":"string"},"voucherCode":{"type":"string"}}},"VoucherRule":{"title":"VoucherRule","required":["voucherCode"],"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"VoucherRuleReq":{"title":"VoucherRuleReq","type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"referenceId":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"VoucherRuleRes":{"title":"VoucherRuleRes","required":["voucherCode"],"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"WorkFlowCreationResponse":{"title":"WorkFlowCreationResponse","type":"object","properties":{"deploymentId":{"type":"string"},"version":{"type":"string"}}},"WorkFlowPromote":{"title":"WorkFlowPromote","type":"object","properties":{"version":{"type":"string"},"workFlowName":{"type":"string"}}},"WorkflowInputAction":{"title":"WorkflowInputAction","required":["httpCallInputProperties"],"type":"object","properties":{"actionGroupType":{"type":"string","enum":["PARALLEL","SERIAL","XOR"]},"delayTimeInRetrial":{"type":"integer","format":"int32"},"httpCallInputProperties":{"$ref":"#/components/schemas/ActionInput"},"httpCallInputPropertiesRollback":{"$ref":"#/components/schemas/ActionInput"},"isAsync":{"type":"boolean"},"name":{"type":"string"},"properties":{"type":"object"},"retrialCount":{"type":"integer","format":"int32"},"rollBackProperties":{"type":"object"},"serialNumber":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["CCCaptureAction","addTransactionAction","authorizePaymentWithPsp","confirmAuthWithPSPAction","eghlCapturePaymentAction","eghlTokenizationAction","emptyAction","generatePaymentIdAction","ifredeemPointsAction","invalid","oAuthHttpAction","offerEvaluationAction","redeemPointsAction","saveCCardAction"]}}},"WorkflowProcess":{"title":"WorkflowProcess","type":"object","properties":{"isAsync":{"type":"boolean"},"name":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}}},"WorkflowStep":{"title":"WorkflowStep","type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowInputAction"}},"maxWaitTimeInMillis":{"type":"integer","format":"int32"},"name":{"type":"string"},"serialNumber":{"type":"integer","format":"int32"}}},"_2c2pCallbackRequest":{"title":"_2c2pCallbackRequest","type":"object","properties":{"payload":{"type":"string"}}}},"securitySchemes":{"X-CAP-API-AUTH-ORG-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ORG-ID","in":"header"},"X-CAP-API-AUTH-ENTITY-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ENTITY-ID","in":"header"},"X-CAP-ENTITY-CODE":{"type":"apiKey","name":"X-CAP-ENTITY-CODE","in":"header"},"X-CAP-ENTITY-ID":{"type":"apiKey","name":"X-CAP-ENTITY-ID","in":"header"}}}} From 748ee49b683954923f9923436eebdc5cdf7c514e Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:44:18 +0530 Subject: [PATCH 136/150] Update swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index 5e3a7efc491..ff559859225 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -32,7 +32,7 @@ elif [ "$Client" = "php" ]; then rm -rf orchestrator/php_client/php mkdir -p orchestrator/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i orchestrator.json \ + -i promotion-engine.json \ -l php \ -o orchestrator/php_client/php \ -c config.json From 4bbc112956a8d363b41ac79287839a041ccbe5e7 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:47:22 +0530 Subject: [PATCH 137/150] Update orchestrator.json From 02e8c833ce1a2acfa6552c5b4c48b4a2c47321b8 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 17:47:52 +0530 Subject: [PATCH 138/150] Update swagger_orchestrator_sdk.sh --- swagger_orchestrator_sdk.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index ff559859225..5e3a7efc491 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -32,7 +32,7 @@ elif [ "$Client" = "php" ]; then rm -rf orchestrator/php_client/php mkdir -p orchestrator/php_client/php java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i promotion-engine.json \ + -i orchestrator.json \ -l php \ -o orchestrator/php_client/php \ -c config.json From 1bc982a97618221a053139eaa7cb284fbe07fa53 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 18:10:39 +0530 Subject: [PATCH 139/150] Update orchestrator.json --- orchestrator.json | 4781 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 4780 insertions(+), 1 deletion(-) diff --git a/orchestrator.json b/orchestrator.json index 19bf224315e..b7058a4050c 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -1 +1,4780 @@ -{"openapi":"3.0.3","info":{"title":"POTATO","description":"Potato OTA Transaction Orchestrator","contact":{"name":"Capillary Technologies","url":"https://www.capillarytech.com"},"license":{},"version":"1.0"},"servers":[{"url":"https://orchestratoradmin.crm-nightly-new.cctools.capillarytech.com:443","description":"Inferred Url"}],"tags":[{"name":"_2c-2p-callback-resource","description":"_2c 2p Callback Resource"},{"name":"admin-workflow-resource","description":"Admin Workflow Resource"},{"name":"cancel-sandbox","description":"Cancel Sandbox"},{"name":"eghl-call-back-resource","description":"Eghl Call Back Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"mobile-card-registration-resource","description":"Mobile Card Registration Resource"},{"name":"payments-resource","description":"Payments Resource"},{"name":"psp-callback-resource","description":"Psp Callback Resource"},{"name":"psp-performance-resource","description":"Psp Performance Resource"},{"name":"psp-reconciliation","description":"PSP Reconciliation"},{"name":"pump-life-cycle-resource","description":"Pump Life Cycle Resource"},{"name":"pump-performance-resource","description":"Pump Performance Resource"},{"name":"shell-server-to-server-resource","description":"Shell Server To Server Resource"},{"name":"test-fuelling-workflow-resource","description":"Test Fuelling Workflow Resource"},{"name":"transaction-status-resource","description":"Transaction Status Resource"},{"name":"txn-status-resource","description":"Txn Status Resource"}],"paths":{"/orchestrator/payments/webhooks/2c2p/fuelling-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"fuellingCallBack","operationId":"fuellingCallBackUsingPOST","parameters":[{"name":"defaultCard","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"extCorrelationID","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"orgId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentProvider","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"userId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_2c2pCallbackRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/register-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"registerCallBack","operationId":"registerCallBackUsingPOST","parameters":[{"name":"defaultCard","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"extCorrelationID","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"orgId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentProvider","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"userId","in":"query","required":false,"style":"form","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_2c2pCallbackRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow":{"get":{"tags":["admin-workflow-resource"],"summary":"get","operationId":"getUsingGET","parameters":[{"name":"allVersions","in":"query","required":false,"style":"form","schema":{"type":"boolean"}},{"name":"name","in":"query","required":false,"style":"form","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetEntityResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]},"post":{"tags":["admin-workflow-resource"],"summary":"create","operationId":"createUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowProcess"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«WorkFlowCreationResponse»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/promotion":{"put":{"tags":["admin-workflow-resource"],"summary":"promoteWorkFlow","operationId":"promoteWorkFlowUsingPUT","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkFlowPromote"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdatedEntityResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/cancel":{"post":{"tags":["cancel-sandbox"],"summary":"cancel","operationId":"cancelUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRO"}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/callback":{"post":{"tags":["eghl-call-back-resource"],"summary":"saveToken","operationId":"saveTokenUsingPOST","parameters":[{"name":"shouldSave","in":"query","required":false,"style":"form","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/payment-identifier":{"post":{"tags":["eghl-call-back-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/transaction":{"post":{"tags":["eghl-call-back-resource"],"summary":"callback","operationId":"callbackUsingPOST","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/ping":{"get":{"tags":["health-check-resource"],"summary":"application health check","operationId":"healthCheckUsingGET","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/register-paymentIdV1":{"post":{"tags":["mobile-card-registration-resource"],"summary":"registerPaymentId","operationId":"registerPaymentIdUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardRegisterROReq"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«CardRegisterRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/register-paymentId":{"post":{"tags":["mobile-card-registration-resource"],"summary":"generatePaymentIdentifier","operationId":"generatePaymentIdentifierUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/evaluateOffer":{"post":{"tags":["payments-resource"],"summary":"evaluateOffers","operationId":"evaluateOffersUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferEvaluationReq"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«OfferEvaluation»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/transactionAdd":{"post":{"tags":["payments-resource"],"summary":"txnAdd","operationId":"txnAddUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAddRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransactionAddResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/psp/payment-identifier":{"post":{"tags":["psp-callback-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeRO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«TokenizeRO»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/bank":{"get":{"tags":["psp-performance-resource"],"summary":"pspStat","operationId":"pspStatUsingGET","parameters":[{"name":"bankName","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},{"name":"durationHours","in":"query","required":false,"style":"form","schema":{"maximum":12,"exclusiveMaximum":false,"type":"integer","format":"int32"}},{"name":"psp","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatResponse«Map«string,PerformanceBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/capture":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationCapture","operationId":"reconciliationCaptureUsingPOST","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/registration-reversal":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationRegistrationReversal","operationId":"reconciliationRegistrationReversalUsingPOST","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-activate":{"post":{"tags":["pump-life-cycle-resource"],"summary":"activatePump","operationId":"activatePumpUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreAuthorizeStep"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PreAuthorizeStep»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-cancel":{"post":{"tags":["pump-life-cycle-resource"],"summary":"cancelPump","operationId":"cancelPumpUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CancelResponse"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-reserve":{"post":{"tags":["pump-life-cycle-resource"],"summary":"pumpReserve","operationId":"pumpReserveUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PumpReserve"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PumpReserve»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/pump":{"get":{"tags":["pump-performance-resource"],"summary":"pumpStat","operationId":"pumpStatUsingGET","parameters":[{"name":"durationHours","in":"query","required":false,"style":"form","schema":{"maximum":12,"exclusiveMaximum":false,"type":"integer","format":"int32"}},{"name":"siteId","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatResponse«Map«string,PerformanceBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/finalize-txn":{"post":{"tags":["shell-server-to-server-resource"],"summary":"finalizeTransaction","operationId":"finalizeTransactionUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionAddRO"}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/get-offers":{"post":{"tags":["shell-server-to-server-resource"],"summary":"offerEvaluation","operationId":"offerEvaluationUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferEvaluation"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OfferEvaluation"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/pumpReserve/{version}":{"post":{"tags":["test-fuelling-workflow-resource"],"summary":"pumpReserveWithGivenVersion","operationId":"pumpReserveWithGivenVersionUsingPOST","parameters":[{"name":"version","in":"path","description":"version","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PumpReserve"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MobileResponseBody«PumpReserve»"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/fuelling-status":{"get":{"tags":["transaction-status-resource"],"summary":"status","operationId":"statusUsingGET","parameters":[{"name":"customerId","in":"query","required":true,"style":"form","schema":{"type":"integer","format":"int64"}},{"name":"paymentId","in":"query","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AppTransactionStatusResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}":{"get":{"tags":["txn-status-resource"],"summary":"getStatusByPaymentId","operationId":"getStatusByPaymentIdUsingGET","parameters":[{"name":"paymentId","in":"path","description":"paymentId","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«TxnStatusBo»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/user-id/{userId}":{"get":{"tags":["txn-status-resource"],"summary":"OTATransactionsByUserId","operationId":"OTATransactionsByUserIdUsingGET","parameters":[{"name":"userId","in":"path","description":"userId","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponse«List«UserTransactionBo»»"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}}},"components":{"schemas":{"ActionInput":{"title":"ActionInput","type":"object","properties":{"actionName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"entityId":{"type":"integer","format":"int64"},"input":{"type":"object"},"orgId":{"type":"integer","format":"int64"},"processInstanceId":{"type":"string"},"version":{"type":"string"},"workFlowName":{"type":"string"}}},"AppTransactionStatusResponse":{"title":"AppTransactionStatusResponse","type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"processInstanceId":{"type":"string"},"pumpNumber":{"type":"string"},"stationId":{"type":"string"},"transactionState":{"type":"string","enum":["BILL_GENERATED","FUELING_CANCELLED_BY_CUSTOMER","FUELING_CANCELLED_BY_STATION","PUMP_ACTIVATION_FAIL","PUMP_ACTIVATION_SUCCESS","PUMP_RESERVE_FAIL","PUMP_RESERVE_SUCCESS","TXN_STATE_UNKNOWN"]}}},"ApplicableVoucher":{"title":"ApplicableVoucher","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"ApplicableVoucherReq":{"title":"ApplicableVoucherReq","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"string"}}},"ApplicableVoucherRes":{"title":"ApplicableVoucherRes","type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"Authorization":{"title":"Authorization","type":"object","properties":{"approvalCode":{"type":"string"},"batch":{"type":"string"},"couponCode":{"type":"string"},"coupons":{"type":"string"},"merchantName":{"type":"string"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"stan":{"type":"string"},"terminalID":{"type":"string"}}},"CancelRO":{"title":"CancelRO","type":"object","properties":{"mobilePaymentData":{"$ref":"#/components/schemas/MobilePaymentData"},"requestData":{"$ref":"#/components/schemas/RequestData"}}},"CancelRequest":{"title":"CancelRequest","type":"object","properties":{"processInstanceId":{"type":"string"}}},"CancelResponse":{"title":"CancelResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"CardRegisterROReq":{"title":"CardRegisterROReq","required":["currencyCode","customerInfo","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"CardRegisterRORes":{"title":"CardRegisterRORes","required":["currencyCode","customerInfo","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"CardValue":{"title":"CardValue","type":"object","properties":{"cardCircuit":{"type":"string"},"cardEntryMode":{"type":"string"},"cardID":{"type":"string"},"inString":{"type":"string"},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"string"},"trackers":{"type":"array","items":{"$ref":"#/components/schemas/Tracker"}}}},"CustomerData":{"title":"CustomerData","required":["customerDataType","customerDataValue"],"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerDataReq":{"title":"CustomerDataReq","type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerDataRes":{"title":"CustomerDataRes","required":["customerDataType","customerDataValue"],"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number","format":"bigdecimal"}}},"CustomerInfo":{"title":"CustomerInfo","required":["identifierName"],"type":"object","properties":{"accountId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"identifierName":{"type":"string","enum":["cardnumber","email","externalId","mobile","wechat"]},"identifierValue":{"type":"string"},"source":{"type":"string"}}},"GetEntityResponse":{"title":"GetEntityResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"workflowMeta":{"type":"array","items":{"$ref":"#/components/schemas/OrgWorkflowMetaDto"}}}},"LoyaltyDetails":{"title":"LoyaltyDetails","type":"object","properties":{"loyaltyPAN":{"type":"string"},"loyaltyType":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"trackers":{"type":"array","items":{"$ref":"#/components/schemas/Tracker"}}}},"LoyaltyOffer":{"title":"LoyaltyOffer","type":"object","properties":{"loyaltyOfferDescription":{"type":"string"},"loyaltyOfferID":{"type":"string"},"promotionType":{"type":"string","enum":["Cart","lineitem"]},"referenceID":{"type":"string"}}},"Message":{"title":"Message","type":"object","properties":{"cashierMessage":{"type":"string"}}},"MobilePaymentData":{"title":"MobilePaymentData","type":"object","properties":{"acquirerID":{"type":"string"},"globalRetailSiteID":{"type":"string"},"loyaltyDetails":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyDetails"}},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"merchantID":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"paymentData":{"type":"string"},"paymentServiceProvider":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"}}},"MobileResponseBody«CardRegisterRO»":{"title":"MobileResponseBody«CardRegisterRO»","type":"object","properties":{"data":{"$ref":"#/components/schemas/CardRegisterRORes"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«PreAuthorizeStep»":{"title":"MobileResponseBody«PreAuthorizeStep»","type":"object","properties":{"data":{"$ref":"#/components/schemas/PreAuthorizeStep"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«PumpReserve»":{"title":"MobileResponseBody«PumpReserve»","type":"object","properties":{"data":{"$ref":"#/components/schemas/PumpReserve"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"MobileResponseBody«TokenizeRO»":{"title":"MobileResponseBody«TokenizeRO»","type":"object","properties":{"data":{"$ref":"#/components/schemas/TokenizeRO"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"OfferEvaluation":{"title":"OfferEvaluation","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucher"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerData"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosData"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/Receipt"},"requestData":{"$ref":"#/components/schemas/RequestData"},"responseData":{"$ref":"#/components/schemas/ResponseData"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItem"}},"siteData":{"$ref":"#/components/schemas/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/Tender"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OfferEvaluationReq":{"title":"OfferEvaluationReq","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucherReq"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDataReq"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosDataReq"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/ReceiptReq"},"requestData":{"$ref":"#/components/schemas/RequestDataReq"},"responseData":{"$ref":"#/components/schemas/ResponseDataReq"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItemReq"}},"siteData":{"$ref":"#/components/schemas/SiteDataReq"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/TenderReq"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OfferEvaluationRes":{"title":"OfferEvaluationRes","required":["customerData","posData","requestData","saleItems","siteData","tenders","totalAmount"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucherRes"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDataRes"}},"messages":{"$ref":"#/components/schemas/Message"},"posData":{"$ref":"#/components/schemas/PosDataRes"},"predictedTender":{"$ref":"#/components/schemas/PredictedTender"},"receipt":{"$ref":"#/components/schemas/ReceiptRes"},"requestData":{"$ref":"#/components/schemas/RequestDataRes"},"responseData":{"$ref":"#/components/schemas/ResponseDataRes"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItemRes"}},"siteData":{"$ref":"#/components/schemas/SiteDataRes"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/TenderRes"}},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/components/schemas/VoucherCodesResult"}}}},"OrgWorkflowMetaDto":{"title":"OrgWorkflowMetaDto","type":"object","properties":{"autoUpdateTime":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"isApproved":{"type":"boolean"},"isAsync":{"type":"boolean"},"isDefault":{"type":"boolean"},"orgId":{"type":"integer","format":"int64"},"processId":{"type":"string"},"promotedOn":{"type":"string","format":"date-time"},"versionName":{"type":"string"},"workflowName":{"type":"string"}}},"OriginalTransaction":{"title":"OriginalTransaction","type":"object","properties":{"approvalCode":{"type":"string"},"authorizationToken":{"type":"string"},"stan":{"type":"string"},"terminalBatch":{"type":"string"},"terminalID":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}}},"PerformanceBo":{"title":"PerformanceBo","type":"object","properties":{"count":{"type":"integer","format":"int64"},"failurePercentage":{"type":"number","format":"bigdecimal"}}},"PosData":{"title":"PosData","required":["posTimeStamp"],"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}}},"PosDataReq":{"title":"PosDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"clerkID":{"type":"string"},"originalSalePosTimeStamp":{"type":"string"},"posTimeStamp":{"type":"string","format":"date-time"},"pumpNumber":{"type":"string"},"terminalID":{"type":"string"},"transactionNumber":{"type":"string"}}},"PosDataRes":{"title":"PosDataRes","required":["posTimeStamp"],"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}}},"PreAuthorizeStep":{"title":"PreAuthorizeStep","type":"object","properties":{"processInstanceId":{"type":"string"},"pspReferenceNumber":{"type":"string"}}},"PredictedTender":{"title":"PredictedTender","type":"object","properties":{"acquire":{"type":"string"},"methodOfPayment":{"type":"string"},"subtractDiscountAmount":{"type":"boolean"}}},"PriceAdjustment":{"title":"PriceAdjustment","type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"}}},"PriceAdjustmentReq":{"title":"PriceAdjustmentReq","required":["amount","loyaltyOfferID","reason","referenceID"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"netAmount":{"type":"number","format":"bigdecimal"},"originalAmount":{"type":"number","format":"bigdecimal"},"originalNetAmount":{"type":"number","format":"bigdecimal"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"productCode":{"type":"string"},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"taxSplit":{"type":"array","items":{"$ref":"#/components/schemas/TaxSplit"}},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vat":{"type":"number","format":"bigdecimal"}}},"PriceAdjustmentRes":{"title":"PriceAdjustmentRes","type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"}}},"ProcessInstanceDetails":{"title":"ProcessInstanceDetails","type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"tillId":{"type":"integer","format":"int64"},"version":{"type":"string"},"workflowName":{"type":"string"}}},"Product":{"title":"Product","type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"categoryCode":{"type":"string"},"productCode":{"type":"string"},"subCategoryCode":{"type":"string"}}},"PumpReserve":{"title":"PumpReserve","required":["currencyCode","customerInfo","methodOfPaymentId","paymentProviderName","preAuthAmount","siteId"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"languageCode":{"type":"string"},"loyaltyPan":{"type":"string"},"methodOfPaymentId":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"string"},"siteId":{"type":"string"}}},"Receipt":{"title":"Receipt","type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"ReceiptReq":{"title":"ReceiptReq","required":["receiptLines"],"type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"ReceiptRes":{"title":"ReceiptRes","type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}}},"RequestData":{"title":"RequestData","required":["requestID","requestType","workstationID"],"type":"object","properties":{"cartEvaluationID":{"type":"string"},"payTokenID":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"RequestDataReq":{"title":"RequestDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"countryCode":{"type":"string"},"extCorrelationId":{"type":"string"},"payTokenID":{"type":"string"},"paymentServiceProvider":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"transactionNumber":{"type":"string"},"workstationID":{"type":"string"}}},"RequestDataRes":{"title":"RequestDataRes","type":"object","properties":{"overallResult":{"type":"string"},"requestID":{"type":"string"}}},"ResponseData":{"title":"ResponseData","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"ResponseDataReq":{"title":"ResponseDataReq","type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}}},"ResponseDataRes":{"title":"ResponseDataRes","type":"object","properties":{"requestType":{"type":"string"}}},"SaleItem":{"title":"SaleItem","required":["additionalProductInfo","amount","originalAmount","quantity","saleItemType","unitMeasure","unitPrice"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustment"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleItemReq":{"title":"SaleItemReq","type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"lineNo":{"type":"string"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"netAmount":{"type":"number","format":"bigdecimal"},"originalAmount":{"type":"number","format":"bigdecimal"},"originalNetAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustmentReq"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"string"},"saleItemType":{"type":"string"},"taxAmount":{"type":"number","format":"bigdecimal"},"taxCode":{"type":"string"},"taxRate":{"type":"number","format":"bigdecimal"},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleItemRes":{"title":"SaleItemRes","required":["additionalProductInfo","amount","originalAmount","quantity","saleItemType","unitMeasure","unitPrice"],"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number","format":"bigdecimal"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number","format":"bigdecimal"},"priceAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/PriceAdjustmentRes"}},"productCode":{"type":"string"},"quantity":{"type":"number","format":"bigdecimal"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number","format":"bigdecimal"},"vatRate":{"type":"number","format":"bigdecimal"}}},"SaleTransaction":{"title":"SaleTransaction","required":["totalAmount"],"type":"object","properties":{"authorization":{"$ref":"#/components/schemas/Authorization"},"coupons":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"currencyCode":{"type":"string"},"extraDiscountAmount":{"type":"number","format":"double"},"loyaltyPointAmount":{"type":"integer","format":"int32"},"merchantName":{"type":"string"},"netAmount":{"type":"number","format":"double"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"taxReferenceNumber":{"type":"string"},"timeStamp":{"type":"string"},"totalAmount":{"type":"number","format":"double"},"totalDiscountAmount":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"transactionNumber":{"type":"string"}}},"ShellTransactionResponse":{"title":"ShellTransactionResponse","type":"object","properties":{"requestData":{"$ref":"#/components/schemas/RequestDataRes"},"responseData":{"$ref":"#/components/schemas/ResponseDataRes"}}},"SingleResponse«List«UserTransactionBo»»":{"title":"SingleResponse«List«UserTransactionBo»»","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserTransactionBo"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«OfferEvaluation»":{"title":"SingleResponse«OfferEvaluation»","type":"object","properties":{"data":{"$ref":"#/components/schemas/OfferEvaluationRes"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«TxnStatusBo»":{"title":"SingleResponse«TxnStatusBo»","type":"object","properties":{"data":{"$ref":"#/components/schemas/TxnStatusBo"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SingleResponse«WorkFlowCreationResponse»":{"title":"SingleResponse«WorkFlowCreationResponse»","type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkFlowCreationResponse"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"SiteData":{"title":"SiteData","required":["countryCode","siteID"],"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}}},"SiteDataReq":{"title":"SiteDataReq","type":"object","properties":{"countryCode":{"type":"string"},"siteId":{"type":"string"}}},"SiteDataRes":{"title":"SiteDataRes","required":["countryCode","siteID"],"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}}},"StatResponse«Map«string,PerformanceBo»»":{"title":"StatResponse«Map«string,PerformanceBo»»","type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PerformanceBo"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"StatusCode":{"title":"StatusCode","type":"object","properties":{"code":{"type":"integer","format":"int32"},"isWarning":{"type":"boolean"},"message":{"type":"string"}}},"TaxSplit":{"title":"TaxSplit","type":"object","properties":{"additionalAmount":{"type":"number","format":"bigdecimal"},"amount":{"type":"number","format":"bigdecimal"},"code":{"type":"string"},"rate":{"type":"number","format":"bigdecimal"},"taxID":{"type":"integer","format":"int32"}}},"Tender":{"title":"Tender","required":["acquirerID"],"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number","format":"bigdecimal"},"pointsRedeemed":{"type":"number","format":"bigdecimal"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRule"}}}},"TenderReq":{"title":"TenderReq","type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"string"},"netTenderAmount":{"type":"string"},"pointsRedeemed":{"type":"string"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"string"},"totalAmount":{"type":"string"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRuleReq"}}}},"TenderRes":{"title":"TenderRes","required":["acquirerID"],"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number","format":"bigdecimal"},"pointsRedeemed":{"type":"number","format":"bigdecimal"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number","format":"bigdecimal"},"voucherRules":{"type":"array","items":{"$ref":"#/components/schemas/VoucherRuleRes"}}}},"Terminal":{"title":"Terminal","type":"object","properties":{"stan":{"type":"string"},"terminalBatch":{"type":"string"}}},"TokenizeRO":{"title":"TokenizeRO","required":["currencyCode","customerInfo","loyaltyPan","paymentProviderName","registrationAmount"],"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}}},"Tracker":{"title":"Tracker","type":"object","properties":{"trackerEarned":{"type":"string"},"trackerRedeemed":{"type":"string"},"trackerType":{"type":"string"},"trackerValue":{"type":"string"}}},"TransactionAddRO":{"title":"TransactionAddRO","required":["cardValues","receipt","requestData","saleItems","saleTransaction"],"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/components/schemas/ApplicableVoucher"}},"cardValues":{"type":"array","items":{"$ref":"#/components/schemas/CardValue"}},"customerData":{"type":"array","items":{"$ref":"#/components/schemas/CustomerData"}},"mobilePaymentData":{"$ref":"#/components/schemas/MobilePaymentData"},"originalTransaction":{"$ref":"#/components/schemas/OriginalTransaction"},"posData":{"$ref":"#/components/schemas/PosData"},"receipt":{"$ref":"#/components/schemas/Receipt"},"requestData":{"$ref":"#/components/schemas/RequestData"},"saleItems":{"type":"array","items":{"$ref":"#/components/schemas/SaleItem"}},"saleTransaction":{"$ref":"#/components/schemas/SaleTransaction"},"siteData":{"$ref":"#/components/schemas/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/components/schemas/Tender"}},"terminal":{"$ref":"#/components/schemas/Terminal"},"totalAmount":{"type":"number","format":"bigdecimal"}}},"TransactionAddResponse":{"title":"TransactionAddResponse","type":"object","properties":{"shellResponse":{"type":"array","items":{"$ref":"#/components/schemas/ShellTransactionResponse"}}}},"TxnStatusBo":{"title":"TxnStatusBo","type":"object","properties":{"currencyCode":{"type":"string"},"extCorrelationId":{"type":"string"},"finalStatus":{"type":"string"},"instanceVariables":{"type":"object"},"languageCode":{"type":"string"},"methodOfPaymentId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"status":{"type":"string"},"stepRequests":{"type":"object"},"workFlowDetails":{"$ref":"#/components/schemas/ProcessInstanceDetails"}}},"UpdatedEntityResponse":{"title":"UpdatedEntityResponse","type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/StatusCode"}}}},"UserTransactionBo":{"title":"UserTransactionBo","type":"object","properties":{"extCorrelationId":{"type":"string"},"id":{"type":"integer","format":"int64"},"invoice":{"type":"string"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpId":{"type":"string"},"siteId":{"type":"string"},"startTimestamp":{"type":"string","format":"date-time"},"status":{"type":"string"},"type":{"type":"string"}}},"Violation":{"title":"Violation","type":"object","properties":{"fieldName":{"type":"string"},"invalidValue":{"type":"object"},"message":{"type":"string"}}},"VoucherCodesResult":{"title":"VoucherCodesResult","type":"object","properties":{"actionCode":{"type":"integer","format":"int32"},"actionCodeDescription":{"type":"string"},"voucherCode":{"type":"string"}}},"VoucherRule":{"title":"VoucherRule","required":["voucherCode"],"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"VoucherRuleReq":{"title":"VoucherRuleReq","type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"referenceId":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"VoucherRuleRes":{"title":"VoucherRuleRes","required":["voucherCode"],"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number","format":"bigdecimal"}}},"WorkFlowCreationResponse":{"title":"WorkFlowCreationResponse","type":"object","properties":{"deploymentId":{"type":"string"},"version":{"type":"string"}}},"WorkFlowPromote":{"title":"WorkFlowPromote","type":"object","properties":{"version":{"type":"string"},"workFlowName":{"type":"string"}}},"WorkflowInputAction":{"title":"WorkflowInputAction","required":["httpCallInputProperties"],"type":"object","properties":{"actionGroupType":{"type":"string","enum":["PARALLEL","SERIAL","XOR"]},"delayTimeInRetrial":{"type":"integer","format":"int32"},"httpCallInputProperties":{"$ref":"#/components/schemas/ActionInput"},"httpCallInputPropertiesRollback":{"$ref":"#/components/schemas/ActionInput"},"isAsync":{"type":"boolean"},"name":{"type":"string"},"properties":{"type":"object"},"retrialCount":{"type":"integer","format":"int32"},"rollBackProperties":{"type":"object"},"serialNumber":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["CCCaptureAction","addTransactionAction","authorizePaymentWithPsp","confirmAuthWithPSPAction","eghlCapturePaymentAction","eghlTokenizationAction","emptyAction","generatePaymentIdAction","ifredeemPointsAction","invalid","oAuthHttpAction","offerEvaluationAction","redeemPointsAction","saveCCardAction"]}}},"WorkflowProcess":{"title":"WorkflowProcess","type":"object","properties":{"isAsync":{"type":"boolean"},"name":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}}},"WorkflowStep":{"title":"WorkflowStep","type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowInputAction"}},"maxWaitTimeInMillis":{"type":"integer","format":"int32"},"name":{"type":"string"},"serialNumber":{"type":"integer","format":"int32"}}},"_2c2pCallbackRequest":{"title":"_2c2pCallbackRequest","type":"object","properties":{"payload":{"type":"string"}}}},"securitySchemes":{"X-CAP-API-AUTH-ORG-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ORG-ID","in":"header"},"X-CAP-API-AUTH-ENTITY-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ENTITY-ID","in":"header"},"X-CAP-ENTITY-CODE":{"type":"apiKey","name":"X-CAP-ENTITY-CODE","in":"header"},"X-CAP-ENTITY-ID":{"type":"apiKey","name":"X-CAP-ENTITY-ID","in":"header"}}}} +{ + "swagger": "2.0", + "info": { + "description": "Potato OTA Transaction Orchestrator", + "version": "1.0", + "title": "POTATO", + "contact": { + "name": "Capillary Technologies", + "url": "https://www.capillarytech.com" + }, + "license": {} + }, + "host": "localhost:8100", + "basePath": "/", + "tags": [ + { + "name": "_2c-2p-callback-resource", + "description": "_2c 2p Callback Resource" + }, + { + "name": "admin-workflow-resource", + "description": "Admin Workflow Resource" + }, + { + "name": "cancel-sandbox", + "description": "Cancel Sandbox" + }, + { + "name": "eghl-call-back-resource", + "description": "Eghl Call Back Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "mobile-card-registration-resource", + "description": "Mobile Card Registration Resource" + }, + { + "name": "payments-resource", + "description": "Payments Resource" + }, + { + "name": "psp-callback-resource", + "description": "Psp Callback Resource" + }, + { + "name": "psp-performance-resource", + "description": "Psp Performance Resource" + }, + { + "name": "psp-reconciliation", + "description": "PSP Reconciliation" + }, + { + "name": "pump-life-cycle-resource", + "description": "Pump Life Cycle Resource" + }, + { + "name": "pump-performance-resource", + "description": "Pump Performance Resource" + }, + { + "name": "shell-server-to-server-resource", + "description": "Shell Server To Server Resource" + }, + { + "name": "test-fuelling-workflow-resource", + "description": "Test Fuelling Workflow Resource" + }, + { + "name": "transaction-status-resource", + "description": "Transaction Status Resource" + }, + { + "name": "txn-status-resource", + "description": "Txn Status Resource" + } + ], + "paths": { + "/orchestrator/payments/app/pumpReserve/{version}": { + "post": { + "tags": [ + "test-fuelling-workflow-resource" + ], + "summary": "pumpReserveWithGivenVersion", + "operationId": "pumpReserveWithGivenVersionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "pumpReserve", + "description": "pumpReserve", + "required": true, + "schema": { + "$ref": "#/definitions/PumpReserve" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PumpReserve»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/register-paymentIdV1": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "registerPaymentId", + "operationId": "registerPaymentIdUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cardRegisterRO", + "description": "cardRegisterRO", + "required": true, + "schema": { + "$ref": "#/definitions/CardRegisterROReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«CardRegisterRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/failure-rate/bank": { + "get": { + "tags": [ + "psp-performance-resource" + ], + "summary": "pspStat", + "operationId": "pspStatUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "bankName", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "durationHours", + "in": "query", + "required": false, + "type": "integer", + "maximum": 12, + "exclusiveMaximum": false, + "format": "int32" + }, + { + "name": "psp", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/failure-rate/pump": { + "get": { + "tags": [ + "pump-performance-resource" + ], + "summary": "pumpStat", + "operationId": "pumpStatUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "durationHours", + "in": "query", + "required": false, + "type": "integer", + "maximum": 12, + "exclusiveMaximum": false, + "format": "int32" + }, + { + "name": "siteId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/fuelling-status": { + "get": { + "tags": [ + "transaction-status-resource" + ], + "summary": "status", + "operationId": "statusUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppTransactionStatusResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-activate": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "activatePump", + "operationId": "activatePumpUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "preAuthorizeRequest", + "description": "preAuthorizeRequest", + "required": true, + "schema": { + "$ref": "#/definitions/PreAuthorizeStep" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PreAuthorizeStep»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-cancel": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "cancelPump", + "operationId": "cancelPumpUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cancelRequest", + "description": "cancelRequest", + "required": true, + "schema": { + "$ref": "#/definitions/CancelRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CancelResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-reserve": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "pumpReserve", + "operationId": "pumpReserveUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "pumpReserve", + "description": "pumpReserve", + "required": true, + "schema": { + "$ref": "#/definitions/PumpReserve" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PumpReserve»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/register-paymentId": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "generatePaymentIdentifier", + "operationId": "generatePaymentIdentifierUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "getStatusByPaymentId", + "operationId": "getStatusByPaymentIdUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "paymentId", + "in": "path", + "description": "paymentId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«TxnStatusBo»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/intouch/txn-status/user-id/{userId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "OTATransactionsByUserId", + "operationId": "OTATransactionsByUserIdUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "userId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«List«UserTransactionBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/cancel": { + "post": { + "tags": [ + "cancel-sandbox" + ], + "summary": "cancel", + "operationId": "cancelUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cancelRO", + "description": "cancelRO", + "required": true, + "schema": { + "$ref": "#/definitions/CancelRO" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/finalize-txn": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "finalizeTransaction", + "operationId": "finalizeTransactionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "transactionAddRO", + "description": "transactionAddRO", + "required": true, + "schema": { + "$ref": "#/definitions/TransactionAddRO" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/get-offers": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "offerEvaluation", + "operationId": "offerEvaluationUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "offerEvaluationReq", + "description": "offerEvaluationReq", + "required": true, + "schema": { + "$ref": "#/definitions/OfferEvaluation" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferEvaluation" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/2c2p/fuelling-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "fuellingCallBack", + "operationId": "fuellingCallBackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callbackRequest", + "description": "callbackRequest", + "required": true, + "schema": { + "$ref": "#/definitions/_2c2pCallbackRequest" + } + }, + { + "name": "defaultCard", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "orgId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "userId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/2c2p/register-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "registerCallBack", + "operationId": "registerCallBackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callbackRequest", + "description": "callbackRequest", + "required": true, + "schema": { + "$ref": "#/definitions/_2c2pCallbackRequest" + } + }, + { + "name": "defaultCard", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "orgId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "userId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/callback": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "saveToken", + "operationId": "saveTokenUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "processData", + "description": "processData", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "shouldSave", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/payment-identifier": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/transaction": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "callback", + "operationId": "callbackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callBackData", + "description": "callBackData", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/ping": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "application health check", + "operationId": "healthCheckUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/reconciliation/capture": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationCapture", + "operationId": "reconciliationCaptureUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/reconciliation/registration-reversal": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationRegistrationReversal", + "operationId": "reconciliationRegistrationReversalUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow": { + "get": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "get", + "operationId": "getUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "allVersions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetEntityResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + }, + "post": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "create", + "operationId": "createUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "workflowProcess", + "description": "workflowProcess", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowProcess" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«WorkFlowCreationResponse»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/promotion": { + "put": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "promoteWorkFlow", + "operationId": "promoteWorkFlowUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "workFlowPromote", + "description": "workFlowPromote", + "required": true, + "schema": { + "$ref": "#/definitions/WorkFlowPromote" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdatedEntityResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/psp/payment-identifier": { + "post": { + "tags": [ + "psp-callback-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST_1", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/shell/billing/evaluateOffer": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "evaluateOffers", + "operationId": "evaluateOffersUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "completeRequest", + "description": "completeRequest", + "required": true, + "schema": { + "$ref": "#/definitions/OfferEvaluationReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«OfferEvaluation»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/shell/billing/transactionAdd": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "txnAdd", + "operationId": "txnAddUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "transactionAddRO", + "description": "transactionAddRO", + "required": true, + "schema": { + "$ref": "#/definitions/TransactionAddRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransactionAddResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + } + }, + "securityDefinitions": { + "X-CAP-API-AUTH-ENTITY-ID": { + "type": "apiKey", + "name": "X-CAP-API-AUTH-ENTITY-ID", + "in": "header" + }, + "X-CAP-API-AUTH-ORG-ID": { + "type": "apiKey", + "name": "X-CAP-API-AUTH-ORG-ID", + "in": "header" + }, + "X-CAP-ENTITY-CODE": { + "type": "apiKey", + "name": "X-CAP-ENTITY-CODE", + "in": "header" + }, + "X-CAP-ENTITY-ID": { + "type": "apiKey", + "name": "X-CAP-ENTITY-ID", + "in": "header" + } + }, + "definitions": { + "ActionInput": { + "type": "object", + "properties": { + "actionName": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "entityId": { + "type": "integer", + "format": "int64" + }, + "input": { + "type": "object" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processInstanceId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + }, + "title": "ActionInput" + }, + "AppTransactionStatusResponse": { + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "stationId": { + "type": "string" + }, + "transactionState": { + "type": "string", + "enum": [ + "BILL_GENERATED", + "FUELING_CANCELLED_BY_CUSTOMER", + "FUELING_CANCELLED_BY_STATION", + "PUMP_ACTIVATION_FAIL", + "PUMP_ACTIVATION_SUCCESS", + "PUMP_RESERVE_FAIL", + "PUMP_RESERVE_SUCCESS", + "TXN_STATE_UNKNOWN" + ] + } + }, + "title": "AppTransactionStatusResponse" + }, + "ApplicableVoucher": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "ApplicableVoucher" + }, + "ApplicableVoucherReq": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "string" + } + }, + "title": "ApplicableVoucherReq" + }, + "ApplicableVoucherRes": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "ApplicableVoucherRes" + }, + "Authorization": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "batch": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "coupons": { + "type": "string" + }, + "merchantName": { + "type": "string" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalID": { + "type": "string" + } + }, + "title": "Authorization" + }, + "CancelRO": { + "type": "object", + "properties": { + "mobilePaymentData": { + "$ref": "#/definitions/MobilePaymentData" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + } + }, + "title": "CancelRO" + }, + "CancelRequest": { + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + } + }, + "title": "CancelRequest" + }, + "CancelResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "CancelResponse" + }, + "CardRegisterROReq": { + "type": "object", + "required": [ + "currencyCode", + "customerInfo", + "paymentProviderName", + "registrationAmount" + ], + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "CardRegisterROReq" + }, + "CardRegisterRORes": { + "type": "object", + "required": [ + "currencyCode", + "customerInfo", + "paymentProviderName", + "registrationAmount" + ], + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "CardRegisterRORes" + }, + "CardValue": { + "type": "object", + "properties": { + "cardCircuit": { + "type": "string" + }, + "cardEntryMode": { + "type": "string" + }, + "cardID": { + "type": "string" + }, + "inString": { + "type": "string" + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "string" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tracker" + } + } + }, + "title": "CardValue" + }, + "CustomerData": { + "type": "object", + "required": [ + "customerDataType", + "customerDataValue" + ], + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number" + } + }, + "title": "CustomerData" + }, + "CustomerDataReq": { + "type": "object", + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number" + } + }, + "title": "CustomerDataReq" + }, + "CustomerDataRes": { + "type": "object", + "required": [ + "customerDataType", + "customerDataValue" + ], + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number" + } + }, + "title": "CustomerDataRes" + }, + "CustomerInfo": { + "type": "object", + "required": [ + "identifierName" + ], + "properties": { + "accountId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "identifierName": { + "type": "string", + "enum": [ + "cardnumber", + "email", + "externalId", + "mobile", + "wechat" + ] + }, + "identifierValue": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "title": "CustomerInfo" + }, + "GetEntityResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "workflowMeta": { + "type": "array", + "items": { + "$ref": "#/definitions/OrgWorkflowMetaDto" + } + } + }, + "title": "GetEntityResponse" + }, + "LoyaltyDetails": { + "type": "object", + "properties": { + "loyaltyPAN": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tracker" + } + } + }, + "title": "LoyaltyDetails" + }, + "LoyaltyOffer": { + "type": "object", + "properties": { + "loyaltyOfferDescription": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "Cart", + "lineitem" + ] + }, + "referenceID": { + "type": "string" + } + }, + "title": "LoyaltyOffer" + }, + "Message": { + "type": "object", + "properties": { + "cashierMessage": { + "type": "string" + } + }, + "title": "Message" + }, + "MobilePaymentData": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "globalRetailSiteID": { + "type": "string" + }, + "loyaltyDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyDetails" + } + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "merchantID": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "paymentData": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + } + }, + "title": "MobilePaymentData" + }, + "MobileResponseBody«CardRegisterRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CardRegisterRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«CardRegisterRO»" + }, + "MobileResponseBody«PreAuthorizeStep»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PreAuthorizeStep" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«PreAuthorizeStep»" + }, + "MobileResponseBody«PumpReserve»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PumpReserve" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«PumpReserve»" + }, + "MobileResponseBody«TokenizeRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/TokenizeRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«TokenizeRO»" + }, + "OfferEvaluation": { + "type": "object", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucher" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosData" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + }, + "responseData": { + "$ref": "#/definitions/ResponseData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItem" + } + }, + "siteData": { + "$ref": "#/definitions/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/Tender" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluation" + }, + "OfferEvaluationReq": { + "type": "object", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucherReq" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerDataReq" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosDataReq" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/ReceiptReq" + }, + "requestData": { + "$ref": "#/definitions/RequestDataReq" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataReq" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItemReq" + } + }, + "siteData": { + "$ref": "#/definitions/SiteDataReq" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/TenderReq" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluationReq" + }, + "OfferEvaluationRes": { + "type": "object", + "required": [ + "customerData", + "posData", + "requestData", + "saleItems", + "siteData", + "tenders", + "totalAmount" + ], + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucherRes" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerDataRes" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosDataRes" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/ReceiptRes" + }, + "requestData": { + "$ref": "#/definitions/RequestDataRes" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataRes" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItemRes" + } + }, + "siteData": { + "$ref": "#/definitions/SiteDataRes" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/TenderRes" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluationRes" + }, + "OrgWorkflowMetaDto": { + "type": "object", + "properties": { + "autoUpdateTime": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "isApproved": { + "type": "boolean" + }, + "isAsync": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processId": { + "type": "string" + }, + "promotedOn": { + "type": "string", + "format": "date-time" + }, + "versionName": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "title": "OrgWorkflowMetaDto" + }, + "OriginalTransaction": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "authorizationToken": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "timeStamp": { + "type": "string", + "format": "date-time" + } + }, + "title": "OriginalTransaction" + }, + "PerformanceBo": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int64" + }, + "failurePercentage": { + "type": "number" + } + }, + "title": "PerformanceBo" + }, + "PosData": { + "type": "object", + "required": [ + "posTimeStamp" + ], + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosData" + }, + "PosDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "clerkID": { + "type": "string" + }, + "originalSalePosTimeStamp": { + "type": "string" + }, + "posTimeStamp": { + "type": "string", + "format": "date-time" + }, + "pumpNumber": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosDataReq" + }, + "PosDataRes": { + "type": "object", + "required": [ + "posTimeStamp" + ], + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosDataRes" + }, + "PreAuthorizeStep": { + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + }, + "pspReferenceNumber": { + "type": "string" + } + }, + "title": "PreAuthorizeStep" + }, + "PredictedTender": { + "type": "object", + "properties": { + "acquire": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "subtractDiscountAmount": { + "type": "boolean" + } + }, + "title": "PredictedTender" + }, + "PriceAdjustment": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number" + } + }, + "title": "PriceAdjustment" + }, + "PriceAdjustmentReq": { + "type": "object", + "required": [ + "amount", + "loyaltyOfferID", + "reason", + "referenceID" + ], + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "netAmount": { + "type": "number" + }, + "originalAmount": { + "type": "number" + }, + "originalNetAmount": { + "type": "number" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "productCode": { + "type": "string" + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "taxSplit": { + "type": "array", + "items": { + "$ref": "#/definitions/TaxSplit" + } + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vat": { + "type": "number" + } + }, + "title": "PriceAdjustmentReq" + }, + "PriceAdjustmentRes": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number" + } + }, + "title": "PriceAdjustmentRes" + }, + "ProcessInstanceDetails": { + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "tillId": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "title": "ProcessInstanceDetails" + }, + "Product": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "categoryCode": { + "type": "string" + }, + "productCode": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + } + }, + "title": "Product" + }, + "PumpReserve": { + "type": "object", + "required": [ + "currencyCode", + "customerInfo", + "methodOfPaymentId", + "paymentProviderName", + "preAuthAmount", + "siteId" + ], + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "languageCode": { + "type": "string" + }, + "loyaltyPan": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "siteId": { + "type": "string" + } + }, + "title": "PumpReserve" + }, + "Receipt": { + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "Receipt" + }, + "ReceiptReq": { + "type": "object", + "required": [ + "receiptLines" + ], + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "ReceiptReq" + }, + "ReceiptRes": { + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "ReceiptRes" + }, + "RequestData": { + "type": "object", + "required": [ + "requestID", + "requestType", + "workstationID" + ], + "properties": { + "cartEvaluationID": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "RequestData" + }, + "RequestDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "countryCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "RequestDataReq" + }, + "RequestDataRes": { + "type": "object", + "properties": { + "overallResult": { + "type": "string" + }, + "requestID": { + "type": "string" + } + }, + "title": "RequestDataRes" + }, + "ResponseData": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "ResponseData" + }, + "ResponseDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "ResponseDataReq" + }, + "ResponseDataRes": { + "type": "object", + "properties": { + "requestType": { + "type": "string" + } + }, + "title": "ResponseDataRes" + }, + "SaleItem": { + "type": "object", + "required": [ + "additionalProductInfo", + "amount", + "originalAmount", + "quantity", + "saleItemType", + "unitMeasure", + "unitPrice" + ], + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustment" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItem" + }, + "SaleItemReq": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "lineNo": { + "type": "string" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "netAmount": { + "type": "number" + }, + "originalAmount": { + "type": "number" + }, + "originalNetAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustmentReq" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "string" + }, + "saleItemType": { + "type": "string" + }, + "taxAmount": { + "type": "number" + }, + "taxCode": { + "type": "string" + }, + "taxRate": { + "type": "number" + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItemReq" + }, + "SaleItemRes": { + "type": "object", + "required": [ + "additionalProductInfo", + "amount", + "originalAmount", + "quantity", + "saleItemType", + "unitMeasure", + "unitPrice" + ], + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustmentRes" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItemRes" + }, + "SaleTransaction": { + "type": "object", + "required": [ + "totalAmount" + ], + "properties": { + "authorization": { + "$ref": "#/definitions/Authorization" + }, + "coupons": { + "type": "array", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string" + }, + "currencyCode": { + "type": "string" + }, + "extraDiscountAmount": { + "type": "number", + "format": "double" + }, + "loyaltyPointAmount": { + "type": "integer", + "format": "int32" + }, + "merchantName": { + "type": "string" + }, + "netAmount": { + "type": "number", + "format": "double" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "taxReferenceNumber": { + "type": "string" + }, + "timeStamp": { + "type": "string" + }, + "totalAmount": { + "type": "number", + "format": "double" + }, + "totalDiscountAmount": { + "type": "number", + "format": "double" + }, + "totalTaxAmount": { + "type": "number", + "format": "double" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "SaleTransaction" + }, + "ShellTransactionResponse": { + "type": "object", + "properties": { + "requestData": { + "$ref": "#/definitions/RequestDataRes" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataRes" + } + }, + "title": "ShellTransactionResponse" + }, + "SingleResponse«List«UserTransactionBo»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/UserTransactionBo" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«List«UserTransactionBo»»" + }, + "SingleResponse«OfferEvaluation»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/OfferEvaluationRes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«OfferEvaluation»" + }, + "SingleResponse«TxnStatusBo»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/TxnStatusBo" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«TxnStatusBo»" + }, + "SingleResponse«WorkFlowCreationResponse»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/WorkFlowCreationResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«WorkFlowCreationResponse»" + }, + "SiteData": { + "type": "object", + "required": [ + "countryCode", + "siteID" + ], + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + }, + "title": "SiteData" + }, + "SiteDataReq": { + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteId": { + "type": "string" + } + }, + "title": "SiteDataReq" + }, + "SiteDataRes": { + "type": "object", + "required": [ + "countryCode", + "siteID" + ], + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + }, + "title": "SiteDataRes" + }, + "StatResponse«Map«string,PerformanceBo»»": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PerformanceBo" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "StatResponse«Map«string,PerformanceBo»»" + }, + "StatusCode": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "isWarning": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "title": "StatusCode" + }, + "TaxSplit": { + "type": "object", + "properties": { + "additionalAmount": { + "type": "number" + }, + "amount": { + "type": "number" + }, + "code": { + "type": "string" + }, + "rate": { + "type": "number" + }, + "taxID": { + "type": "integer", + "format": "int32" + } + }, + "title": "TaxSplit" + }, + "Tender": { + "type": "object", + "required": [ + "acquirerID" + ], + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number" + }, + "pointsRedeemed": { + "type": "number" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRule" + } + } + }, + "title": "Tender" + }, + "TenderReq": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "netTenderAmount": { + "type": "string" + }, + "pointsRedeemed": { + "type": "string" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "string" + }, + "totalAmount": { + "type": "string" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRuleReq" + } + } + }, + "title": "TenderReq" + }, + "TenderRes": { + "type": "object", + "required": [ + "acquirerID" + ], + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number" + }, + "pointsRedeemed": { + "type": "number" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRuleRes" + } + } + }, + "title": "TenderRes" + }, + "Terminal": { + "type": "object", + "properties": { + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + } + }, + "title": "Terminal" + }, + "TokenizeRO": { + "type": "object", + "required": [ + "currencyCode", + "customerInfo", + "loyaltyPan", + "paymentProviderName", + "registrationAmount" + ], + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "TokenizeRO" + }, + "Tracker": { + "type": "object", + "properties": { + "trackerEarned": { + "type": "string" + }, + "trackerRedeemed": { + "type": "string" + }, + "trackerType": { + "type": "string" + }, + "trackerValue": { + "type": "string" + } + }, + "title": "Tracker" + }, + "TransactionAddRO": { + "type": "object", + "required": [ + "cardValues", + "receipt", + "requestData", + "saleItems", + "saleTransaction" + ], + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucher" + } + }, + "cardValues": { + "type": "array", + "items": { + "$ref": "#/definitions/CardValue" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "mobilePaymentData": { + "$ref": "#/definitions/MobilePaymentData" + }, + "originalTransaction": { + "$ref": "#/definitions/OriginalTransaction" + }, + "posData": { + "$ref": "#/definitions/PosData" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItem" + } + }, + "saleTransaction": { + "$ref": "#/definitions/SaleTransaction" + }, + "siteData": { + "$ref": "#/definitions/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/Tender" + } + }, + "terminal": { + "$ref": "#/definitions/Terminal" + }, + "totalAmount": { + "type": "number" + } + }, + "title": "TransactionAddRO" + }, + "TransactionAddResponse": { + "type": "object", + "properties": { + "shellResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/ShellTransactionResponse" + } + } + }, + "title": "TransactionAddResponse" + }, + "TxnStatusBo": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "finalStatus": { + "type": "string" + }, + "instanceVariables": { + "type": "object" + }, + "languageCode": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "siteId": { + "type": "string" + }, + "status": { + "type": "string" + }, + "stepRequests": { + "type": "object" + }, + "workFlowDetails": { + "$ref": "#/definitions/ProcessInstanceDetails" + } + }, + "title": "TxnStatusBo" + }, + "UpdatedEntityResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "UpdatedEntityResponse" + }, + "UserTransactionBo": { + "type": "object", + "properties": { + "extCorrelationId": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "invoice": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpId": { + "type": "string" + }, + "siteId": { + "type": "string" + }, + "startTimestamp": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "title": "UserTransactionBo" + }, + "Violation": { + "type": "object", + "properties": { + "fieldName": { + "type": "string" + }, + "invalidValue": { + "type": "object" + }, + "message": { + "type": "string" + } + }, + "title": "Violation" + }, + "VoucherCodesResult": { + "type": "object", + "properties": { + "actionCode": { + "type": "integer", + "format": "int32" + }, + "actionCodeDescription": { + "type": "string" + }, + "voucherCode": { + "type": "string" + } + }, + "title": "VoucherCodesResult" + }, + "VoucherRule": { + "type": "object", + "required": [ + "voucherCode" + ], + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRule" + }, + "VoucherRuleReq": { + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "referenceId": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRuleReq" + }, + "VoucherRuleRes": { + "type": "object", + "required": [ + "voucherCode" + ], + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRuleRes" + }, + "WorkFlowCreationResponse": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "WorkFlowCreationResponse" + }, + "WorkFlowPromote": { + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + }, + "title": "WorkFlowPromote" + }, + "WorkflowInputAction": { + "type": "object", + "required": [ + "httpCallInputProperties" + ], + "properties": { + "actionGroupType": { + "type": "string", + "enum": [ + "PARALLEL", + "SERIAL", + "XOR" + ] + }, + "delayTimeInRetrial": { + "type": "integer", + "format": "int32" + }, + "httpCallInputProperties": { + "$ref": "#/definitions/ActionInput" + }, + "httpCallInputPropertiesRollback": { + "$ref": "#/definitions/ActionInput" + }, + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "properties": { + "type": "object" + }, + "retrialCount": { + "type": "integer", + "format": "int32" + }, + "rollBackProperties": { + "type": "object" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "CCCaptureAction", + "addTransactionAction", + "authorizePaymentWithPsp", + "confirmAuthWithPSPAction", + "eghlCapturePaymentAction", + "eghlTokenizationAction", + "emptyAction", + "generatePaymentIdAction", + "ifredeemPointsAction", + "invalid", + "oAuthHttpAction", + "offerEvaluationAction", + "redeemPointsAction", + "saveCCardAction" + ] + } + }, + "title": "WorkflowInputAction" + }, + "WorkflowProcess": { + "type": "object", + "properties": { + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowStep" + } + } + }, + "title": "WorkflowProcess" + }, + "WorkflowStep": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowInputAction" + } + }, + "maxWaitTimeInMillis": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + } + }, + "title": "WorkflowStep" + }, + "_2c2pCallbackRequest": { + "type": "object", + "properties": { + "payload": { + "type": "string" + } + }, + "title": "_2c2pCallbackRequest" + } + } +} From dca12cf6696796efd7e902c60c858fa955a8304b Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Tue, 7 Jun 2022 19:44:56 +0530 Subject: [PATCH 140/150] Update orchestrator.json --- orchestrator.json | 4781 +-------------------------------------------- 1 file changed, 1 insertion(+), 4780 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index b7058a4050c..36d577f3f76 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -1,4780 +1 @@ -{ - "swagger": "2.0", - "info": { - "description": "Potato OTA Transaction Orchestrator", - "version": "1.0", - "title": "POTATO", - "contact": { - "name": "Capillary Technologies", - "url": "https://www.capillarytech.com" - }, - "license": {} - }, - "host": "localhost:8100", - "basePath": "/", - "tags": [ - { - "name": "_2c-2p-callback-resource", - "description": "_2c 2p Callback Resource" - }, - { - "name": "admin-workflow-resource", - "description": "Admin Workflow Resource" - }, - { - "name": "cancel-sandbox", - "description": "Cancel Sandbox" - }, - { - "name": "eghl-call-back-resource", - "description": "Eghl Call Back Resource" - }, - { - "name": "health-check-resource", - "description": "Health Check Resource" - }, - { - "name": "mobile-card-registration-resource", - "description": "Mobile Card Registration Resource" - }, - { - "name": "payments-resource", - "description": "Payments Resource" - }, - { - "name": "psp-callback-resource", - "description": "Psp Callback Resource" - }, - { - "name": "psp-performance-resource", - "description": "Psp Performance Resource" - }, - { - "name": "psp-reconciliation", - "description": "PSP Reconciliation" - }, - { - "name": "pump-life-cycle-resource", - "description": "Pump Life Cycle Resource" - }, - { - "name": "pump-performance-resource", - "description": "Pump Performance Resource" - }, - { - "name": "shell-server-to-server-resource", - "description": "Shell Server To Server Resource" - }, - { - "name": "test-fuelling-workflow-resource", - "description": "Test Fuelling Workflow Resource" - }, - { - "name": "transaction-status-resource", - "description": "Transaction Status Resource" - }, - { - "name": "txn-status-resource", - "description": "Txn Status Resource" - } - ], - "paths": { - "/orchestrator/payments/app/pumpReserve/{version}": { - "post": { - "tags": [ - "test-fuelling-workflow-resource" - ], - "summary": "pumpReserveWithGivenVersion", - "operationId": "pumpReserveWithGivenVersionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "pumpReserve", - "description": "pumpReserve", - "required": true, - "schema": { - "$ref": "#/definitions/PumpReserve" - } - }, - { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«PumpReserve»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/register-paymentIdV1": { - "post": { - "tags": [ - "mobile-card-registration-resource" - ], - "summary": "registerPaymentId", - "operationId": "registerPaymentIdUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "cardRegisterRO", - "description": "cardRegisterRO", - "required": true, - "schema": { - "$ref": "#/definitions/CardRegisterROReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«CardRegisterRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/failure-rate/bank": { - "get": { - "tags": [ - "psp-performance-resource" - ], - "summary": "pspStat", - "operationId": "pspStatUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "bankName", - "in": "query", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "durationHours", - "in": "query", - "required": false, - "type": "integer", - "maximum": 12, - "exclusiveMaximum": false, - "format": "int32" - }, - { - "name": "psp", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/failure-rate/pump": { - "get": { - "tags": [ - "pump-performance-resource" - ], - "summary": "pumpStat", - "operationId": "pumpStatUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "durationHours", - "in": "query", - "required": false, - "type": "integer", - "maximum": 12, - "exclusiveMaximum": false, - "format": "int32" - }, - { - "name": "siteId", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/fuelling-status": { - "get": { - "tags": [ - "transaction-status-resource" - ], - "summary": "status", - "operationId": "statusUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "customerId", - "in": "query", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "paymentId", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AppTransactionStatusResponse" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/pump-activate": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "activatePump", - "operationId": "activatePumpUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "preAuthorizeRequest", - "description": "preAuthorizeRequest", - "required": true, - "schema": { - "$ref": "#/definitions/PreAuthorizeStep" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«PreAuthorizeStep»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/pump-cancel": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "cancelPump", - "operationId": "cancelPumpUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "cancelRequest", - "description": "cancelRequest", - "required": true, - "schema": { - "$ref": "#/definitions/CancelRequest" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CancelResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/pump-reserve": { - "post": { - "tags": [ - "pump-life-cycle-resource" - ], - "summary": "pumpReserve", - "operationId": "pumpReserveUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "pumpReserve", - "description": "pumpReserve", - "required": true, - "schema": { - "$ref": "#/definitions/PumpReserve" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«PumpReserve»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/app/v1/register-paymentId": { - "post": { - "tags": [ - "mobile-card-registration-resource" - ], - "summary": "generatePaymentIdentifier", - "operationId": "generatePaymentIdentifierUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "tokenizeRO", - "description": "tokenizeRO", - "required": true, - "schema": { - "$ref": "#/definitions/TokenizeRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}": { - "get": { - "tags": [ - "txn-status-resource" - ], - "summary": "getStatusByPaymentId", - "operationId": "getStatusByPaymentIdUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "paymentId", - "in": "path", - "description": "paymentId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SingleResponse«TxnStatusBo»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/intouch/txn-status/user-id/{userId}": { - "get": { - "tags": [ - "txn-status-resource" - ], - "summary": "OTATransactionsByUserId", - "operationId": "OTATransactionsByUserIdUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "userId", - "in": "path", - "description": "userId", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SingleResponse«List«UserTransactionBo»»" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/v1/site/cancel": { - "post": { - "tags": [ - "cancel-sandbox" - ], - "summary": "cancel", - "operationId": "cancelUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "cancelRO", - "description": "cancelRO", - "required": true, - "schema": { - "$ref": "#/definitions/CancelRO" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/v1/site/finalize-txn": { - "post": { - "tags": [ - "shell-server-to-server-resource" - ], - "summary": "finalizeTransaction", - "operationId": "finalizeTransactionUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "transactionAddRO", - "description": "transactionAddRO", - "required": true, - "schema": { - "$ref": "#/definitions/TransactionAddRO" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/v1/site/get-offers": { - "post": { - "tags": [ - "shell-server-to-server-resource" - ], - "summary": "offerEvaluation", - "operationId": "offerEvaluationUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "offerEvaluationReq", - "description": "offerEvaluationReq", - "required": true, - "schema": { - "$ref": "#/definitions/OfferEvaluation" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OfferEvaluation" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/2c2p/fuelling-callback": { - "post": { - "tags": [ - "_2c-2p-callback-resource" - ], - "summary": "fuellingCallBack", - "operationId": "fuellingCallBackUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "callbackRequest", - "description": "callbackRequest", - "required": true, - "schema": { - "$ref": "#/definitions/_2c2pCallbackRequest" - } - }, - { - "name": "defaultCard", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "extCorrelationID", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "orgId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "paymentProvider", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "userId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/2c2p/register-callback": { - "post": { - "tags": [ - "_2c-2p-callback-resource" - ], - "summary": "registerCallBack", - "operationId": "registerCallBackUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "callbackRequest", - "description": "callbackRequest", - "required": true, - "schema": { - "$ref": "#/definitions/_2c2pCallbackRequest" - } - }, - { - "name": "defaultCard", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "extCorrelationID", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "orgId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "paymentProvider", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "userId", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/eghl/callback": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "saveToken", - "operationId": "saveTokenUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "processData", - "description": "processData", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "shouldSave", - "in": "query", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/eghl/payment-identifier": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "tokenizeRO", - "description": "tokenizeRO", - "required": true, - "schema": { - "$ref": "#/definitions/TokenizeRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/eghl/transaction": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "callback", - "operationId": "callbackUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "callBackData", - "description": "callBackData", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/ping": { - "get": { - "tags": [ - "health-check-resource" - ], - "summary": "application health check", - "operationId": "healthCheckUsingGET", - "produces": [ - "*/*" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/reconciliation/capture": { - "post": { - "tags": [ - "psp-reconciliation" - ], - "summary": "reconciliationCapture", - "operationId": "reconciliationCaptureUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/reconciliation/registration-reversal": { - "post": { - "tags": [ - "psp-reconciliation" - ], - "summary": "reconciliationRegistrationReversal", - "operationId": "reconciliationRegistrationReversalUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/v1/workflow": { - "get": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "get", - "operationId": "getUsingGET", - "produces": [ - "*/*" - ], - "parameters": [ - { - "name": "allVersions", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "name", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GetEntityResponse" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - }, - "post": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "create", - "operationId": "createUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "workflowProcess", - "description": "workflowProcess", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowProcess" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SingleResponse«WorkFlowCreationResponse»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/v1/workflow/promotion": { - "put": { - "tags": [ - "admin-workflow-resource" - ], - "summary": "promoteWorkFlow", - "operationId": "promoteWorkFlowUsingPUT", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "workFlowPromote", - "description": "workFlowPromote", - "required": true, - "schema": { - "$ref": "#/definitions/WorkFlowPromote" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UpdatedEntityResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/v1/workflow/psp/payment-identifier": { - "post": { - "tags": [ - "psp-callback-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST_1", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "tokenizeRO", - "description": "tokenizeRO", - "required": true, - "schema": { - "$ref": "#/definitions/TokenizeRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/v1/workflow/shell/billing/evaluateOffer": { - "post": { - "tags": [ - "payments-resource" - ], - "summary": "evaluateOffers", - "operationId": "evaluateOffersUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "completeRequest", - "description": "completeRequest", - "required": true, - "schema": { - "$ref": "#/definitions/OfferEvaluationReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SingleResponse«OfferEvaluation»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/v1/workflow/shell/billing/transactionAdd": { - "post": { - "tags": [ - "payments-resource" - ], - "summary": "txnAdd", - "operationId": "txnAddUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "transactionAddRO", - "description": "transactionAddRO", - "required": true, - "schema": { - "$ref": "#/definitions/TransactionAddRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TransactionAddResponse" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - } - }, - "securityDefinitions": { - "X-CAP-API-AUTH-ENTITY-ID": { - "type": "apiKey", - "name": "X-CAP-API-AUTH-ENTITY-ID", - "in": "header" - }, - "X-CAP-API-AUTH-ORG-ID": { - "type": "apiKey", - "name": "X-CAP-API-AUTH-ORG-ID", - "in": "header" - }, - "X-CAP-ENTITY-CODE": { - "type": "apiKey", - "name": "X-CAP-ENTITY-CODE", - "in": "header" - }, - "X-CAP-ENTITY-ID": { - "type": "apiKey", - "name": "X-CAP-ENTITY-ID", - "in": "header" - } - }, - "definitions": { - "ActionInput": { - "type": "object", - "properties": { - "actionName": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "entityId": { - "type": "integer", - "format": "int64" - }, - "input": { - "type": "object" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "processInstanceId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "workFlowName": { - "type": "string" - } - }, - "title": "ActionInput" - }, - "AppTransactionStatusResponse": { - "type": "object", - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "paymentId": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "pumpNumber": { - "type": "string" - }, - "stationId": { - "type": "string" - }, - "transactionState": { - "type": "string", - "enum": [ - "BILL_GENERATED", - "FUELING_CANCELLED_BY_CUSTOMER", - "FUELING_CANCELLED_BY_STATION", - "PUMP_ACTIVATION_FAIL", - "PUMP_ACTIVATION_SUCCESS", - "PUMP_RESERVE_FAIL", - "PUMP_RESERVE_SUCCESS", - "TXN_STATE_UNKNOWN" - ] - } - }, - "title": "AppTransactionStatusResponse" - }, - "ApplicableVoucher": { - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number" - } - }, - "title": "ApplicableVoucher" - }, - "ApplicableVoucherReq": { - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string", - "format": "date-time" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "string" - } - }, - "title": "ApplicableVoucherReq" - }, - "ApplicableVoucherRes": { - "type": "object", - "properties": { - "additionVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "promotionType": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number" - } - }, - "title": "ApplicableVoucherRes" - }, - "Authorization": { - "type": "object", - "properties": { - "approvalCode": { - "type": "string" - }, - "batch": { - "type": "string" - }, - "couponCode": { - "type": "string" - }, - "coupons": { - "type": "string" - }, - "merchantName": { - "type": "string" - }, - "siteAddress": { - "type": "string" - }, - "siteName": { - "type": "string" - }, - "stan": { - "type": "string" - }, - "terminalID": { - "type": "string" - } - }, - "title": "Authorization" - }, - "CancelRO": { - "type": "object", - "properties": { - "mobilePaymentData": { - "$ref": "#/definitions/MobilePaymentData" - }, - "requestData": { - "$ref": "#/definitions/RequestData" - } - }, - "title": "CancelRO" - }, - "CancelRequest": { - "type": "object", - "properties": { - "processInstanceId": { - "type": "string" - } - }, - "title": "CancelRequest" - }, - "CancelResponse": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "CancelResponse" - }, - "CardRegisterROReq": { - "type": "object", - "required": [ - "currencyCode", - "customerInfo", - "paymentProviderName", - "registrationAmount" - ], - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "CardRegisterROReq" - }, - "CardRegisterRORes": { - "type": "object", - "required": [ - "currencyCode", - "customerInfo", - "paymentProviderName", - "registrationAmount" - ], - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "CardRegisterRORes" - }, - "CardValue": { - "type": "object", - "properties": { - "cardCircuit": { - "type": "string" - }, - "cardEntryMode": { - "type": "string" - }, - "cardID": { - "type": "string" - }, - "inString": { - "type": "string" - }, - "loyaltyExceptionIndicator": { - "type": "integer", - "format": "int32" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "pointsRedeemed": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "string" - }, - "trackers": { - "type": "array", - "items": { - "$ref": "#/definitions/Tracker" - } - } - }, - "title": "CardValue" - }, - "CustomerData": { - "type": "object", - "required": [ - "customerDataType", - "customerDataValue" - ], - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number" - } - }, - "title": "CustomerData" - }, - "CustomerDataReq": { - "type": "object", - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number" - } - }, - "title": "CustomerDataReq" - }, - "CustomerDataRes": { - "type": "object", - "required": [ - "customerDataType", - "customerDataValue" - ], - "properties": { - "customerDataType": { - "type": "string" - }, - "customerDataValue": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "pointsRedeemed": { - "type": "number" - } - }, - "title": "CustomerDataRes" - }, - "CustomerInfo": { - "type": "object", - "required": [ - "identifierName" - ], - "properties": { - "accountId": { - "type": "string" - }, - "customerId": { - "type": "integer", - "format": "int64" - }, - "identifierName": { - "type": "string", - "enum": [ - "cardnumber", - "email", - "externalId", - "mobile", - "wechat" - ] - }, - "identifierValue": { - "type": "string" - }, - "source": { - "type": "string" - } - }, - "title": "CustomerInfo" - }, - "GetEntityResponse": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "workflowMeta": { - "type": "array", - "items": { - "$ref": "#/definitions/OrgWorkflowMetaDto" - } - } - }, - "title": "GetEntityResponse" - }, - "LoyaltyDetails": { - "type": "object", - "properties": { - "loyaltyPAN": { - "type": "string" - }, - "loyaltyType": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "pointsRedeemed": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number" - }, - "trackers": { - "type": "array", - "items": { - "$ref": "#/definitions/Tracker" - } - } - }, - "title": "LoyaltyDetails" - }, - "LoyaltyOffer": { - "type": "object", - "properties": { - "loyaltyOfferDescription": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "promotionType": { - "type": "string", - "enum": [ - "Cart", - "lineitem" - ] - }, - "referenceID": { - "type": "string" - } - }, - "title": "LoyaltyOffer" - }, - "Message": { - "type": "object", - "properties": { - "cashierMessage": { - "type": "string" - } - }, - "title": "Message" - }, - "MobilePaymentData": { - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "globalRetailSiteID": { - "type": "string" - }, - "loyaltyDetails": { - "type": "array", - "items": { - "$ref": "#/definitions/LoyaltyDetails" - } - }, - "loyaltyExceptionIndicator": { - "type": "integer", - "format": "int32" - }, - "merchantID": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "methodOfPaymentName": { - "type": "string" - }, - "paymentData": { - "type": "string" - }, - "paymentServiceProvider": { - "type": "string" - }, - "pumpNumber": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number" - } - }, - "title": "MobilePaymentData" - }, - "MobileResponseBody«CardRegisterRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CardRegisterRORes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "MobileResponseBody«CardRegisterRO»" - }, - "MobileResponseBody«PreAuthorizeStep»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PreAuthorizeStep" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "MobileResponseBody«PreAuthorizeStep»" - }, - "MobileResponseBody«PumpReserve»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/PumpReserve" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "MobileResponseBody«PumpReserve»" - }, - "MobileResponseBody«TokenizeRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/TokenizeRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "MobileResponseBody«TokenizeRO»" - }, - "OfferEvaluation": { - "type": "object", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicableVoucher" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerData" - } - }, - "messages": { - "$ref": "#/definitions/Message" - }, - "posData": { - "$ref": "#/definitions/PosData" - }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, - "receipt": { - "$ref": "#/definitions/Receipt" - }, - "requestData": { - "$ref": "#/definitions/RequestData" - }, - "responseData": { - "$ref": "#/definitions/ResponseData" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/definitions/SaleItem" - } - }, - "siteData": { - "$ref": "#/definitions/SiteData" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/definitions/Tender" - } - }, - "totalAmount": { - "type": "number" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherCodesResult" - } - } - }, - "title": "OfferEvaluation" - }, - "OfferEvaluationReq": { - "type": "object", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicableVoucherReq" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerDataReq" - } - }, - "messages": { - "$ref": "#/definitions/Message" - }, - "posData": { - "$ref": "#/definitions/PosDataReq" - }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, - "receipt": { - "$ref": "#/definitions/ReceiptReq" - }, - "requestData": { - "$ref": "#/definitions/RequestDataReq" - }, - "responseData": { - "$ref": "#/definitions/ResponseDataReq" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/definitions/SaleItemReq" - } - }, - "siteData": { - "$ref": "#/definitions/SiteDataReq" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/definitions/TenderReq" - } - }, - "totalAmount": { - "type": "number" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherCodesResult" - } - } - }, - "title": "OfferEvaluationReq" - }, - "OfferEvaluationRes": { - "type": "object", - "required": [ - "customerData", - "posData", - "requestData", - "saleItems", - "siteData", - "tenders", - "totalAmount" - ], - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicableVoucherRes" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerDataRes" - } - }, - "messages": { - "$ref": "#/definitions/Message" - }, - "posData": { - "$ref": "#/definitions/PosDataRes" - }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, - "receipt": { - "$ref": "#/definitions/ReceiptRes" - }, - "requestData": { - "$ref": "#/definitions/RequestDataRes" - }, - "responseData": { - "$ref": "#/definitions/ResponseDataRes" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/definitions/SaleItemRes" - } - }, - "siteData": { - "$ref": "#/definitions/SiteDataRes" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/definitions/TenderRes" - } - }, - "totalAmount": { - "type": "number" - }, - "voucherCodesResult": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherCodesResult" - } - } - }, - "title": "OfferEvaluationRes" - }, - "OrgWorkflowMetaDto": { - "type": "object", - "properties": { - "autoUpdateTime": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "integer", - "format": "int64" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "isActive": { - "type": "boolean" - }, - "isApproved": { - "type": "boolean" - }, - "isAsync": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "processId": { - "type": "string" - }, - "promotedOn": { - "type": "string", - "format": "date-time" - }, - "versionName": { - "type": "string" - }, - "workflowName": { - "type": "string" - } - }, - "title": "OrgWorkflowMetaDto" - }, - "OriginalTransaction": { - "type": "object", - "properties": { - "approvalCode": { - "type": "string" - }, - "authorizationToken": { - "type": "string" - }, - "stan": { - "type": "string" - }, - "terminalBatch": { - "type": "string" - }, - "terminalID": { - "type": "string" - }, - "timeStamp": { - "type": "string", - "format": "date-time" - } - }, - "title": "OriginalTransaction" - }, - "PerformanceBo": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int64" - }, - "failurePercentage": { - "type": "number" - } - }, - "title": "PerformanceBo" - }, - "PosData": { - "type": "object", - "required": [ - "posTimeStamp" - ], - "properties": { - "languageCode": { - "type": "string" - }, - "posTimeStamp": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - }, - "title": "PosData" - }, - "PosDataReq": { - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "clerkID": { - "type": "string" - }, - "originalSalePosTimeStamp": { - "type": "string" - }, - "posTimeStamp": { - "type": "string", - "format": "date-time" - }, - "pumpNumber": { - "type": "string" - }, - "terminalID": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - }, - "title": "PosDataReq" - }, - "PosDataRes": { - "type": "object", - "required": [ - "posTimeStamp" - ], - "properties": { - "languageCode": { - "type": "string" - }, - "posTimeStamp": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - } - }, - "title": "PosDataRes" - }, - "PreAuthorizeStep": { - "type": "object", - "properties": { - "processInstanceId": { - "type": "string" - }, - "pspReferenceNumber": { - "type": "string" - } - }, - "title": "PreAuthorizeStep" - }, - "PredictedTender": { - "type": "object", - "properties": { - "acquire": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "subtractDiscountAmount": { - "type": "boolean" - } - }, - "title": "PredictedTender" - }, - "PriceAdjustment": { - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "unitPrice": { - "type": "number" - } - }, - "title": "PriceAdjustment" - }, - "PriceAdjustmentReq": { - "type": "object", - "required": [ - "amount", - "loyaltyOfferID", - "reason", - "referenceID" - ], - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "netAmount": { - "type": "number" - }, - "originalAmount": { - "type": "number" - }, - "originalNetAmount": { - "type": "number" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "productCode": { - "type": "string" - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "taxSplit": { - "type": "array", - "items": { - "$ref": "#/definitions/TaxSplit" - } - }, - "unitOfMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number" - }, - "vat": { - "type": "number" - } - }, - "title": "PriceAdjustmentReq" - }, - "PriceAdjustmentRes": { - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "loyaltyOfferID": { - "type": "string" - }, - "priceAdjustmentID": { - "type": "string" - }, - "priceAdjustmentType": { - "type": "string", - "enum": [ - "Coupon", - "Gift", - "Local Discount", - "Price Override", - "RealtimeOffer-A", - "RealtimeOffer-U", - "Voucher" - ] - }, - "promotionType": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "reason": { - "type": "string" - }, - "referenceID": { - "type": "string" - }, - "unitPrice": { - "type": "number" - } - }, - "title": "PriceAdjustmentRes" - }, - "ProcessInstanceDetails": { - "type": "object", - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "tillId": { - "type": "integer", - "format": "int64" - }, - "version": { - "type": "string" - }, - "workflowName": { - "type": "string" - } - }, - "title": "ProcessInstanceDetails" - }, - "Product": { - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "categoryCode": { - "type": "string" - }, - "productCode": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - } - }, - "title": "Product" - }, - "PumpReserve": { - "type": "object", - "required": [ - "currencyCode", - "customerInfo", - "methodOfPaymentId", - "paymentProviderName", - "preAuthAmount", - "siteId" - ], - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "languageCode": { - "type": "string" - }, - "loyaltyPan": { - "type": "string" - }, - "methodOfPaymentId": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "pumpNumber": { - "type": "string" - }, - "siteId": { - "type": "string" - } - }, - "title": "PumpReserve" - }, - "Receipt": { - "type": "object", - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "Receipt" - }, - "ReceiptReq": { - "type": "object", - "required": [ - "receiptLines" - ], - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "ReceiptReq" - }, - "ReceiptRes": { - "type": "object", - "properties": { - "receiptLines": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "title": "ReceiptRes" - }, - "RequestData": { - "type": "object", - "required": [ - "requestID", - "requestType", - "workstationID" - ], - "properties": { - "cartEvaluationID": { - "type": "string" - }, - "payTokenID": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - }, - "title": "RequestData" - }, - "RequestDataReq": { - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "countryCode": { - "type": "string" - }, - "extCorrelationId": { - "type": "string" - }, - "payTokenID": { - "type": "string" - }, - "paymentServiceProvider": { - "type": "string" - }, - "processInstanceId": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "transactionNumber": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - }, - "title": "RequestDataReq" - }, - "RequestDataRes": { - "type": "object", - "properties": { - "overallResult": { - "type": "string" - }, - "requestID": { - "type": "string" - } - }, - "title": "RequestDataRes" - }, - "ResponseData": { - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "overallResult": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - }, - "title": "ResponseData" - }, - "ResponseDataReq": { - "type": "object", - "properties": { - "actionCode": { - "type": "string" - }, - "actionCodeDescription": { - "type": "string" - }, - "cartEvaluationID": { - "type": "string" - }, - "overallResult": { - "type": "string" - }, - "referenceNumber": { - "type": "string" - }, - "requestID": { - "type": "string" - }, - "requestType": { - "type": "string" - }, - "workstationID": { - "type": "string" - } - }, - "title": "ResponseDataReq" - }, - "ResponseDataRes": { - "type": "object", - "properties": { - "requestType": { - "type": "string" - } - }, - "title": "ResponseDataRes" - }, - "SaleItem": { - "type": "object", - "required": [ - "additionalProductInfo", - "amount", - "originalAmount", - "quantity", - "saleItemType", - "unitMeasure", - "unitPrice" - ], - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "itemID": { - "type": "integer", - "format": "int32" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/definitions/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "originalAmount": { - "type": "number" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/definitions/PriceAdjustment" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "saleChannel": { - "type": "integer", - "format": "int32" - }, - "saleItemType": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - }, - "unitMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number" - }, - "vatRate": { - "type": "number" - } - }, - "title": "SaleItem" - }, - "SaleItemReq": { - "type": "object", - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "lineNo": { - "type": "string" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/definitions/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "netAmount": { - "type": "number" - }, - "originalAmount": { - "type": "number" - }, - "originalNetAmount": { - "type": "number" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/definitions/PriceAdjustmentReq" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "saleChannel": { - "type": "string" - }, - "saleItemType": { - "type": "string" - }, - "taxAmount": { - "type": "number" - }, - "taxCode": { - "type": "string" - }, - "taxRate": { - "type": "number" - }, - "unitOfMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number" - }, - "vatRate": { - "type": "number" - } - }, - "title": "SaleItemReq" - }, - "SaleItemRes": { - "type": "object", - "required": [ - "additionalProductInfo", - "amount", - "originalAmount", - "quantity", - "saleItemType", - "unitMeasure", - "unitPrice" - ], - "properties": { - "additionalProductCode": { - "type": "string" - }, - "additionalProductInfo": { - "type": "string" - }, - "amount": { - "type": "number" - }, - "categoryCode": { - "type": "string" - }, - "itemID": { - "type": "integer", - "format": "int32" - }, - "loyaltyOffers": { - "type": "array", - "items": { - "$ref": "#/definitions/LoyaltyOffer" - } - }, - "markDownIndicator": { - "type": "boolean" - }, - "originalAmount": { - "type": "number" - }, - "priceAdjustments": { - "type": "array", - "items": { - "$ref": "#/definitions/PriceAdjustmentRes" - } - }, - "productCode": { - "type": "string" - }, - "quantity": { - "type": "number" - }, - "saleChannel": { - "type": "integer", - "format": "int32" - }, - "saleItemType": { - "type": "string" - }, - "subCategoryCode": { - "type": "string" - }, - "unitMeasure": { - "type": "string" - }, - "unitPrice": { - "type": "number" - }, - "vatRate": { - "type": "number" - } - }, - "title": "SaleItemRes" - }, - "SaleTransaction": { - "type": "object", - "required": [ - "totalAmount" - ], - "properties": { - "authorization": { - "$ref": "#/definitions/Authorization" - }, - "coupons": { - "type": "array", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string" - }, - "currencyCode": { - "type": "string" - }, - "extraDiscountAmount": { - "type": "number", - "format": "double" - }, - "loyaltyPointAmount": { - "type": "integer", - "format": "int32" - }, - "merchantName": { - "type": "string" - }, - "netAmount": { - "type": "number", - "format": "double" - }, - "siteAddress": { - "type": "string" - }, - "siteName": { - "type": "string" - }, - "taxReferenceNumber": { - "type": "string" - }, - "timeStamp": { - "type": "string" - }, - "totalAmount": { - "type": "number", - "format": "double" - }, - "totalDiscountAmount": { - "type": "number", - "format": "double" - }, - "totalTaxAmount": { - "type": "number", - "format": "double" - }, - "transactionNumber": { - "type": "string" - } - }, - "title": "SaleTransaction" - }, - "ShellTransactionResponse": { - "type": "object", - "properties": { - "requestData": { - "$ref": "#/definitions/RequestDataRes" - }, - "responseData": { - "$ref": "#/definitions/ResponseDataRes" - } - }, - "title": "ShellTransactionResponse" - }, - "SingleResponse«List«UserTransactionBo»»": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/definitions/UserTransactionBo" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "SingleResponse«List«UserTransactionBo»»" - }, - "SingleResponse«OfferEvaluation»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/OfferEvaluationRes" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "SingleResponse«OfferEvaluation»" - }, - "SingleResponse«TxnStatusBo»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/TxnStatusBo" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "SingleResponse«TxnStatusBo»" - }, - "SingleResponse«WorkFlowCreationResponse»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/WorkFlowCreationResponse" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processId": { - "type": "string" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "SingleResponse«WorkFlowCreationResponse»" - }, - "SiteData": { - "type": "object", - "required": [ - "countryCode", - "siteID" - ], - "properties": { - "countryCode": { - "type": "string" - }, - "siteID": { - "type": "string" - } - }, - "title": "SiteData" - }, - "SiteDataReq": { - "type": "object", - "properties": { - "countryCode": { - "type": "string" - }, - "siteId": { - "type": "string" - } - }, - "title": "SiteDataReq" - }, - "SiteDataRes": { - "type": "object", - "required": [ - "countryCode", - "siteID" - ], - "properties": { - "countryCode": { - "type": "string" - }, - "siteID": { - "type": "string" - } - }, - "title": "SiteDataRes" - }, - "StatResponse«Map«string,PerformanceBo»»": { - "type": "object", - "properties": { - "data": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PerformanceBo" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "StatResponse«Map«string,PerformanceBo»»" - }, - "StatusCode": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "isWarning": { - "type": "boolean" - }, - "message": { - "type": "string" - } - }, - "title": "StatusCode" - }, - "TaxSplit": { - "type": "object", - "properties": { - "additionalAmount": { - "type": "number" - }, - "amount": { - "type": "number" - }, - "code": { - "type": "string" - }, - "rate": { - "type": "number" - }, - "taxID": { - "type": "integer", - "format": "int32" - } - }, - "title": "TaxSplit" - }, - "Tender": { - "type": "object", - "required": [ - "acquirerID" - ], - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "integer", - "format": "int32" - }, - "netTenderAmount": { - "type": "number" - }, - "pointsRedeemed": { - "type": "number" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherRule" - } - } - }, - "title": "Tender" - }, - "TenderReq": { - "type": "object", - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "string" - }, - "netTenderAmount": { - "type": "string" - }, - "pointsRedeemed": { - "type": "string" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "string" - }, - "totalAmount": { - "type": "string" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherRuleReq" - } - } - }, - "title": "TenderReq" - }, - "TenderRes": { - "type": "object", - "required": [ - "acquirerID" - ], - "properties": { - "acquirerID": { - "type": "string" - }, - "methodOfPayment": { - "type": "string" - }, - "methodOfPaymentID": { - "type": "integer", - "format": "int32" - }, - "netTenderAmount": { - "type": "number" - }, - "pointsRedeemed": { - "type": "number" - }, - "substractDiscountAmount": { - "type": "boolean" - }, - "tenderID": { - "type": "integer", - "format": "int32" - }, - "totalAmount": { - "type": "number" - }, - "voucherRules": { - "type": "array", - "items": { - "$ref": "#/definitions/VoucherRuleRes" - } - } - }, - "title": "TenderRes" - }, - "Terminal": { - "type": "object", - "properties": { - "stan": { - "type": "string" - }, - "terminalBatch": { - "type": "string" - } - }, - "title": "Terminal" - }, - "TokenizeRO": { - "type": "object", - "required": [ - "currencyCode", - "customerInfo", - "loyaltyPan", - "paymentProviderName", - "registrationAmount" - ], - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "TokenizeRO" - }, - "Tracker": { - "type": "object", - "properties": { - "trackerEarned": { - "type": "string" - }, - "trackerRedeemed": { - "type": "string" - }, - "trackerType": { - "type": "string" - }, - "trackerValue": { - "type": "string" - } - }, - "title": "Tracker" - }, - "TransactionAddRO": { - "type": "object", - "required": [ - "cardValues", - "receipt", - "requestData", - "saleItems", - "saleTransaction" - ], - "properties": { - "applicableVouchers": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicableVoucher" - } - }, - "cardValues": { - "type": "array", - "items": { - "$ref": "#/definitions/CardValue" - } - }, - "customerData": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerData" - } - }, - "mobilePaymentData": { - "$ref": "#/definitions/MobilePaymentData" - }, - "originalTransaction": { - "$ref": "#/definitions/OriginalTransaction" - }, - "posData": { - "$ref": "#/definitions/PosData" - }, - "receipt": { - "$ref": "#/definitions/Receipt" - }, - "requestData": { - "$ref": "#/definitions/RequestData" - }, - "saleItems": { - "type": "array", - "items": { - "$ref": "#/definitions/SaleItem" - } - }, - "saleTransaction": { - "$ref": "#/definitions/SaleTransaction" - }, - "siteData": { - "$ref": "#/definitions/SiteData" - }, - "tenders": { - "type": "array", - "items": { - "$ref": "#/definitions/Tender" - } - }, - "terminal": { - "$ref": "#/definitions/Terminal" - }, - "totalAmount": { - "type": "number" - } - }, - "title": "TransactionAddRO" - }, - "TransactionAddResponse": { - "type": "object", - "properties": { - "shellResponse": { - "type": "array", - "items": { - "$ref": "#/definitions/ShellTransactionResponse" - } - } - }, - "title": "TransactionAddResponse" - }, - "TxnStatusBo": { - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "extCorrelationId": { - "type": "string" - }, - "finalStatus": { - "type": "string" - }, - "instanceVariables": { - "type": "object" - }, - "languageCode": { - "type": "string" - }, - "methodOfPaymentId": { - "type": "string" - }, - "orgId": { - "type": "integer", - "format": "int64" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "pumpNumber": { - "type": "integer", - "format": "int32" - }, - "siteId": { - "type": "string" - }, - "status": { - "type": "string" - }, - "stepRequests": { - "type": "object" - }, - "workFlowDetails": { - "$ref": "#/definitions/ProcessInstanceDetails" - } - }, - "title": "TxnStatusBo" - }, - "UpdatedEntityResponse": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "UpdatedEntityResponse" - }, - "UserTransactionBo": { - "type": "object", - "properties": { - "extCorrelationId": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "invoice": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "preAuthAmount": { - "type": "string" - }, - "pumpId": { - "type": "string" - }, - "siteId": { - "type": "string" - }, - "startTimestamp": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "title": "UserTransactionBo" - }, - "Violation": { - "type": "object", - "properties": { - "fieldName": { - "type": "string" - }, - "invalidValue": { - "type": "object" - }, - "message": { - "type": "string" - } - }, - "title": "Violation" - }, - "VoucherCodesResult": { - "type": "object", - "properties": { - "actionCode": { - "type": "integer", - "format": "int32" - }, - "actionCodeDescription": { - "type": "string" - }, - "voucherCode": { - "type": "string" - } - }, - "title": "VoucherCodesResult" - }, - "VoucherRule": { - "type": "object", - "required": [ - "voucherCode" - ], - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number" - } - }, - "title": "VoucherRule" - }, - "VoucherRuleReq": { - "type": "object", - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string", - "format": "date-time" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "referenceId": { - "type": "string" - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number" - } - }, - "title": "VoucherRuleReq" - }, - "VoucherRuleRes": { - "type": "object", - "required": [ - "voucherCode" - ], - "properties": { - "additionalVoucherInfo": { - "type": "string" - }, - "expiryDate": { - "type": "string" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/definitions/Product" - } - }, - "voucherCode": { - "type": "string" - }, - "voucherType": { - "type": "string" - }, - "voucherValue": { - "type": "number" - } - }, - "title": "VoucherRuleRes" - }, - "WorkFlowCreationResponse": { - "type": "object", - "properties": { - "deploymentId": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "title": "WorkFlowCreationResponse" - }, - "WorkFlowPromote": { - "type": "object", - "properties": { - "version": { - "type": "string" - }, - "workFlowName": { - "type": "string" - } - }, - "title": "WorkFlowPromote" - }, - "WorkflowInputAction": { - "type": "object", - "required": [ - "httpCallInputProperties" - ], - "properties": { - "actionGroupType": { - "type": "string", - "enum": [ - "PARALLEL", - "SERIAL", - "XOR" - ] - }, - "delayTimeInRetrial": { - "type": "integer", - "format": "int32" - }, - "httpCallInputProperties": { - "$ref": "#/definitions/ActionInput" - }, - "httpCallInputPropertiesRollback": { - "$ref": "#/definitions/ActionInput" - }, - "isAsync": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "properties": { - "type": "object" - }, - "retrialCount": { - "type": "integer", - "format": "int32" - }, - "rollBackProperties": { - "type": "object" - }, - "serialNumber": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string", - "enum": [ - "CCCaptureAction", - "addTransactionAction", - "authorizePaymentWithPsp", - "confirmAuthWithPSPAction", - "eghlCapturePaymentAction", - "eghlTokenizationAction", - "emptyAction", - "generatePaymentIdAction", - "ifredeemPointsAction", - "invalid", - "oAuthHttpAction", - "offerEvaluationAction", - "redeemPointsAction", - "saveCCardAction" - ] - } - }, - "title": "WorkflowInputAction" - }, - "WorkflowProcess": { - "type": "object", - "properties": { - "isAsync": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "steps": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkflowStep" - } - } - }, - "title": "WorkflowProcess" - }, - "WorkflowStep": { - "type": "object", - "properties": { - "actions": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkflowInputAction" - } - }, - "maxWaitTimeInMillis": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "serialNumber": { - "type": "integer", - "format": "int32" - } - }, - "title": "WorkflowStep" - }, - "_2c2pCallbackRequest": { - "type": "object", - "properties": { - "payload": { - "type": "string" - } - }, - "title": "_2c2pCallbackRequest" - } - } -} +{"swagger":"2.0","info":{"description":"Potato OTA Transaction Orchestrator","version":"1.0","title":"POTATO","contact":{"name":"Capillary Technologies","url":"https://www.capillarytech.com"},"license":{}},"host":"orchestratoradmin.crm-nightly-new.cctools.capillarytech.com","basePath":"/","tags":[{"name":"_2c-2p-callback-resource","description":"_2c 2p Callback Resource"},{"name":"admin-workflow-resource","description":"Admin Workflow Resource"},{"name":"cancel-sandbox","description":"Cancel Sandbox"},{"name":"eghl-call-back-resource","description":"Eghl Call Back Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"mobile-card-registration-resource","description":"Mobile Card Registration Resource"},{"name":"open-api-web-mvc-resource","description":"Open Api Web Mvc Resource"},{"name":"payments-resource","description":"Payments Resource"},{"name":"psp-callback-resource","description":"Psp Callback Resource"},{"name":"psp-performance-resource","description":"Psp Performance Resource"},{"name":"psp-reconciliation","description":"PSP Reconciliation"},{"name":"pump-life-cycle-resource","description":"Pump Life Cycle Resource"},{"name":"pump-performance-resource","description":"Pump Performance Resource"},{"name":"shell-server-to-server-resource","description":"Shell Server To Server Resource"},{"name":"swagger-config-resource","description":"Swagger Config Resource"},{"name":"test-fuelling-workflow-resource","description":"Test Fuelling Workflow Resource"},{"name":"transaction-status-resource","description":"Transaction Status Resource"},{"name":"txn-status-resource","description":"Txn Status Resource"}],"paths":{"/orchestrator/payments/app/pumpReserve/{version}":{"post":{"tags":["test-fuelling-workflow-resource"],"summary":"pumpReserveWithGivenVersion","operationId":"pumpReserveWithGivenVersionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"pumpReserve","description":"pumpReserve","required":true,"schema":{"$ref":"#/definitions/PumpReserve"}},{"name":"version","in":"path","description":"version","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PumpReserve»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/register-paymentIdV1":{"post":{"tags":["mobile-card-registration-resource"],"summary":"registerPaymentId","operationId":"registerPaymentIdUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cardRegisterRO","description":"cardRegisterRO","required":true,"schema":{"$ref":"#/definitions/CardRegisterROReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«CardRegisterRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/bank":{"get":{"tags":["psp-performance-resource"],"summary":"pspStat","operationId":"pspStatUsingGET","produces":["*/*"],"parameters":[{"name":"bankName","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"durationHours","in":"query","required":false,"type":"integer","format":"int32"},{"name":"psp","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatResponse«Map«string,PerformanceBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/pump":{"get":{"tags":["pump-performance-resource"],"summary":"pumpStat","operationId":"pumpStatUsingGET","produces":["*/*"],"parameters":[{"name":"durationHours","in":"query","required":false,"type":"integer","format":"int32"},{"name":"siteId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatResponse«Map«string,PerformanceBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/fuelling-status":{"get":{"tags":["transaction-status-resource"],"summary":"status","operationId":"statusUsingGET","produces":["*/*"],"parameters":[{"name":"customerId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AppTransactionStatusResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-activate":{"post":{"tags":["pump-life-cycle-resource"],"summary":"activatePump","operationId":"activatePumpUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"preAuthorizeRequest","description":"preAuthorizeRequest","required":true,"schema":{"$ref":"#/definitions/PreAuthorizeStep"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PreAuthorizeStep»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-cancel":{"post":{"tags":["pump-life-cycle-resource"],"summary":"cancelPump","operationId":"cancelPumpUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cancelRequest","description":"cancelRequest","required":true,"schema":{"$ref":"#/definitions/CancelRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CancelResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-reserve":{"post":{"tags":["pump-life-cycle-resource"],"summary":"pumpReserve","operationId":"pumpReserveUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"pumpReserve","description":"pumpReserve","required":true,"schema":{"$ref":"#/definitions/PumpReserve"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PumpReserve»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/register-paymentId":{"post":{"tags":["mobile-card-registration-resource"],"summary":"generatePaymentIdentifier","operationId":"generatePaymentIdentifierUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}":{"get":{"tags":["txn-status-resource"],"summary":"getStatusByPaymentId","operationId":"getStatusByPaymentIdUsingGET","produces":["*/*"],"parameters":[{"name":"paymentId","in":"path","description":"paymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«TxnStatusBo»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/user-id/{userId}":{"get":{"tags":["txn-status-resource"],"summary":"OTATransactionsByUserId","operationId":"OTATransactionsByUserIdUsingGET","produces":["*/*"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«List«UserTransactionBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/cancel":{"post":{"tags":["cancel-sandbox"],"summary":"cancel","operationId":"cancelUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cancelRO","description":"cancelRO","required":true,"schema":{"$ref":"#/definitions/CancelRO"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/finalize-txn":{"post":{"tags":["shell-server-to-server-resource"],"summary":"finalizeTransaction","operationId":"finalizeTransactionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"transactionAddRO","description":"transactionAddRO","required":true,"schema":{"$ref":"#/definitions/TransactionAddRO"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/get-offers":{"post":{"tags":["shell-server-to-server-resource"],"summary":"offerEvaluation","operationId":"offerEvaluationUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"offerEvaluationReq","description":"offerEvaluationReq","required":true,"schema":{"$ref":"#/definitions/OfferEvaluation"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OfferEvaluation"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/fuelling-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"fuellingCallBack","operationId":"fuellingCallBackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/_2c2pCallbackRequest"}},{"name":"defaultCard","in":"query","required":false,"type":"boolean"},{"name":"extCorrelationID","in":"query","required":false,"type":"string"},{"name":"orgId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentProvider","in":"query","required":false,"type":"string"},{"name":"userId","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/register-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"registerCallBack","operationId":"registerCallBackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/_2c2pCallbackRequest"}},{"name":"defaultCard","in":"query","required":false,"type":"boolean"},{"name":"extCorrelationID","in":"query","required":false,"type":"string"},{"name":"orgId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentProvider","in":"query","required":false,"type":"string"},{"name":"userId","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/callback":{"post":{"tags":["eghl-call-back-resource"],"summary":"saveToken","operationId":"saveTokenUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"processData","description":"processData","required":true,"schema":{"type":"string"}},{"name":"shouldSave","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/payment-identifier":{"post":{"tags":["eghl-call-back-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/transaction":{"post":{"tags":["eghl-call-back-resource"],"summary":"callback","operationId":"callbackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callBackData","description":"callBackData","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/ping":{"get":{"tags":["health-check-resource"],"summary":"application health check","operationId":"healthCheckUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/capture":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationCapture","operationId":"reconciliationCaptureUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/registration-reversal":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationRegistrationReversal","operationId":"reconciliationRegistrationReversalUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow":{"get":{"tags":["admin-workflow-resource"],"summary":"get","operationId":"getUsingGET","produces":["*/*"],"parameters":[{"name":"allVersions","in":"query","required":false,"type":"boolean"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"version","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GetEntityResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]},"post":{"tags":["admin-workflow-resource"],"summary":"create","operationId":"createUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"workflowProcess","description":"workflowProcess","required":true,"schema":{"$ref":"#/definitions/WorkflowProcess"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«WorkFlowCreationResponse»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/promotion":{"put":{"tags":["admin-workflow-resource"],"summary":"promoteWorkFlow","operationId":"promoteWorkFlowUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"workFlowPromote","description":"workFlowPromote","required":true,"schema":{"$ref":"#/definitions/WorkFlowPromote"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdatedEntityResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/psp/payment-identifier":{"post":{"tags":["psp-callback-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/evaluateOffer":{"post":{"tags":["payments-resource"],"summary":"evaluateOffers","operationId":"evaluateOffersUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"completeRequest","description":"completeRequest","required":true,"schema":{"$ref":"#/definitions/OfferEvaluationReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«OfferEvaluation»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/transactionAdd":{"post":{"tags":["payments-resource"],"summary":"txnAdd","operationId":"txnAddUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"transactionAddRO","description":"transactionAddRO","required":true,"schema":{"$ref":"#/definitions/TransactionAddRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransactionAddResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs":{"get":{"tags":["open-api-web-mvc-resource"],"summary":"openapiJson","operationId":"openapiJsonUsingGET","produces":["application/json"],"parameters":[{"name":"apiDocsUrl","in":"query","description":"apiDocsUrl","required":false,"type":"string"},{"name":"country","in":"query","required":false,"type":"string"},{"name":"displayCountry","in":"query","required":false,"type":"string"},{"name":"displayLanguage","in":"query","required":false,"type":"string"},{"name":"displayName","in":"query","required":false,"type":"string"},{"name":"displayScript","in":"query","required":false,"type":"string"},{"name":"displayVariant","in":"query","required":false,"type":"string"},{"name":"extensionKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ISO3Country","in":"query","required":false,"type":"string"},{"name":"ISO3Language","in":"query","required":false,"type":"string"},{"name":"language","in":"query","required":false,"type":"string"},{"name":"script","in":"query","required":false,"type":"string"},{"name":"unicodeLocaleAttributes","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"unicodeLocaleKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"variant","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs.yaml":{"get":{"tags":["open-api-web-mvc-resource"],"summary":"openapiYaml","operationId":"openapiYamlUsingGET","produces":["application/vnd.oai.openapi"],"parameters":[{"name":"apiDocsUrl","in":"query","description":"apiDocsUrl","required":false,"type":"string"},{"name":"country","in":"query","required":false,"type":"string"},{"name":"displayCountry","in":"query","required":false,"type":"string"},{"name":"displayLanguage","in":"query","required":false,"type":"string"},{"name":"displayName","in":"query","required":false,"type":"string"},{"name":"displayScript","in":"query","required":false,"type":"string"},{"name":"displayVariant","in":"query","required":false,"type":"string"},{"name":"extensionKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ISO3Country","in":"query","required":false,"type":"string"},{"name":"ISO3Language","in":"query","required":false,"type":"string"},{"name":"language","in":"query","required":false,"type":"string"},{"name":"script","in":"query","required":false,"type":"string"},{"name":"unicodeLocaleAttributes","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"unicodeLocaleKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"variant","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs/swagger-config":{"get":{"tags":["swagger-config-resource"],"summary":"openapiJson","operationId":"openapiJsonUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}}},"securityDefinitions":{"X-CAP-API-AUTH-ENTITY-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ENTITY-ID","in":"header"},"X-CAP-API-AUTH-ORG-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ORG-ID","in":"header"},"X-CAP-ENTITY-CODE":{"type":"apiKey","name":"X-CAP-ENTITY-CODE","in":"header"},"X-CAP-ENTITY-ID":{"type":"apiKey","name":"X-CAP-ENTITY-ID","in":"header"}},"definitions":{"ActionInput":{"type":"object","properties":{"actionName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"entityId":{"type":"integer","format":"int64"},"input":{"type":"object"},"orgId":{"type":"integer","format":"int64"},"processInstanceId":{"type":"string"},"version":{"type":"string"},"workFlowName":{"type":"string"}},"title":"ActionInput"},"AppTransactionStatusResponse":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"processInstanceId":{"type":"string"},"pumpNumber":{"type":"string"},"stationId":{"type":"string"},"transactionState":{"type":"string","enum":["BILL_GENERATED","FUELING_CANCELLED_BY_CUSTOMER","FUELING_CANCELLED_BY_STATION","PUMP_ACTIVATION_FAIL","PUMP_ACTIVATION_SUCCESS","PUMP_RESERVE_FAIL","PUMP_RESERVE_SUCCESS","TXN_STATE_UNKNOWN"]}},"title":"AppTransactionStatusResponse"},"ApplicableVoucher":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"ApplicableVoucher"},"ApplicableVoucherReq":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"string"}},"title":"ApplicableVoucherReq"},"ApplicableVoucherRes":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"ApplicableVoucherRes"},"Authorization":{"type":"object","properties":{"approvalCode":{"type":"string"},"batch":{"type":"string"},"couponCode":{"type":"string"},"coupons":{"type":"string"},"merchantName":{"type":"string"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"stan":{"type":"string"},"terminalID":{"type":"string"}},"title":"Authorization"},"CancelRO":{"type":"object","properties":{"mobilePaymentData":{"$ref":"#/definitions/MobilePaymentData"},"requestData":{"$ref":"#/definitions/RequestData"}},"title":"CancelRO"},"CancelRequest":{"type":"object","properties":{"processInstanceId":{"type":"string"}},"title":"CancelRequest"},"CancelResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"CancelResponse"},"CardRegisterROReq":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"CardRegisterROReq"},"CardRegisterRORes":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"CardRegisterRORes"},"CardValue":{"type":"object","properties":{"cardCircuit":{"type":"string"},"cardEntryMode":{"type":"string"},"cardID":{"type":"string"},"inString":{"type":"string"},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"string"},"trackers":{"type":"array","items":{"$ref":"#/definitions/Tracker"}}},"title":"CardValue"},"CustomerData":{"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number"}},"title":"CustomerData"},"CustomerInfo":{"type":"object","properties":{"accountId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"identifierName":{"type":"string","enum":["cardnumber","email","externalId","mobile","wechat"]},"identifierValue":{"type":"string"},"source":{"type":"string"}},"title":"CustomerInfo"},"GetEntityResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"workflowMeta":{"type":"array","items":{"$ref":"#/definitions/OrgWorkflowMetaDto"}}},"title":"GetEntityResponse"},"LoyaltyDetails":{"type":"object","properties":{"loyaltyPAN":{"type":"string"},"loyaltyType":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"trackers":{"type":"array","items":{"$ref":"#/definitions/Tracker"}}},"title":"LoyaltyDetails"},"LoyaltyOffer":{"type":"object","properties":{"loyaltyOfferDescription":{"type":"string"},"loyaltyOfferID":{"type":"string"},"promotionType":{"type":"string","enum":["Cart","lineitem"]},"referenceID":{"type":"string"}},"title":"LoyaltyOffer"},"Message":{"type":"object","properties":{"cashierMessage":{"type":"string"}},"title":"Message"},"MobilePaymentData":{"type":"object","properties":{"acquirerID":{"type":"string"},"globalRetailSiteID":{"type":"string"},"loyaltyDetails":{"type":"array","items":{"$ref":"#/definitions/LoyaltyDetails"}},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"merchantID":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"paymentData":{"type":"string"},"paymentServiceProvider":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"}},"title":"MobilePaymentData"},"MobileResponseBody«CardRegisterRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CardRegisterRORes"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«CardRegisterRO»"},"MobileResponseBody«PreAuthorizeStep»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PreAuthorizeStep"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«PreAuthorizeStep»"},"MobileResponseBody«PumpReserve»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PumpReserve"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«PumpReserve»"},"MobileResponseBody«TokenizeRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/TokenizeRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«TokenizeRO»"},"OfferEvaluation":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucher"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosData"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestData"},"responseData":{"$ref":"#/definitions/ResponseData"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItem"}},"siteData":{"$ref":"#/definitions/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/definitions/Tender"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluation"},"OfferEvaluationReq":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucherReq"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosDataReq"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestDataReq"},"responseData":{"$ref":"#/definitions/ResponseDataReq"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItemReq"}},"siteData":{"$ref":"#/definitions/SiteDataReq"},"tenders":{"type":"array","items":{"$ref":"#/definitions/TenderReq"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluationReq"},"OfferEvaluationRes":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucherRes"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosDataRes"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestDataRes"},"responseData":{"$ref":"#/definitions/ResponseDataRes"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItemRes"}},"siteData":{"$ref":"#/definitions/SiteDataRes"},"tenders":{"type":"array","items":{"$ref":"#/definitions/TenderRes"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluationRes"},"OrgWorkflowMetaDto":{"type":"object","properties":{"autoUpdateTime":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"isApproved":{"type":"boolean"},"isAsync":{"type":"boolean"},"isDefault":{"type":"boolean"},"orgId":{"type":"integer","format":"int64"},"processId":{"type":"string"},"promotedOn":{"type":"string","format":"date-time"},"versionName":{"type":"string"},"workflowName":{"type":"string"}},"title":"OrgWorkflowMetaDto"},"OriginalTransaction":{"type":"object","properties":{"approvalCode":{"type":"string"},"authorizationToken":{"type":"string"},"stan":{"type":"string"},"terminalBatch":{"type":"string"},"terminalID":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}},"title":"OriginalTransaction"},"PerformanceBo":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"failurePercentage":{"type":"number"}},"title":"PerformanceBo"},"PosData":{"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosData"},"PosDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"clerkID":{"type":"string"},"originalSalePosTimeStamp":{"type":"string"},"posTimeStamp":{"type":"string","format":"date-time"},"pumpNumber":{"type":"string"},"terminalID":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosDataReq"},"PosDataRes":{"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosDataRes"},"PreAuthorizeStep":{"type":"object","properties":{"processInstanceId":{"type":"string"},"pspReferenceNumber":{"type":"string"}},"title":"PreAuthorizeStep"},"PredictedTender":{"type":"object","properties":{"acquire":{"type":"string"},"methodOfPayment":{"type":"string"},"subtractDiscountAmount":{"type":"boolean"}},"title":"PredictedTender"},"PriceAdjustment":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number"}},"title":"PriceAdjustment"},"PriceAdjustmentReq":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"netAmount":{"type":"number"},"originalAmount":{"type":"number"},"originalNetAmount":{"type":"number"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"productCode":{"type":"string"},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"taxSplit":{"type":"array","items":{"$ref":"#/definitions/TaxSplit"}},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vat":{"type":"number"}},"title":"PriceAdjustmentReq"},"PriceAdjustmentRes":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number"}},"title":"PriceAdjustmentRes"},"ProcessInstanceDetails":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"tillId":{"type":"integer","format":"int64"},"version":{"type":"string"},"workflowName":{"type":"string"}},"title":"ProcessInstanceDetails"},"Product":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"categoryCode":{"type":"string"},"productCode":{"type":"string"},"subCategoryCode":{"type":"string"}},"title":"Product"},"PumpReserve":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"languageCode":{"type":"string"},"loyaltyPan":{"type":"string"},"methodOfPaymentId":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"string"},"siteId":{"type":"string"}},"title":"PumpReserve"},"Receipt":{"type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}},"title":"Receipt"},"RequestData":{"type":"object","properties":{"cartEvaluationID":{"type":"string"},"payTokenID":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"RequestData"},"RequestDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"countryCode":{"type":"string"},"extCorrelationId":{"type":"string"},"payTokenID":{"type":"string"},"paymentServiceProvider":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"transactionNumber":{"type":"string"},"workstationID":{"type":"string"}},"title":"RequestDataReq"},"RequestDataRes":{"type":"object","properties":{"overallResult":{"type":"string"},"requestID":{"type":"string"}},"title":"RequestDataRes"},"ResponseData":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"ResponseData"},"ResponseDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"ResponseDataReq"},"ResponseDataRes":{"type":"object","properties":{"requestType":{"type":"string"}},"title":"ResponseDataRes"},"SaleItem":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustment"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItem"},"SaleItemReq":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"lineNo":{"type":"string"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"netAmount":{"type":"number"},"originalAmount":{"type":"number"},"originalNetAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustmentReq"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"string"},"saleItemType":{"type":"string"},"taxAmount":{"type":"number"},"taxCode":{"type":"string"},"taxRate":{"type":"number"},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItemReq"},"SaleItemRes":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustmentRes"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItemRes"},"SaleTransaction":{"type":"object","properties":{"authorization":{"$ref":"#/definitions/Authorization"},"coupons":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"currencyCode":{"type":"string"},"extraDiscountAmount":{"type":"number","format":"double"},"loyaltyPointAmount":{"type":"integer","format":"int32"},"merchantName":{"type":"string"},"netAmount":{"type":"number","format":"double"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"taxReferenceNumber":{"type":"string"},"timeStamp":{"type":"string"},"totalAmount":{"type":"number","format":"double"},"totalDiscountAmount":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"transactionNumber":{"type":"string"}},"title":"SaleTransaction"},"ShellTransactionResponse":{"type":"object","properties":{"requestData":{"$ref":"#/definitions/RequestDataRes"},"responseData":{"$ref":"#/definitions/ResponseDataRes"}},"title":"ShellTransactionResponse"},"SingleResponse«List«UserTransactionBo»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserTransactionBo"}},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«List«UserTransactionBo»»"},"SingleResponse«OfferEvaluation»":{"type":"object","properties":{"data":{"$ref":"#/definitions/OfferEvaluationRes"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«OfferEvaluation»"},"SingleResponse«TxnStatusBo»":{"type":"object","properties":{"data":{"$ref":"#/definitions/TxnStatusBo"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«TxnStatusBo»"},"SingleResponse«WorkFlowCreationResponse»":{"type":"object","properties":{"data":{"$ref":"#/definitions/WorkFlowCreationResponse"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«WorkFlowCreationResponse»"},"SiteData":{"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}},"title":"SiteData"},"SiteDataReq":{"type":"object","properties":{"countryCode":{"type":"string"},"siteId":{"type":"string"}},"title":"SiteDataReq"},"SiteDataRes":{"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}},"title":"SiteDataRes"},"StatResponse«Map«string,PerformanceBo»»":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/definitions/PerformanceBo"}},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"StatResponse«Map«string,PerformanceBo»»"},"StatusCode":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"isWarning":{"type":"boolean"},"message":{"type":"string"}},"title":"StatusCode"},"TaxSplit":{"type":"object","properties":{"additionalAmount":{"type":"number"},"amount":{"type":"number"},"code":{"type":"string"},"rate":{"type":"number"},"taxID":{"type":"integer","format":"int32"}},"title":"TaxSplit"},"Tender":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number"},"pointsRedeemed":{"type":"number"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRule"}}},"title":"Tender"},"TenderReq":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"string"},"netTenderAmount":{"type":"string"},"pointsRedeemed":{"type":"string"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"string"},"totalAmount":{"type":"string"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRuleReq"}}},"title":"TenderReq"},"TenderRes":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number"},"pointsRedeemed":{"type":"number"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRuleRes"}}},"title":"TenderRes"},"Terminal":{"type":"object","properties":{"stan":{"type":"string"},"terminalBatch":{"type":"string"}},"title":"Terminal"},"TokenizeRO":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"TokenizeRO"},"Tracker":{"type":"object","properties":{"trackerEarned":{"type":"string"},"trackerRedeemed":{"type":"string"},"trackerType":{"type":"string"},"trackerValue":{"type":"string"}},"title":"Tracker"},"TransactionAddRO":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucher"}},"cardValues":{"type":"array","items":{"$ref":"#/definitions/CardValue"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"mobilePaymentData":{"$ref":"#/definitions/MobilePaymentData"},"originalTransaction":{"$ref":"#/definitions/OriginalTransaction"},"posData":{"$ref":"#/definitions/PosData"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestData"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItem"}},"saleTransaction":{"$ref":"#/definitions/SaleTransaction"},"siteData":{"$ref":"#/definitions/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/definitions/Tender"}},"terminal":{"$ref":"#/definitions/Terminal"},"totalAmount":{"type":"number"}},"title":"TransactionAddRO"},"TransactionAddResponse":{"type":"object","properties":{"shellResponse":{"type":"array","items":{"$ref":"#/definitions/ShellTransactionResponse"}}},"title":"TransactionAddResponse"},"TxnStatusBo":{"type":"object","properties":{"currencyCode":{"type":"string"},"extCorrelationId":{"type":"string"},"finalStatus":{"type":"string"},"instanceVariables":{"type":"object"},"languageCode":{"type":"string"},"methodOfPaymentId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"status":{"type":"string"},"stepRequests":{"type":"object"},"workFlowDetails":{"$ref":"#/definitions/ProcessInstanceDetails"}},"title":"TxnStatusBo"},"UpdatedEntityResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"UpdatedEntityResponse"},"UserTransactionBo":{"type":"object","properties":{"extCorrelationId":{"type":"string"},"id":{"type":"integer","format":"int64"},"invoice":{"type":"string"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpId":{"type":"string"},"siteId":{"type":"string"},"startTimestamp":{"type":"string","format":"date-time"},"status":{"type":"string"},"type":{"type":"string"}},"title":"UserTransactionBo"},"Violation":{"type":"object","properties":{"fieldName":{"type":"string"},"invalidValue":{"type":"object"},"message":{"type":"string"}},"title":"Violation"},"VoucherCodesResult":{"type":"object","properties":{"actionCode":{"type":"integer","format":"int32"},"actionCodeDescription":{"type":"string"},"voucherCode":{"type":"string"}},"title":"VoucherCodesResult"},"VoucherRule":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRule"},"VoucherRuleReq":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"referenceId":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRuleReq"},"VoucherRuleRes":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRuleRes"},"WorkFlowCreationResponse":{"type":"object","properties":{"deploymentId":{"type":"string"},"version":{"type":"string"}},"title":"WorkFlowCreationResponse"},"WorkFlowPromote":{"type":"object","properties":{"version":{"type":"string"},"workFlowName":{"type":"string"}},"title":"WorkFlowPromote"},"WorkflowInputAction":{"type":"object","properties":{"actionGroupType":{"type":"string","enum":["PARALLEL","SERIAL","XOR"]},"delayTimeInRetrial":{"type":"integer","format":"int32"},"httpCallInputProperties":{"$ref":"#/definitions/ActionInput"},"httpCallInputPropertiesRollback":{"$ref":"#/definitions/ActionInput"},"isAsync":{"type":"boolean"},"name":{"type":"string"},"properties":{"type":"object"},"retrialCount":{"type":"integer","format":"int32"},"rollBackProperties":{"type":"object"},"serialNumber":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["CCCaptureAction","addTransactionAction","authorizePaymentWithPsp","confirmAuthWithPSPAction","eghlCapturePaymentAction","eghlTokenizationAction","emptyAction","generatePaymentIdAction","ifredeemPointsAction","invalid","oAuthHttpAction","offerEvaluationAction","redeemPointsAction","saveCCardAction"]}},"title":"WorkflowInputAction"},"WorkflowProcess":{"type":"object","properties":{"isAsync":{"type":"boolean"},"name":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/definitions/WorkflowStep"}}},"title":"WorkflowProcess"},"WorkflowStep":{"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/definitions/WorkflowInputAction"}},"maxWaitTimeInMillis":{"type":"integer","format":"int32"},"name":{"type":"string"},"serialNumber":{"type":"integer","format":"int32"}},"title":"WorkflowStep"},"_2c2pCallbackRequest":{"type":"object","properties":{"payload":{"type":"string"}},"title":"_2c2pCallbackRequest"}}} From a4ab5e2ffc99b0281380bcdf988b09b259a90141 Mon Sep 17 00:00:00 2001 From: Ankit Verma Date: Wed, 8 Jun 2022 13:21:39 +0530 Subject: [PATCH 141/150] Update orchestrator.json --- orchestrator.json | 4952 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 4951 insertions(+), 1 deletion(-) diff --git a/orchestrator.json b/orchestrator.json index 36d577f3f76..a1b6afbedc9 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -1 +1,4951 @@ -{"swagger":"2.0","info":{"description":"Potato OTA Transaction Orchestrator","version":"1.0","title":"POTATO","contact":{"name":"Capillary Technologies","url":"https://www.capillarytech.com"},"license":{}},"host":"orchestratoradmin.crm-nightly-new.cctools.capillarytech.com","basePath":"/","tags":[{"name":"_2c-2p-callback-resource","description":"_2c 2p Callback Resource"},{"name":"admin-workflow-resource","description":"Admin Workflow Resource"},{"name":"cancel-sandbox","description":"Cancel Sandbox"},{"name":"eghl-call-back-resource","description":"Eghl Call Back Resource"},{"name":"health-check-resource","description":"Health Check Resource"},{"name":"mobile-card-registration-resource","description":"Mobile Card Registration Resource"},{"name":"open-api-web-mvc-resource","description":"Open Api Web Mvc Resource"},{"name":"payments-resource","description":"Payments Resource"},{"name":"psp-callback-resource","description":"Psp Callback Resource"},{"name":"psp-performance-resource","description":"Psp Performance Resource"},{"name":"psp-reconciliation","description":"PSP Reconciliation"},{"name":"pump-life-cycle-resource","description":"Pump Life Cycle Resource"},{"name":"pump-performance-resource","description":"Pump Performance Resource"},{"name":"shell-server-to-server-resource","description":"Shell Server To Server Resource"},{"name":"swagger-config-resource","description":"Swagger Config Resource"},{"name":"test-fuelling-workflow-resource","description":"Test Fuelling Workflow Resource"},{"name":"transaction-status-resource","description":"Transaction Status Resource"},{"name":"txn-status-resource","description":"Txn Status Resource"}],"paths":{"/orchestrator/payments/app/pumpReserve/{version}":{"post":{"tags":["test-fuelling-workflow-resource"],"summary":"pumpReserveWithGivenVersion","operationId":"pumpReserveWithGivenVersionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"pumpReserve","description":"pumpReserve","required":true,"schema":{"$ref":"#/definitions/PumpReserve"}},{"name":"version","in":"path","description":"version","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PumpReserve»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/register-paymentIdV1":{"post":{"tags":["mobile-card-registration-resource"],"summary":"registerPaymentId","operationId":"registerPaymentIdUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cardRegisterRO","description":"cardRegisterRO","required":true,"schema":{"$ref":"#/definitions/CardRegisterROReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«CardRegisterRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/bank":{"get":{"tags":["psp-performance-resource"],"summary":"pspStat","operationId":"pspStatUsingGET","produces":["*/*"],"parameters":[{"name":"bankName","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"durationHours","in":"query","required":false,"type":"integer","format":"int32"},{"name":"psp","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatResponse«Map«string,PerformanceBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/failure-rate/pump":{"get":{"tags":["pump-performance-resource"],"summary":"pumpStat","operationId":"pumpStatUsingGET","produces":["*/*"],"parameters":[{"name":"durationHours","in":"query","required":false,"type":"integer","format":"int32"},{"name":"siteId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StatResponse«Map«string,PerformanceBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/fuelling-status":{"get":{"tags":["transaction-status-resource"],"summary":"status","operationId":"statusUsingGET","produces":["*/*"],"parameters":[{"name":"customerId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AppTransactionStatusResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-activate":{"post":{"tags":["pump-life-cycle-resource"],"summary":"activatePump","operationId":"activatePumpUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"preAuthorizeRequest","description":"preAuthorizeRequest","required":true,"schema":{"$ref":"#/definitions/PreAuthorizeStep"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PreAuthorizeStep»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-cancel":{"post":{"tags":["pump-life-cycle-resource"],"summary":"cancelPump","operationId":"cancelPumpUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cancelRequest","description":"cancelRequest","required":true,"schema":{"$ref":"#/definitions/CancelRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CancelResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/pump-reserve":{"post":{"tags":["pump-life-cycle-resource"],"summary":"pumpReserve","operationId":"pumpReserveUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"pumpReserve","description":"pumpReserve","required":true,"schema":{"$ref":"#/definitions/PumpReserve"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«PumpReserve»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/app/v1/register-paymentId":{"post":{"tags":["mobile-card-registration-resource"],"summary":"generatePaymentIdentifier","operationId":"generatePaymentIdentifierUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}":{"get":{"tags":["txn-status-resource"],"summary":"getStatusByPaymentId","operationId":"getStatusByPaymentIdUsingGET","produces":["*/*"],"parameters":[{"name":"paymentId","in":"path","description":"paymentId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«TxnStatusBo»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/intouch/txn-status/user-id/{userId}":{"get":{"tags":["txn-status-resource"],"summary":"OTATransactionsByUserId","operationId":"OTATransactionsByUserIdUsingGET","produces":["*/*"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«List«UserTransactionBo»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/cancel":{"post":{"tags":["cancel-sandbox"],"summary":"cancel","operationId":"cancelUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"cancelRO","description":"cancelRO","required":true,"schema":{"$ref":"#/definitions/CancelRO"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/finalize-txn":{"post":{"tags":["shell-server-to-server-resource"],"summary":"finalizeTransaction","operationId":"finalizeTransactionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"transactionAddRO","description":"transactionAddRO","required":true,"schema":{"$ref":"#/definitions/TransactionAddRO"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/v1/site/get-offers":{"post":{"tags":["shell-server-to-server-resource"],"summary":"offerEvaluation","operationId":"offerEvaluationUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"offerEvaluationReq","description":"offerEvaluationReq","required":true,"schema":{"$ref":"#/definitions/OfferEvaluation"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OfferEvaluation"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/fuelling-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"fuellingCallBack","operationId":"fuellingCallBackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/_2c2pCallbackRequest"}},{"name":"defaultCard","in":"query","required":false,"type":"boolean"},{"name":"extCorrelationID","in":"query","required":false,"type":"string"},{"name":"orgId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentProvider","in":"query","required":false,"type":"string"},{"name":"userId","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/2c2p/register-callback":{"post":{"tags":["_2c-2p-callback-resource"],"summary":"registerCallBack","operationId":"registerCallBackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callbackRequest","description":"callbackRequest","required":true,"schema":{"$ref":"#/definitions/_2c2pCallbackRequest"}},{"name":"defaultCard","in":"query","required":false,"type":"boolean"},{"name":"extCorrelationID","in":"query","required":false,"type":"string"},{"name":"orgId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"paymentProvider","in":"query","required":false,"type":"string"},{"name":"userId","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/callback":{"post":{"tags":["eghl-call-back-resource"],"summary":"saveToken","operationId":"saveTokenUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"processData","description":"processData","required":true,"schema":{"type":"string"}},{"name":"shouldSave","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/payment-identifier":{"post":{"tags":["eghl-call-back-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/orchestrator/payments/webhooks/eghl/transaction":{"post":{"tags":["eghl-call-back-resource"],"summary":"callback","operationId":"callbackUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"callBackData","description":"callBackData","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/ping":{"get":{"tags":["health-check-resource"],"summary":"application health check","operationId":"healthCheckUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/capture":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationCapture","operationId":"reconciliationCaptureUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/reconciliation/registration-reversal":{"post":{"tags":["psp-reconciliation"],"summary":"reconciliationRegistrationReversal","operationId":"reconciliationRegistrationReversalUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow":{"get":{"tags":["admin-workflow-resource"],"summary":"get","operationId":"getUsingGET","produces":["*/*"],"parameters":[{"name":"allVersions","in":"query","required":false,"type":"boolean"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"version","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GetEntityResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]},"post":{"tags":["admin-workflow-resource"],"summary":"create","operationId":"createUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"workflowProcess","description":"workflowProcess","required":true,"schema":{"$ref":"#/definitions/WorkflowProcess"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«WorkFlowCreationResponse»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/promotion":{"put":{"tags":["admin-workflow-resource"],"summary":"promoteWorkFlow","operationId":"promoteWorkFlowUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"workFlowPromote","description":"workFlowPromote","required":true,"schema":{"$ref":"#/definitions/WorkFlowPromote"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdatedEntityResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/psp/payment-identifier":{"post":{"tags":["psp-callback-resource"],"summary":"generateToken","operationId":"generateTokenUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"tokenizeRO","description":"tokenizeRO","required":true,"schema":{"$ref":"#/definitions/TokenizeRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MobileResponseBody«TokenizeRO»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/evaluateOffer":{"post":{"tags":["payments-resource"],"summary":"evaluateOffers","operationId":"evaluateOffersUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"completeRequest","description":"completeRequest","required":true,"schema":{"$ref":"#/definitions/OfferEvaluationReq"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SingleResponse«OfferEvaluation»"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v1/workflow/shell/billing/transactionAdd":{"post":{"tags":["payments-resource"],"summary":"txnAdd","operationId":"txnAddUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"transactionAddRO","description":"transactionAddRO","required":true,"schema":{"$ref":"#/definitions/TransactionAddRO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransactionAddResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs":{"get":{"tags":["open-api-web-mvc-resource"],"summary":"openapiJson","operationId":"openapiJsonUsingGET","produces":["application/json"],"parameters":[{"name":"apiDocsUrl","in":"query","description":"apiDocsUrl","required":false,"type":"string"},{"name":"country","in":"query","required":false,"type":"string"},{"name":"displayCountry","in":"query","required":false,"type":"string"},{"name":"displayLanguage","in":"query","required":false,"type":"string"},{"name":"displayName","in":"query","required":false,"type":"string"},{"name":"displayScript","in":"query","required":false,"type":"string"},{"name":"displayVariant","in":"query","required":false,"type":"string"},{"name":"extensionKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ISO3Country","in":"query","required":false,"type":"string"},{"name":"ISO3Language","in":"query","required":false,"type":"string"},{"name":"language","in":"query","required":false,"type":"string"},{"name":"script","in":"query","required":false,"type":"string"},{"name":"unicodeLocaleAttributes","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"unicodeLocaleKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"variant","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs.yaml":{"get":{"tags":["open-api-web-mvc-resource"],"summary":"openapiYaml","operationId":"openapiYamlUsingGET","produces":["application/vnd.oai.openapi"],"parameters":[{"name":"apiDocsUrl","in":"query","description":"apiDocsUrl","required":false,"type":"string"},{"name":"country","in":"query","required":false,"type":"string"},{"name":"displayCountry","in":"query","required":false,"type":"string"},{"name":"displayLanguage","in":"query","required":false,"type":"string"},{"name":"displayName","in":"query","required":false,"type":"string"},{"name":"displayScript","in":"query","required":false,"type":"string"},{"name":"displayVariant","in":"query","required":false,"type":"string"},{"name":"extensionKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ISO3Country","in":"query","required":false,"type":"string"},{"name":"ISO3Language","in":"query","required":false,"type":"string"},{"name":"language","in":"query","required":false,"type":"string"},{"name":"script","in":"query","required":false,"type":"string"},{"name":"unicodeLocaleAttributes","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"unicodeLocaleKeys","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"variant","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}},"/v3/api-docs/swagger-config":{"get":{"tags":["swagger-config-resource"],"summary":"openapiJson","operationId":"openapiJsonUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"X-CAP-API-AUTH-ORG-ID":["global"]},{"X-CAP-API-AUTH-ENTITY-ID":["global"]},{"X-CAP-ENTITY-CODE":["global"]},{"X-CAP-ENTITY-ID":["global"]}]}}},"securityDefinitions":{"X-CAP-API-AUTH-ENTITY-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ENTITY-ID","in":"header"},"X-CAP-API-AUTH-ORG-ID":{"type":"apiKey","name":"X-CAP-API-AUTH-ORG-ID","in":"header"},"X-CAP-ENTITY-CODE":{"type":"apiKey","name":"X-CAP-ENTITY-CODE","in":"header"},"X-CAP-ENTITY-ID":{"type":"apiKey","name":"X-CAP-ENTITY-ID","in":"header"}},"definitions":{"ActionInput":{"type":"object","properties":{"actionName":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"entityId":{"type":"integer","format":"int64"},"input":{"type":"object"},"orgId":{"type":"integer","format":"int64"},"processInstanceId":{"type":"string"},"version":{"type":"string"},"workFlowName":{"type":"string"}},"title":"ActionInput"},"AppTransactionStatusResponse":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"processInstanceId":{"type":"string"},"pumpNumber":{"type":"string"},"stationId":{"type":"string"},"transactionState":{"type":"string","enum":["BILL_GENERATED","FUELING_CANCELLED_BY_CUSTOMER","FUELING_CANCELLED_BY_STATION","PUMP_ACTIVATION_FAIL","PUMP_ACTIVATION_SUCCESS","PUMP_RESERVE_FAIL","PUMP_RESERVE_SUCCESS","TXN_STATE_UNKNOWN"]}},"title":"AppTransactionStatusResponse"},"ApplicableVoucher":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"ApplicableVoucher"},"ApplicableVoucherReq":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"string"}},"title":"ApplicableVoucherReq"},"ApplicableVoucherRes":{"type":"object","properties":{"additionVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"promotionType":{"type":"string"},"referenceID":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"ApplicableVoucherRes"},"Authorization":{"type":"object","properties":{"approvalCode":{"type":"string"},"batch":{"type":"string"},"couponCode":{"type":"string"},"coupons":{"type":"string"},"merchantName":{"type":"string"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"stan":{"type":"string"},"terminalID":{"type":"string"}},"title":"Authorization"},"CancelRO":{"type":"object","properties":{"mobilePaymentData":{"$ref":"#/definitions/MobilePaymentData"},"requestData":{"$ref":"#/definitions/RequestData"}},"title":"CancelRO"},"CancelRequest":{"type":"object","properties":{"processInstanceId":{"type":"string"}},"title":"CancelRequest"},"CancelResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"CancelResponse"},"CardRegisterROReq":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"CardRegisterROReq"},"CardRegisterRORes":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"CardRegisterRORes"},"CardValue":{"type":"object","properties":{"cardCircuit":{"type":"string"},"cardEntryMode":{"type":"string"},"cardID":{"type":"string"},"inString":{"type":"string"},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"string"},"trackers":{"type":"array","items":{"$ref":"#/definitions/Tracker"}}},"title":"CardValue"},"CustomerData":{"type":"object","properties":{"customerDataType":{"type":"string"},"customerDataValue":{"type":"string"},"loyaltyType":{"type":"string"},"pointsRedeemed":{"type":"number"}},"title":"CustomerData"},"CustomerInfo":{"type":"object","properties":{"accountId":{"type":"string"},"customerId":{"type":"integer","format":"int64"},"identifierName":{"type":"string","enum":["cardnumber","email","externalId","mobile","wechat"]},"identifierValue":{"type":"string"},"source":{"type":"string"}},"title":"CustomerInfo"},"GetEntityResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"workflowMeta":{"type":"array","items":{"$ref":"#/definitions/OrgWorkflowMetaDto"}}},"title":"GetEntityResponse"},"LoyaltyDetails":{"type":"object","properties":{"loyaltyPAN":{"type":"string"},"loyaltyType":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"pointsRedeemed":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"trackers":{"type":"array","items":{"$ref":"#/definitions/Tracker"}}},"title":"LoyaltyDetails"},"LoyaltyOffer":{"type":"object","properties":{"loyaltyOfferDescription":{"type":"string"},"loyaltyOfferID":{"type":"string"},"promotionType":{"type":"string","enum":["Cart","lineitem"]},"referenceID":{"type":"string"}},"title":"LoyaltyOffer"},"Message":{"type":"object","properties":{"cashierMessage":{"type":"string"}},"title":"Message"},"MobilePaymentData":{"type":"object","properties":{"acquirerID":{"type":"string"},"globalRetailSiteID":{"type":"string"},"loyaltyDetails":{"type":"array","items":{"$ref":"#/definitions/LoyaltyDetails"}},"loyaltyExceptionIndicator":{"type":"integer","format":"int32"},"merchantID":{"type":"string"},"methodOfPaymentID":{"type":"string"},"methodOfPaymentName":{"type":"string"},"paymentData":{"type":"string"},"paymentServiceProvider":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"}},"title":"MobilePaymentData"},"MobileResponseBody«CardRegisterRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/CardRegisterRORes"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«CardRegisterRO»"},"MobileResponseBody«PreAuthorizeStep»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PreAuthorizeStep"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«PreAuthorizeStep»"},"MobileResponseBody«PumpReserve»":{"type":"object","properties":{"data":{"$ref":"#/definitions/PumpReserve"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«PumpReserve»"},"MobileResponseBody«TokenizeRO»":{"type":"object","properties":{"data":{"$ref":"#/definitions/TokenizeRO"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processInstanceId":{"type":"string"},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"MobileResponseBody«TokenizeRO»"},"OfferEvaluation":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucher"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosData"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestData"},"responseData":{"$ref":"#/definitions/ResponseData"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItem"}},"siteData":{"$ref":"#/definitions/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/definitions/Tender"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluation"},"OfferEvaluationReq":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucherReq"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosDataReq"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestDataReq"},"responseData":{"$ref":"#/definitions/ResponseDataReq"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItemReq"}},"siteData":{"$ref":"#/definitions/SiteDataReq"},"tenders":{"type":"array","items":{"$ref":"#/definitions/TenderReq"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluationReq"},"OfferEvaluationRes":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucherRes"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"messages":{"$ref":"#/definitions/Message"},"posData":{"$ref":"#/definitions/PosDataRes"},"predictedTender":{"$ref":"#/definitions/PredictedTender"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestDataRes"},"responseData":{"$ref":"#/definitions/ResponseDataRes"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItemRes"}},"siteData":{"$ref":"#/definitions/SiteDataRes"},"tenders":{"type":"array","items":{"$ref":"#/definitions/TenderRes"}},"totalAmount":{"type":"number"},"voucherCodesResult":{"type":"array","items":{"$ref":"#/definitions/VoucherCodesResult"}}},"title":"OfferEvaluationRes"},"OrgWorkflowMetaDto":{"type":"object","properties":{"autoUpdateTime":{"type":"string","format":"date-time"},"createdBy":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"isActive":{"type":"boolean"},"isApproved":{"type":"boolean"},"isAsync":{"type":"boolean"},"isDefault":{"type":"boolean"},"orgId":{"type":"integer","format":"int64"},"processId":{"type":"string"},"promotedOn":{"type":"string","format":"date-time"},"versionName":{"type":"string"},"workflowName":{"type":"string"}},"title":"OrgWorkflowMetaDto"},"OriginalTransaction":{"type":"object","properties":{"approvalCode":{"type":"string"},"authorizationToken":{"type":"string"},"stan":{"type":"string"},"terminalBatch":{"type":"string"},"terminalID":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}},"title":"OriginalTransaction"},"PerformanceBo":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"failurePercentage":{"type":"number"}},"title":"PerformanceBo"},"PosData":{"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosData"},"PosDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"clerkID":{"type":"string"},"originalSalePosTimeStamp":{"type":"string"},"posTimeStamp":{"type":"string","format":"date-time"},"pumpNumber":{"type":"string"},"terminalID":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosDataReq"},"PosDataRes":{"type":"object","properties":{"languageCode":{"type":"string"},"posTimeStamp":{"type":"string"},"transactionNumber":{"type":"string"}},"title":"PosDataRes"},"PreAuthorizeStep":{"type":"object","properties":{"processInstanceId":{"type":"string"},"pspReferenceNumber":{"type":"string"}},"title":"PreAuthorizeStep"},"PredictedTender":{"type":"object","properties":{"acquire":{"type":"string"},"methodOfPayment":{"type":"string"},"subtractDiscountAmount":{"type":"boolean"}},"title":"PredictedTender"},"PriceAdjustment":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number"}},"title":"PriceAdjustment"},"PriceAdjustmentReq":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"netAmount":{"type":"number"},"originalAmount":{"type":"number"},"originalNetAmount":{"type":"number"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"productCode":{"type":"string"},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"taxSplit":{"type":"array","items":{"$ref":"#/definitions/TaxSplit"}},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vat":{"type":"number"}},"title":"PriceAdjustmentReq"},"PriceAdjustmentRes":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"loyaltyOfferID":{"type":"string"},"priceAdjustmentID":{"type":"string"},"priceAdjustmentType":{"type":"string","enum":["Coupon","Gift","Local Discount","Price Override","RealtimeOffer-A","RealtimeOffer-U","Voucher"]},"promotionType":{"type":"string"},"quantity":{"type":"number"},"reason":{"type":"string"},"referenceID":{"type":"string"},"unitPrice":{"type":"number"}},"title":"PriceAdjustmentRes"},"ProcessInstanceDetails":{"type":"object","properties":{"customerId":{"type":"integer","format":"int64"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"tillId":{"type":"integer","format":"int64"},"version":{"type":"string"},"workflowName":{"type":"string"}},"title":"ProcessInstanceDetails"},"Product":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"categoryCode":{"type":"string"},"productCode":{"type":"string"},"subCategoryCode":{"type":"string"}},"title":"Product"},"PumpReserve":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"languageCode":{"type":"string"},"loyaltyPan":{"type":"string"},"methodOfPaymentId":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"string"},"siteId":{"type":"string"}},"title":"PumpReserve"},"Receipt":{"type":"object","properties":{"receiptLines":{"type":"array","items":{"type":"string"}}},"title":"Receipt"},"RequestData":{"type":"object","properties":{"cartEvaluationID":{"type":"string"},"payTokenID":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"RequestData"},"RequestDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"countryCode":{"type":"string"},"extCorrelationId":{"type":"string"},"payTokenID":{"type":"string"},"paymentServiceProvider":{"type":"string"},"processInstanceId":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"transactionNumber":{"type":"string"},"workstationID":{"type":"string"}},"title":"RequestDataReq"},"RequestDataRes":{"type":"object","properties":{"overallResult":{"type":"string"},"requestID":{"type":"string"}},"title":"RequestDataRes"},"ResponseData":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"ResponseData"},"ResponseDataReq":{"type":"object","properties":{"actionCode":{"type":"string"},"actionCodeDescription":{"type":"string"},"cartEvaluationID":{"type":"string"},"overallResult":{"type":"string"},"referenceNumber":{"type":"string"},"requestID":{"type":"string"},"requestType":{"type":"string"},"workstationID":{"type":"string"}},"title":"ResponseDataReq"},"ResponseDataRes":{"type":"object","properties":{"requestType":{"type":"string"}},"title":"ResponseDataRes"},"SaleItem":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustment"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItem"},"SaleItemReq":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"lineNo":{"type":"string"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"netAmount":{"type":"number"},"originalAmount":{"type":"number"},"originalNetAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustmentReq"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"string"},"saleItemType":{"type":"string"},"taxAmount":{"type":"number"},"taxCode":{"type":"string"},"taxRate":{"type":"number"},"unitOfMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItemReq"},"SaleItemRes":{"type":"object","properties":{"additionalProductCode":{"type":"string"},"additionalProductInfo":{"type":"string"},"amount":{"type":"number"},"categoryCode":{"type":"string"},"itemID":{"type":"integer","format":"int32"},"loyaltyOffers":{"type":"array","items":{"$ref":"#/definitions/LoyaltyOffer"}},"markDownIndicator":{"type":"boolean"},"originalAmount":{"type":"number"},"priceAdjustments":{"type":"array","items":{"$ref":"#/definitions/PriceAdjustmentRes"}},"productCode":{"type":"string"},"quantity":{"type":"number"},"saleChannel":{"type":"integer","format":"int32"},"saleItemType":{"type":"string"},"subCategoryCode":{"type":"string"},"unitMeasure":{"type":"string"},"unitPrice":{"type":"number"},"vatRate":{"type":"number"}},"title":"SaleItemRes"},"SaleTransaction":{"type":"object","properties":{"authorization":{"$ref":"#/definitions/Authorization"},"coupons":{"type":"array","items":{"type":"string"}},"currency":{"type":"string"},"currencyCode":{"type":"string"},"extraDiscountAmount":{"type":"number","format":"double"},"loyaltyPointAmount":{"type":"integer","format":"int32"},"merchantName":{"type":"string"},"netAmount":{"type":"number","format":"double"},"siteAddress":{"type":"string"},"siteName":{"type":"string"},"taxReferenceNumber":{"type":"string"},"timeStamp":{"type":"string"},"totalAmount":{"type":"number","format":"double"},"totalDiscountAmount":{"type":"number","format":"double"},"totalTaxAmount":{"type":"number","format":"double"},"transactionNumber":{"type":"string"}},"title":"SaleTransaction"},"ShellTransactionResponse":{"type":"object","properties":{"requestData":{"$ref":"#/definitions/RequestDataRes"},"responseData":{"$ref":"#/definitions/ResponseDataRes"}},"title":"ShellTransactionResponse"},"SingleResponse«List«UserTransactionBo»»":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserTransactionBo"}},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«List«UserTransactionBo»»"},"SingleResponse«OfferEvaluation»":{"type":"object","properties":{"data":{"$ref":"#/definitions/OfferEvaluationRes"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«OfferEvaluation»"},"SingleResponse«TxnStatusBo»":{"type":"object","properties":{"data":{"$ref":"#/definitions/TxnStatusBo"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«TxnStatusBo»"},"SingleResponse«WorkFlowCreationResponse»":{"type":"object","properties":{"data":{"$ref":"#/definitions/WorkFlowCreationResponse"},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"processId":{"type":"string"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"SingleResponse«WorkFlowCreationResponse»"},"SiteData":{"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}},"title":"SiteData"},"SiteDataReq":{"type":"object","properties":{"countryCode":{"type":"string"},"siteId":{"type":"string"}},"title":"SiteDataReq"},"SiteDataRes":{"type":"object","properties":{"countryCode":{"type":"string"},"siteID":{"type":"string"}},"title":"SiteDataRes"},"StatResponse«Map«string,PerformanceBo»»":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/definitions/PerformanceBo"}},"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"StatResponse«Map«string,PerformanceBo»»"},"StatusCode":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"isWarning":{"type":"boolean"},"message":{"type":"string"}},"title":"StatusCode"},"TaxSplit":{"type":"object","properties":{"additionalAmount":{"type":"number"},"amount":{"type":"number"},"code":{"type":"string"},"rate":{"type":"number"},"taxID":{"type":"integer","format":"int32"}},"title":"TaxSplit"},"Tender":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number"},"pointsRedeemed":{"type":"number"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRule"}}},"title":"Tender"},"TenderReq":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"string"},"netTenderAmount":{"type":"string"},"pointsRedeemed":{"type":"string"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"string"},"totalAmount":{"type":"string"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRuleReq"}}},"title":"TenderReq"},"TenderRes":{"type":"object","properties":{"acquirerID":{"type":"string"},"methodOfPayment":{"type":"string"},"methodOfPaymentID":{"type":"integer","format":"int32"},"netTenderAmount":{"type":"number"},"pointsRedeemed":{"type":"number"},"substractDiscountAmount":{"type":"boolean"},"tenderID":{"type":"integer","format":"int32"},"totalAmount":{"type":"number"},"voucherRules":{"type":"array","items":{"$ref":"#/definitions/VoucherRuleRes"}}},"title":"TenderRes"},"Terminal":{"type":"object","properties":{"stan":{"type":"string"},"terminalBatch":{"type":"string"}},"title":"Terminal"},"TokenizeRO":{"type":"object","properties":{"currencyCode":{"type":"string"},"customerInfo":{"$ref":"#/definitions/CustomerInfo"},"loyaltyPan":{"type":"string"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"registrationAmount":{"type":"string"}},"title":"TokenizeRO"},"Tracker":{"type":"object","properties":{"trackerEarned":{"type":"string"},"trackerRedeemed":{"type":"string"},"trackerType":{"type":"string"},"trackerValue":{"type":"string"}},"title":"Tracker"},"TransactionAddRO":{"type":"object","properties":{"applicableVouchers":{"type":"array","items":{"$ref":"#/definitions/ApplicableVoucher"}},"cardValues":{"type":"array","items":{"$ref":"#/definitions/CardValue"}},"customerData":{"type":"array","items":{"$ref":"#/definitions/CustomerData"}},"mobilePaymentData":{"$ref":"#/definitions/MobilePaymentData"},"originalTransaction":{"$ref":"#/definitions/OriginalTransaction"},"posData":{"$ref":"#/definitions/PosData"},"receipt":{"$ref":"#/definitions/Receipt"},"requestData":{"$ref":"#/definitions/RequestData"},"saleItems":{"type":"array","items":{"$ref":"#/definitions/SaleItem"}},"saleTransaction":{"$ref":"#/definitions/SaleTransaction"},"siteData":{"$ref":"#/definitions/SiteData"},"tenders":{"type":"array","items":{"$ref":"#/definitions/Tender"}},"terminal":{"$ref":"#/definitions/Terminal"},"totalAmount":{"type":"number"}},"title":"TransactionAddRO"},"TransactionAddResponse":{"type":"object","properties":{"shellResponse":{"type":"array","items":{"$ref":"#/definitions/ShellTransactionResponse"}}},"title":"TransactionAddResponse"},"TxnStatusBo":{"type":"object","properties":{"currencyCode":{"type":"string"},"extCorrelationId":{"type":"string"},"finalStatus":{"type":"string"},"instanceVariables":{"type":"object"},"languageCode":{"type":"string"},"methodOfPaymentId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"paymentId":{"type":"string"},"paymentProviderName":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpNumber":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"status":{"type":"string"},"stepRequests":{"type":"object"},"workFlowDetails":{"$ref":"#/definitions/ProcessInstanceDetails"}},"title":"TxnStatusBo"},"UpdatedEntityResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}},"success":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/definitions/Violation"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/StatusCode"}}},"title":"UpdatedEntityResponse"},"UserTransactionBo":{"type":"object","properties":{"extCorrelationId":{"type":"string"},"id":{"type":"integer","format":"int64"},"invoice":{"type":"string"},"paymentId":{"type":"string"},"preAuthAmount":{"type":"string"},"pumpId":{"type":"string"},"siteId":{"type":"string"},"startTimestamp":{"type":"string","format":"date-time"},"status":{"type":"string"},"type":{"type":"string"}},"title":"UserTransactionBo"},"Violation":{"type":"object","properties":{"fieldName":{"type":"string"},"invalidValue":{"type":"object"},"message":{"type":"string"}},"title":"Violation"},"VoucherCodesResult":{"type":"object","properties":{"actionCode":{"type":"integer","format":"int32"},"actionCodeDescription":{"type":"string"},"voucherCode":{"type":"string"}},"title":"VoucherCodesResult"},"VoucherRule":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRule"},"VoucherRuleReq":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"referenceId":{"type":"string"},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRuleReq"},"VoucherRuleRes":{"type":"object","properties":{"additionalVoucherInfo":{"type":"string"},"expiryDate":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/definitions/Product"}},"voucherCode":{"type":"string"},"voucherType":{"type":"string"},"voucherValue":{"type":"number"}},"title":"VoucherRuleRes"},"WorkFlowCreationResponse":{"type":"object","properties":{"deploymentId":{"type":"string"},"version":{"type":"string"}},"title":"WorkFlowCreationResponse"},"WorkFlowPromote":{"type":"object","properties":{"version":{"type":"string"},"workFlowName":{"type":"string"}},"title":"WorkFlowPromote"},"WorkflowInputAction":{"type":"object","properties":{"actionGroupType":{"type":"string","enum":["PARALLEL","SERIAL","XOR"]},"delayTimeInRetrial":{"type":"integer","format":"int32"},"httpCallInputProperties":{"$ref":"#/definitions/ActionInput"},"httpCallInputPropertiesRollback":{"$ref":"#/definitions/ActionInput"},"isAsync":{"type":"boolean"},"name":{"type":"string"},"properties":{"type":"object"},"retrialCount":{"type":"integer","format":"int32"},"rollBackProperties":{"type":"object"},"serialNumber":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["CCCaptureAction","addTransactionAction","authorizePaymentWithPsp","confirmAuthWithPSPAction","eghlCapturePaymentAction","eghlTokenizationAction","emptyAction","generatePaymentIdAction","ifredeemPointsAction","invalid","oAuthHttpAction","offerEvaluationAction","redeemPointsAction","saveCCardAction"]}},"title":"WorkflowInputAction"},"WorkflowProcess":{"type":"object","properties":{"isAsync":{"type":"boolean"},"name":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/definitions/WorkflowStep"}}},"title":"WorkflowProcess"},"WorkflowStep":{"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"#/definitions/WorkflowInputAction"}},"maxWaitTimeInMillis":{"type":"integer","format":"int32"},"name":{"type":"string"},"serialNumber":{"type":"integer","format":"int32"}},"title":"WorkflowStep"},"_2c2pCallbackRequest":{"type":"object","properties":{"payload":{"type":"string"}},"title":"_2c2pCallbackRequest"}}} +{ + "swagger": "2.0", + "info": { + "description": "Potato OTA Transaction Orchestrator", + "version": "1.0", + "title": "POTATO", + "contact": { + "name": "Capillary Technologies", + "url": "https://www.capillarytech.com" + }, + "license": {} + }, + "host": "localhost:8100", + "basePath": "/", + "tags": [ + { + "name": "_2c-2p-callback-resource", + "description": "_2c 2p Callback Resource" + }, + { + "name": "admin-workflow-resource", + "description": "Admin Workflow Resource" + }, + { + "name": "cancel-sandbox", + "description": "Cancel Sandbox" + }, + { + "name": "eghl-call-back-resource", + "description": "Eghl Call Back Resource" + }, + { + "name": "health-check-resource", + "description": "Health Check Resource" + }, + { + "name": "mobile-card-registration-resource", + "description": "Mobile Card Registration Resource" + }, + { + "name": "open-api-web-mvc-resource", + "description": "Open Api Web Mvc Resource" + }, + { + "name": "payments-resource", + "description": "Payments Resource" + }, + { + "name": "psp-callback-resource", + "description": "Psp Callback Resource" + }, + { + "name": "psp-performance-resource", + "description": "Psp Performance Resource" + }, + { + "name": "psp-reconciliation", + "description": "PSP Reconciliation" + }, + { + "name": "pump-life-cycle-resource", + "description": "Pump Life Cycle Resource" + }, + { + "name": "pump-performance-resource", + "description": "Pump Performance Resource" + }, + { + "name": "shell-server-to-server-resource", + "description": "Shell Server To Server Resource" + }, + { + "name": "swagger-config-resource", + "description": "Swagger Config Resource" + }, + { + "name": "test-fuelling-workflow-resource", + "description": "Test Fuelling Workflow Resource" + }, + { + "name": "transaction-status-resource", + "description": "Transaction Status Resource" + }, + { + "name": "txn-status-resource", + "description": "Txn Status Resource" + } + ], + "paths": { + "/orchestrator/payments/app/pumpReserve/{version}": { + "post": { + "tags": [ + "test-fuelling-workflow-resource" + ], + "summary": "pumpReserveWithGivenVersion", + "operationId": "pumpReserveWithGivenVersionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "pumpReserve", + "description": "pumpReserve", + "required": true, + "schema": { + "$ref": "#/definitions/PumpReserve" + } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PumpReserve»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/register-paymentIdV1": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "registerPaymentId", + "operationId": "registerPaymentIdUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cardRegisterRO", + "description": "cardRegisterRO", + "required": true, + "schema": { + "$ref": "#/definitions/CardRegisterROReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«CardRegisterRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/failure-rate/bank": { + "get": { + "tags": [ + "psp-performance-resource" + ], + "summary": "pspStat", + "operationId": "pspStatUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "bankName", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "durationHours", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "psp", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/failure-rate/pump": { + "get": { + "tags": [ + "pump-performance-resource" + ], + "summary": "pumpStat", + "operationId": "pumpStatUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "durationHours", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "siteId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StatResponse«Map«string,PerformanceBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/fuelling-status": { + "get": { + "tags": [ + "transaction-status-resource" + ], + "summary": "status", + "operationId": "statusUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "customerId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AppTransactionStatusResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-activate": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "activatePump", + "operationId": "activatePumpUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "preAuthorizeRequest", + "description": "preAuthorizeRequest", + "required": true, + "schema": { + "$ref": "#/definitions/PreAuthorizeStep" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PreAuthorizeStep»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-cancel": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "cancelPump", + "operationId": "cancelPumpUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cancelRequest", + "description": "cancelRequest", + "required": true, + "schema": { + "$ref": "#/definitions/CancelRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CancelResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/pump-reserve": { + "post": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "pumpReserve", + "operationId": "pumpReserveUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "pumpReserve", + "description": "pumpReserve", + "required": true, + "schema": { + "$ref": "#/definitions/PumpReserve" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«PumpReserve»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app/v1/register-paymentId": { + "post": { + "tags": [ + "mobile-card-registration-resource" + ], + "summary": "generatePaymentIdentifier", + "operationId": "generatePaymentIdentifierUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/intouch/txn-status/payment-id/{paymentId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "getStatusByPaymentId", + "operationId": "getStatusByPaymentIdUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "paymentId", + "in": "path", + "description": "paymentId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«TxnStatusBo»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/intouch/txn-status/user-id/{userId}": { + "get": { + "tags": [ + "txn-status-resource" + ], + "summary": "OTATransactionsByUserId", + "operationId": "OTATransactionsByUserIdUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "userId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«List«UserTransactionBo»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/cancel": { + "post": { + "tags": [ + "cancel-sandbox" + ], + "summary": "cancel", + "operationId": "cancelUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "cancelRO", + "description": "cancelRO", + "required": true, + "schema": { + "$ref": "#/definitions/CancelRO" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/finalize-txn": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "finalizeTransaction", + "operationId": "finalizeTransactionUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "transactionAddRO", + "description": "transactionAddRO", + "required": true, + "schema": { + "$ref": "#/definitions/TransactionAddRO" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/v1/site/get-offers": { + "post": { + "tags": [ + "shell-server-to-server-resource" + ], + "summary": "offerEvaluation", + "operationId": "offerEvaluationUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "offerEvaluationReq", + "description": "offerEvaluationReq", + "required": true, + "schema": { + "$ref": "#/definitions/OfferEvaluation" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferEvaluation" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/2c2p/fuelling-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "fuellingCallBack", + "operationId": "fuellingCallBackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callbackRequest", + "description": "callbackRequest", + "required": true, + "schema": { + "$ref": "#/definitions/_2c2pCallbackRequest" + } + }, + { + "name": "defaultCard", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "orgId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "userId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/2c2p/register-callback": { + "post": { + "tags": [ + "_2c-2p-callback-resource" + ], + "summary": "registerCallBack", + "operationId": "registerCallBackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callbackRequest", + "description": "callbackRequest", + "required": true, + "schema": { + "$ref": "#/definitions/_2c2pCallbackRequest" + } + }, + { + "name": "defaultCard", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extCorrelationID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "orgId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "paymentProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "userId", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/callback": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "saveToken", + "operationId": "saveTokenUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "processData", + "description": "processData", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "shouldSave", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/payment-identifier": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/webhooks/eghl/transaction": { + "post": { + "tags": [ + "eghl-call-back-resource" + ], + "summary": "callback", + "operationId": "callbackUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "callBackData", + "description": "callBackData", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/ping": { + "get": { + "tags": [ + "health-check-resource" + ], + "summary": "application health check", + "operationId": "healthCheckUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/reconciliation/capture": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationCapture", + "operationId": "reconciliationCaptureUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/reconciliation/registration-reversal": { + "post": { + "tags": [ + "psp-reconciliation" + ], + "summary": "reconciliationRegistrationReversal", + "operationId": "reconciliationRegistrationReversalUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow": { + "get": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "get", + "operationId": "getUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "allVersions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetEntityResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + }, + "post": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "create", + "operationId": "createUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "workflowProcess", + "description": "workflowProcess", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowProcess" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«WorkFlowCreationResponse»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/promotion": { + "put": { + "tags": [ + "admin-workflow-resource" + ], + "summary": "promoteWorkFlow", + "operationId": "promoteWorkFlowUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "workFlowPromote", + "description": "workFlowPromote", + "required": true, + "schema": { + "$ref": "#/definitions/WorkFlowPromote" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdatedEntityResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/psp/payment-identifier": { + "post": { + "tags": [ + "psp-callback-resource" + ], + "summary": "generateToken", + "operationId": "generateTokenUsingPOST_1", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRO", + "description": "tokenizeRO", + "required": true, + "schema": { + "$ref": "#/definitions/TokenizeRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/shell/billing/evaluateOffer": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "evaluateOffers", + "operationId": "evaluateOffersUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "completeRequest", + "description": "completeRequest", + "required": true, + "schema": { + "$ref": "#/definitions/OfferEvaluationReq" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SingleResponse«OfferEvaluation»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v1/workflow/shell/billing/transactionAdd": { + "post": { + "tags": [ + "payments-resource" + ], + "summary": "txnAdd", + "operationId": "txnAddUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "transactionAddRO", + "description": "transactionAddRO", + "required": true, + "schema": { + "$ref": "#/definitions/TransactionAddRO" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransactionAddResponse" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v3/api-docs": { + "get": { + "tags": [ + "open-api-web-mvc-resource" + ], + "summary": "openapiJson", + "operationId": "openapiJsonUsingGET", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "apiDocsUrl", + "in": "query", + "description": "apiDocsUrl", + "required": false, + "type": "string" + }, + { + "name": "country", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayCountry", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayLanguage", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayScript", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayVariant", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "extensionKeys", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "ISO3Country", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ISO3Language", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "script", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "unicodeLocaleAttributes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "unicodeLocaleKeys", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "variant", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v3/api-docs.yaml": { + "get": { + "tags": [ + "open-api-web-mvc-resource" + ], + "summary": "openapiYaml", + "operationId": "openapiYamlUsingGET", + "produces": [ + "application/vnd.oai.openapi" + ], + "parameters": [ + { + "name": "apiDocsUrl", + "in": "query", + "description": "apiDocsUrl", + "required": false, + "type": "string" + }, + { + "name": "country", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayCountry", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayLanguage", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayScript", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayVariant", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "extensionKeys", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "ISO3Country", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ISO3Language", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "script", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "unicodeLocaleAttributes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "unicodeLocaleKeys", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "variant", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/v3/api-docs/swagger-config": { + "get": { + "tags": [ + "swagger-config-resource" + ], + "summary": "openapiJson", + "operationId": "openapiJsonUsingGET_1", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + } + }, + "securityDefinitions": { + "X-CAP-API-AUTH-ENTITY-ID": { + "type": "apiKey", + "name": "X-CAP-API-AUTH-ENTITY-ID", + "in": "header" + }, + "X-CAP-API-AUTH-ORG-ID": { + "type": "apiKey", + "name": "X-CAP-API-AUTH-ORG-ID", + "in": "header" + }, + "X-CAP-ENTITY-CODE": { + "type": "apiKey", + "name": "X-CAP-ENTITY-CODE", + "in": "header" + }, + "X-CAP-ENTITY-ID": { + "type": "apiKey", + "name": "X-CAP-ENTITY-ID", + "in": "header" + } + }, + "definitions": { + "ActionInput": { + "type": "object", + "properties": { + "actionName": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "entityId": { + "type": "integer", + "format": "int64" + }, + "input": { + "type": "object" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processInstanceId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + }, + "title": "ActionInput" + }, + "AppTransactionStatusResponse": { + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "stationId": { + "type": "string" + }, + "transactionState": { + "type": "string", + "enum": [ + "BILL_GENERATED", + "FUELING_CANCELLED_BY_CUSTOMER", + "FUELING_CANCELLED_BY_STATION", + "PUMP_ACTIVATION_FAIL", + "PUMP_ACTIVATION_SUCCESS", + "PUMP_RESERVE_FAIL", + "PUMP_RESERVE_SUCCESS", + "TXN_STATE_UNKNOWN" + ] + } + }, + "title": "AppTransactionStatusResponse" + }, + "ApplicableVoucher": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "ApplicableVoucher" + }, + "ApplicableVoucherReq": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "string" + } + }, + "title": "ApplicableVoucherReq" + }, + "ApplicableVoucherRes": { + "type": "object", + "properties": { + "additionVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "ApplicableVoucherRes" + }, + "Authorization": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "batch": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "coupons": { + "type": "string" + }, + "merchantName": { + "type": "string" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalID": { + "type": "string" + } + }, + "title": "Authorization" + }, + "CancelRO": { + "type": "object", + "properties": { + "mobilePaymentData": { + "$ref": "#/definitions/MobilePaymentData" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + } + }, + "title": "CancelRO" + }, + "CancelRequest": { + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + } + }, + "title": "CancelRequest" + }, + "CancelResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "CancelResponse" + }, + "CardRegisterROReq": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "CardRegisterROReq" + }, + "CardRegisterRORes": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "CardRegisterRORes" + }, + "CardValue": { + "type": "object", + "properties": { + "cardCircuit": { + "type": "string" + }, + "cardEntryMode": { + "type": "string" + }, + "cardID": { + "type": "string" + }, + "inString": { + "type": "string" + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "string" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tracker" + } + } + }, + "title": "CardValue" + }, + "CustomerData": { + "type": "object", + "properties": { + "customerDataType": { + "type": "string" + }, + "customerDataValue": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "pointsRedeemed": { + "type": "number" + } + }, + "title": "CustomerData" + }, + "CustomerInfo": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "customerId": { + "type": "integer", + "format": "int64" + }, + "identifierName": { + "type": "string", + "enum": [ + "cardnumber", + "email", + "externalId", + "mobile", + "wechat" + ] + }, + "identifierValue": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "title": "CustomerInfo" + }, + "GetEntityResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "workflowMeta": { + "type": "array", + "items": { + "$ref": "#/definitions/OrgWorkflowMetaDto" + } + } + }, + "title": "GetEntityResponse" + }, + "LoyaltyDetails": { + "type": "object", + "properties": { + "loyaltyPAN": { + "type": "string" + }, + "loyaltyType": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "pointsRedeemed": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "trackers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tracker" + } + } + }, + "title": "LoyaltyDetails" + }, + "LoyaltyOffer": { + "type": "object", + "properties": { + "loyaltyOfferDescription": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "promotionType": { + "type": "string", + "enum": [ + "Cart", + "lineitem" + ] + }, + "referenceID": { + "type": "string" + } + }, + "title": "LoyaltyOffer" + }, + "Message": { + "type": "object", + "properties": { + "cashierMessage": { + "type": "string" + } + }, + "title": "Message" + }, + "MobilePaymentData": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "globalRetailSiteID": { + "type": "string" + }, + "loyaltyDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyDetails" + } + }, + "loyaltyExceptionIndicator": { + "type": "integer", + "format": "int32" + }, + "merchantID": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "methodOfPaymentName": { + "type": "string" + }, + "paymentData": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + } + }, + "title": "MobilePaymentData" + }, + "MobileResponseBody«CardRegisterRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/CardRegisterRORes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«CardRegisterRO»" + }, + "MobileResponseBody«PreAuthorizeStep»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PreAuthorizeStep" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«PreAuthorizeStep»" + }, + "MobileResponseBody«PumpReserve»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/PumpReserve" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«PumpReserve»" + }, + "MobileResponseBody«TokenizeRO»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/TokenizeRO" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processInstanceId": { + "type": "string" + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "MobileResponseBody«TokenizeRO»" + }, + "OfferEvaluation": { + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucher" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosData" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + }, + "responseData": { + "$ref": "#/definitions/ResponseData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItem" + } + }, + "siteData": { + "$ref": "#/definitions/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/Tender" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluation" + }, + "OfferEvaluationReq": { + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucherReq" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosDataReq" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestDataReq" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataReq" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItemReq" + } + }, + "siteData": { + "$ref": "#/definitions/SiteDataReq" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/TenderReq" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluationReq" + }, + "OfferEvaluationRes": { + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucherRes" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "messages": { + "$ref": "#/definitions/Message" + }, + "posData": { + "$ref": "#/definitions/PosDataRes" + }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestDataRes" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataRes" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItemRes" + } + }, + "siteData": { + "$ref": "#/definitions/SiteDataRes" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/TenderRes" + } + }, + "totalAmount": { + "type": "number" + }, + "voucherCodesResult": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherCodesResult" + } + } + }, + "title": "OfferEvaluationRes" + }, + "OrgWorkflowMetaDto": { + "type": "object", + "properties": { + "autoUpdateTime": { + "type": "string", + "format": "date-time" + }, + "createdBy": { + "type": "integer", + "format": "int64" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "isActive": { + "type": "boolean" + }, + "isApproved": { + "type": "boolean" + }, + "isAsync": { + "type": "boolean" + }, + "isDefault": { + "type": "boolean" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "processId": { + "type": "string" + }, + "promotedOn": { + "type": "string", + "format": "date-time" + }, + "versionName": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "title": "OrgWorkflowMetaDto" + }, + "OriginalTransaction": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string" + }, + "authorizationToken": { + "type": "string" + }, + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "timeStamp": { + "type": "string", + "format": "date-time" + } + }, + "title": "OriginalTransaction" + }, + "PerformanceBo": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int64" + }, + "failurePercentage": { + "type": "number" + } + }, + "title": "PerformanceBo" + }, + "PosData": { + "type": "object", + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosData" + }, + "PosDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "clerkID": { + "type": "string" + }, + "originalSalePosTimeStamp": { + "type": "string" + }, + "posTimeStamp": { + "type": "string", + "format": "date-time" + }, + "pumpNumber": { + "type": "string" + }, + "terminalID": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosDataReq" + }, + "PosDataRes": { + "type": "object", + "properties": { + "languageCode": { + "type": "string" + }, + "posTimeStamp": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "PosDataRes" + }, + "PreAuthorizeStep": { + "type": "object", + "properties": { + "processInstanceId": { + "type": "string" + }, + "pspReferenceNumber": { + "type": "string" + } + }, + "title": "PreAuthorizeStep" + }, + "PredictedTender": { + "type": "object", + "properties": { + "acquire": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "subtractDiscountAmount": { + "type": "boolean" + } + }, + "title": "PredictedTender" + }, + "PriceAdjustment": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number" + } + }, + "title": "PriceAdjustment" + }, + "PriceAdjustmentReq": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "netAmount": { + "type": "number" + }, + "originalAmount": { + "type": "number" + }, + "originalNetAmount": { + "type": "number" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "productCode": { + "type": "string" + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "taxSplit": { + "type": "array", + "items": { + "$ref": "#/definitions/TaxSplit" + } + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vat": { + "type": "number" + } + }, + "title": "PriceAdjustmentReq" + }, + "PriceAdjustmentRes": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "loyaltyOfferID": { + "type": "string" + }, + "priceAdjustmentID": { + "type": "string" + }, + "priceAdjustmentType": { + "type": "string", + "enum": [ + "Coupon", + "Gift", + "Local Discount", + "Price Override", + "RealtimeOffer-A", + "RealtimeOffer-U", + "Voucher" + ] + }, + "promotionType": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "reason": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, + "unitPrice": { + "type": "number" + } + }, + "title": "PriceAdjustmentRes" + }, + "ProcessInstanceDetails": { + "type": "object", + "properties": { + "customerId": { + "type": "integer", + "format": "int64" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "tillId": { + "type": "integer", + "format": "int64" + }, + "version": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "title": "ProcessInstanceDetails" + }, + "Product": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "categoryCode": { + "type": "string" + }, + "productCode": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + } + }, + "title": "Product" + }, + "PumpReserve": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "languageCode": { + "type": "string" + }, + "loyaltyPan": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "string" + }, + "siteId": { + "type": "string" + } + }, + "title": "PumpReserve" + }, + "Receipt": { + "type": "object", + "properties": { + "receiptLines": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "Receipt" + }, + "RequestData": { + "type": "object", + "properties": { + "cartEvaluationID": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "RequestData" + }, + "RequestDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "countryCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "payTokenID": { + "type": "string" + }, + "paymentServiceProvider": { + "type": "string" + }, + "processInstanceId": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "transactionNumber": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "RequestDataReq" + }, + "RequestDataRes": { + "type": "object", + "properties": { + "overallResult": { + "type": "string" + }, + "requestID": { + "type": "string" + } + }, + "title": "RequestDataRes" + }, + "ResponseData": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "ResponseData" + }, + "ResponseDataReq": { + "type": "object", + "properties": { + "actionCode": { + "type": "string" + }, + "actionCodeDescription": { + "type": "string" + }, + "cartEvaluationID": { + "type": "string" + }, + "overallResult": { + "type": "string" + }, + "referenceNumber": { + "type": "string" + }, + "requestID": { + "type": "string" + }, + "requestType": { + "type": "string" + }, + "workstationID": { + "type": "string" + } + }, + "title": "ResponseDataReq" + }, + "ResponseDataRes": { + "type": "object", + "properties": { + "requestType": { + "type": "string" + } + }, + "title": "ResponseDataRes" + }, + "SaleItem": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustment" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItem" + }, + "SaleItemReq": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "lineNo": { + "type": "string" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "netAmount": { + "type": "number" + }, + "originalAmount": { + "type": "number" + }, + "originalNetAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustmentReq" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "string" + }, + "saleItemType": { + "type": "string" + }, + "taxAmount": { + "type": "number" + }, + "taxCode": { + "type": "string" + }, + "taxRate": { + "type": "number" + }, + "unitOfMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItemReq" + }, + "SaleItemRes": { + "type": "object", + "properties": { + "additionalProductCode": { + "type": "string" + }, + "additionalProductInfo": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "categoryCode": { + "type": "string" + }, + "itemID": { + "type": "integer", + "format": "int32" + }, + "loyaltyOffers": { + "type": "array", + "items": { + "$ref": "#/definitions/LoyaltyOffer" + } + }, + "markDownIndicator": { + "type": "boolean" + }, + "originalAmount": { + "type": "number" + }, + "priceAdjustments": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceAdjustmentRes" + } + }, + "productCode": { + "type": "string" + }, + "quantity": { + "type": "number" + }, + "saleChannel": { + "type": "integer", + "format": "int32" + }, + "saleItemType": { + "type": "string" + }, + "subCategoryCode": { + "type": "string" + }, + "unitMeasure": { + "type": "string" + }, + "unitPrice": { + "type": "number" + }, + "vatRate": { + "type": "number" + } + }, + "title": "SaleItemRes" + }, + "SaleTransaction": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/Authorization" + }, + "coupons": { + "type": "array", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string" + }, + "currencyCode": { + "type": "string" + }, + "extraDiscountAmount": { + "type": "number", + "format": "double" + }, + "loyaltyPointAmount": { + "type": "integer", + "format": "int32" + }, + "merchantName": { + "type": "string" + }, + "netAmount": { + "type": "number", + "format": "double" + }, + "siteAddress": { + "type": "string" + }, + "siteName": { + "type": "string" + }, + "taxReferenceNumber": { + "type": "string" + }, + "timeStamp": { + "type": "string" + }, + "totalAmount": { + "type": "number", + "format": "double" + }, + "totalDiscountAmount": { + "type": "number", + "format": "double" + }, + "totalTaxAmount": { + "type": "number", + "format": "double" + }, + "transactionNumber": { + "type": "string" + } + }, + "title": "SaleTransaction" + }, + "ShellTransactionResponse": { + "type": "object", + "properties": { + "requestData": { + "$ref": "#/definitions/RequestDataRes" + }, + "responseData": { + "$ref": "#/definitions/ResponseDataRes" + } + }, + "title": "ShellTransactionResponse" + }, + "SingleResponse«List«UserTransactionBo»»": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/UserTransactionBo" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«List«UserTransactionBo»»" + }, + "SingleResponse«OfferEvaluation»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/OfferEvaluationRes" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«OfferEvaluation»" + }, + "SingleResponse«TxnStatusBo»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/TxnStatusBo" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«TxnStatusBo»" + }, + "SingleResponse«WorkFlowCreationResponse»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/WorkFlowCreationResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«WorkFlowCreationResponse»" + }, + "SiteData": { + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + }, + "title": "SiteData" + }, + "SiteDataReq": { + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteId": { + "type": "string" + } + }, + "title": "SiteDataReq" + }, + "SiteDataRes": { + "type": "object", + "properties": { + "countryCode": { + "type": "string" + }, + "siteID": { + "type": "string" + } + }, + "title": "SiteDataRes" + }, + "StatResponse«Map«string,PerformanceBo»»": { + "type": "object", + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PerformanceBo" + } + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "StatResponse«Map«string,PerformanceBo»»" + }, + "StatusCode": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "isWarning": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "title": "StatusCode" + }, + "TaxSplit": { + "type": "object", + "properties": { + "additionalAmount": { + "type": "number" + }, + "amount": { + "type": "number" + }, + "code": { + "type": "string" + }, + "rate": { + "type": "number" + }, + "taxID": { + "type": "integer", + "format": "int32" + } + }, + "title": "TaxSplit" + }, + "Tender": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number" + }, + "pointsRedeemed": { + "type": "number" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRule" + } + } + }, + "title": "Tender" + }, + "TenderReq": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "string" + }, + "netTenderAmount": { + "type": "string" + }, + "pointsRedeemed": { + "type": "string" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "string" + }, + "totalAmount": { + "type": "string" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRuleReq" + } + } + }, + "title": "TenderReq" + }, + "TenderRes": { + "type": "object", + "properties": { + "acquirerID": { + "type": "string" + }, + "methodOfPayment": { + "type": "string" + }, + "methodOfPaymentID": { + "type": "integer", + "format": "int32" + }, + "netTenderAmount": { + "type": "number" + }, + "pointsRedeemed": { + "type": "number" + }, + "substractDiscountAmount": { + "type": "boolean" + }, + "tenderID": { + "type": "integer", + "format": "int32" + }, + "totalAmount": { + "type": "number" + }, + "voucherRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VoucherRuleRes" + } + } + }, + "title": "TenderRes" + }, + "Terminal": { + "type": "object", + "properties": { + "stan": { + "type": "string" + }, + "terminalBatch": { + "type": "string" + } + }, + "title": "Terminal" + }, + "TokenizeRO": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "loyaltyPan": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "TokenizeRO" + }, + "Tracker": { + "type": "object", + "properties": { + "trackerEarned": { + "type": "string" + }, + "trackerRedeemed": { + "type": "string" + }, + "trackerType": { + "type": "string" + }, + "trackerValue": { + "type": "string" + } + }, + "title": "Tracker" + }, + "TransactionAddRO": { + "type": "object", + "properties": { + "applicableVouchers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicableVoucher" + } + }, + "cardValues": { + "type": "array", + "items": { + "$ref": "#/definitions/CardValue" + } + }, + "customerData": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerData" + } + }, + "mobilePaymentData": { + "$ref": "#/definitions/MobilePaymentData" + }, + "originalTransaction": { + "$ref": "#/definitions/OriginalTransaction" + }, + "posData": { + "$ref": "#/definitions/PosData" + }, + "receipt": { + "$ref": "#/definitions/Receipt" + }, + "requestData": { + "$ref": "#/definitions/RequestData" + }, + "saleItems": { + "type": "array", + "items": { + "$ref": "#/definitions/SaleItem" + } + }, + "saleTransaction": { + "$ref": "#/definitions/SaleTransaction" + }, + "siteData": { + "$ref": "#/definitions/SiteData" + }, + "tenders": { + "type": "array", + "items": { + "$ref": "#/definitions/Tender" + } + }, + "terminal": { + "$ref": "#/definitions/Terminal" + }, + "totalAmount": { + "type": "number" + } + }, + "title": "TransactionAddRO" + }, + "TransactionAddResponse": { + "type": "object", + "properties": { + "shellResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/ShellTransactionResponse" + } + } + }, + "title": "TransactionAddResponse" + }, + "TxnStatusBo": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "extCorrelationId": { + "type": "string" + }, + "finalStatus": { + "type": "string" + }, + "instanceVariables": { + "type": "object" + }, + "languageCode": { + "type": "string" + }, + "methodOfPaymentId": { + "type": "string" + }, + "orgId": { + "type": "integer", + "format": "int64" + }, + "paymentId": { + "type": "string" + }, + "paymentProviderName": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpNumber": { + "type": "integer", + "format": "int32" + }, + "siteId": { + "type": "string" + }, + "status": { + "type": "string" + }, + "stepRequests": { + "type": "object" + }, + "workFlowDetails": { + "$ref": "#/definitions/ProcessInstanceDetails" + } + }, + "title": "TxnStatusBo" + }, + "UpdatedEntityResponse": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "success": { + "type": "boolean" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "UpdatedEntityResponse" + }, + "UserTransactionBo": { + "type": "object", + "properties": { + "extCorrelationId": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "invoice": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "preAuthAmount": { + "type": "string" + }, + "pumpId": { + "type": "string" + }, + "siteId": { + "type": "string" + }, + "startTimestamp": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "title": "UserTransactionBo" + }, + "Violation": { + "type": "object", + "properties": { + "fieldName": { + "type": "string" + }, + "invalidValue": { + "type": "object" + }, + "message": { + "type": "string" + } + }, + "title": "Violation" + }, + "VoucherCodesResult": { + "type": "object", + "properties": { + "actionCode": { + "type": "integer", + "format": "int32" + }, + "actionCodeDescription": { + "type": "string" + }, + "voucherCode": { + "type": "string" + } + }, + "title": "VoucherCodesResult" + }, + "VoucherRule": { + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRule" + }, + "VoucherRuleReq": { + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "referenceId": { + "type": "string" + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRuleReq" + }, + "VoucherRuleRes": { + "type": "object", + "properties": { + "additionalVoucherInfo": { + "type": "string" + }, + "expiryDate": { + "type": "string" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "voucherCode": { + "type": "string" + }, + "voucherType": { + "type": "string" + }, + "voucherValue": { + "type": "number" + } + }, + "title": "VoucherRuleRes" + }, + "WorkFlowCreationResponse": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "title": "WorkFlowCreationResponse" + }, + "WorkFlowPromote": { + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "workFlowName": { + "type": "string" + } + }, + "title": "WorkFlowPromote" + }, + "WorkflowInputAction": { + "type": "object", + "properties": { + "actionGroupType": { + "type": "string", + "enum": [ + "PARALLEL", + "SERIAL", + "XOR" + ] + }, + "delayTimeInRetrial": { + "type": "integer", + "format": "int32" + }, + "httpCallInputProperties": { + "$ref": "#/definitions/ActionInput" + }, + "httpCallInputPropertiesRollback": { + "$ref": "#/definitions/ActionInput" + }, + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "properties": { + "type": "object" + }, + "retrialCount": { + "type": "integer", + "format": "int32" + }, + "rollBackProperties": { + "type": "object" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string", + "enum": [ + "CCCaptureAction", + "addTransactionAction", + "authorizePaymentWithPsp", + "confirmAuthWithPSPAction", + "eghlCapturePaymentAction", + "eghlTokenizationAction", + "emptyAction", + "generatePaymentIdAction", + "ifredeemPointsAction", + "invalid", + "oAuthHttpAction", + "offerEvaluationAction", + "redeemPointsAction", + "saveCCardAction" + ] + } + }, + "title": "WorkflowInputAction" + }, + "WorkflowProcess": { + "type": "object", + "properties": { + "isAsync": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowStep" + } + } + }, + "title": "WorkflowProcess" + }, + "WorkflowStep": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowInputAction" + } + }, + "maxWaitTimeInMillis": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "serialNumber": { + "type": "integer", + "format": "int32" + } + }, + "title": "WorkflowStep" + }, + "_2c2pCallbackRequest": { + "type": "object", + "properties": { + "payload": { + "type": "string" + } + }, + "title": "_2c2pCallbackRequest" + } + } +} From 7f2abcb0ee4fb0650cd37a3546a792360d8a1062 Mon Sep 17 00:00:00 2001 From: Prince Date: Wed, 8 Jun 2022 15:36:43 +0530 Subject: [PATCH 142/150] UPDATED orchestrator.json --- orchestrator.json | 4 ++-- swagger_orchestrator_sdk.sh | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index a1b6afbedc9..8442064529c 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -718,7 +718,7 @@ "summary": "getStatusByPaymentId", "operationId": "getStatusByPaymentIdUsingGET", "produces": [ - "*/*" + "application/json" ], "parameters": [ { @@ -4948,4 +4948,4 @@ "title": "_2c2pCallbackRequest" } } -} +} \ No newline at end of file diff --git a/swagger_orchestrator_sdk.sh b/swagger_orchestrator_sdk.sh index 5e3a7efc491..2de68cae18b 100644 --- a/swagger_orchestrator_sdk.sh +++ b/swagger_orchestrator_sdk.sh @@ -16,17 +16,17 @@ else fi if [ "$Client" = "java" ]; then - rm -rf promotion_engine/java_client/java - mkdir -p promotion_engine/java_client/java + rm -rf orchestrator/java_client/java + mkdir -p orchestrator/java_client/java java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i promotion-engine.json \ + -i orchestrator.json \ -l java \ -DdateLibrary=java11 \ - -o promotion_engine/java_client/java \ + -o orchestrator/java_client/java \ -c config.json --group-id com.capillary.promotion.engine --model-package com.capillary.promotion.engine.models --api-package com.capillary.promotion.engine.api --artifact-id promotion-engine-swagger-sdk - tar cvzf promotion_engine/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./promotion_engine/java_client/java/ . - mvn3 clean deploy -f promotion_engine/java_client/java/pom.xml - fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-promotion-engine-sdk" -v $BUILD_NUMBER -C ./promotion_engine/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger_sdk_gen_promotion_engine" + tar cvzf orchestrator/java_client/java_swagger_sdk_$BUILD_NUMBER.tar.gz -C ./orchestrator/java_client/java/ . + mvn3 clean deploy -f orchestrator/java_client/java/pom.xml + fpm -f -s "dir" -t "deb" -a "all" -n "java-swagger-orchestrator-sdk" -v $BUILD_NUMBER -C ./orchestrator/java_client --deb-no-default-config-files java="/usr/share/java/capillary-libs/swagger-orchestrator-sdk" elif [ "$Client" = "php" ]; then rm -rf orchestrator/php_client/php From 8832ceda19a9a61f6aa1c79bb7b87c07a3e8a06d Mon Sep 17 00:00:00 2001 From: Prince Date: Mon, 13 Jun 2022 18:18:15 +0530 Subject: [PATCH 143/150] Update orchestrator.json --- orchestrator.json | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index 8442064529c..a9815962f24 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -2469,6 +2469,12 @@ "PUMP_RESERVE_SUCCESS", "TXN_STATE_UNKNOWN" ] + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } } }, "title": "AppTransactionStatusResponse" @@ -4588,12 +4594,21 @@ "finalStatus": { "type": "string" }, - "instanceVariables": { - "type": "object" + "invoice": { + "type": "string" }, "languageCode": { "type": "string" }, + "metaData": { + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, "methodOfPaymentId": { "type": "string" }, @@ -4611,17 +4626,19 @@ "type": "string" }, "pumpNumber": { - "type": "integer", - "format": "int32" + "type": "string" }, "siteId": { "type": "string" }, + "startTimestamp": { + "type": "string" + }, "status": { "type": "string" }, - "stepRequests": { - "type": "object" + "type": { + "type": "string" }, "workFlowDetails": { "$ref": "#/definitions/ProcessInstanceDetails" From c1c78a838d0986fd65a949107165de1338514e68 Mon Sep 17 00:00:00 2001 From: Prince Date: Thu, 23 Jun 2022 11:42:57 +0530 Subject: [PATCH 144/150] UPDATE orchestrator.json --- orchestrator.json | 363 ++++++++++------------------------------------ 1 file changed, 79 insertions(+), 284 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index a9815962f24..0af75f56e02 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -10,7 +10,7 @@ }, "license": {} }, - "host": "localhost:8100", + "host": "orchestratoradmin.crm-nightly-new.cctools.capillarytech.com", "basePath": "/", "tags": [ { @@ -45,10 +45,6 @@ "name": "payments-resource", "description": "Payments Resource" }, - { - "name": "psp-callback-resource", - "description": "Psp Callback Resource" - }, { "name": "psp-performance-resource", "description": "Psp Performance Resource" @@ -182,7 +178,7 @@ "description": "cardRegisterRO", "required": true, "schema": { - "$ref": "#/definitions/CardRegisterROReq" + "$ref": "#/definitions/CardRegisterRO" } } ], @@ -1228,148 +1224,6 @@ ] } }, - "/orchestrator/payments/webhooks/eghl/callback": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "saveToken", - "operationId": "saveTokenUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "processData", - "description": "processData", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "shouldSave", - "in": "query", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, - "/orchestrator/payments/webhooks/eghl/payment-identifier": { - "post": { - "tags": [ - "eghl-call-back-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "tokenizeRO", - "description": "tokenizeRO", - "required": true, - "schema": { - "$ref": "#/definitions/TokenizeRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, "/orchestrator/payments/webhooks/eghl/transaction": { "post": { "tags": [ @@ -1808,74 +1662,6 @@ ] } }, - "/v1/workflow/psp/payment-identifier": { - "post": { - "tags": [ - "psp-callback-resource" - ], - "summary": "generateToken", - "operationId": "generateTokenUsingPOST_1", - "consumes": [ - "application/json" - ], - "produces": [ - "*/*" - ], - "parameters": [ - { - "in": "body", - "name": "tokenizeRO", - "description": "tokenizeRO", - "required": true, - "schema": { - "$ref": "#/definitions/TokenizeRO" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MobileResponseBody«TokenizeRO»" - } - }, - "201": { - "description": "Created" - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - }, - "security": [ - { - "X-CAP-API-AUTH-ORG-ID": [ - "global" - ] - }, - { - "X-CAP-API-AUTH-ENTITY-ID": [ - "global" - ] - }, - { - "X-CAP-ENTITY-CODE": [ - "global" - ] - }, - { - "X-CAP-ENTITY-ID": [ - "global" - ] - } - ] - } - }, "/v1/workflow/shell/billing/evaluateOffer": { "post": { "tags": [ @@ -2463,6 +2249,7 @@ "BILL_GENERATED", "FUELING_CANCELLED_BY_CUSTOMER", "FUELING_CANCELLED_BY_STATION", + "PSP_AUTH_FAIL", "PUMP_ACTIVATION_FAIL", "PUMP_ACTIVATION_SUCCESS", "PUMP_RESERVE_FAIL", @@ -2627,7 +2414,7 @@ "CancelRequest": { "type": "object", "properties": { - "processInstanceId": { + "paymentID": { "type": "string" } }, @@ -2642,7 +2429,7 @@ "$ref": "#/definitions/StatusCode" } }, - "processInstanceId": { + "paymentId": { "type": "string" }, "success": { @@ -2657,28 +2444,7 @@ }, "title": "CancelResponse" }, - "CardRegisterROReq": { - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "paymentId": { - "type": "string" - }, - "paymentProviderName": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "CardRegisterROReq" - }, - "CardRegisterRORes": { + "CardRegisterRO": { "type": "object", "properties": { "currencyCode": { @@ -2687,20 +2453,17 @@ "customerInfo": { "$ref": "#/definitions/CustomerInfo" }, - "loyaltyPan": { + "merchantIdentifier": { "type": "string" }, "paymentId": { "type": "string" }, - "paymentProviderName": { - "type": "string" - }, "registrationAmount": { "type": "string" } }, - "title": "CardRegisterRORes" + "title": "CardRegisterRO" }, "CardValue": { "type": "object", @@ -2775,6 +2538,7 @@ "type": "string", "enum": [ "cardnumber", + "customerId", "email", "externalId", "mobile", @@ -2930,7 +2694,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/CardRegisterRORes" + "$ref": "#/definitions/CardRegisterRO" }, "errors": { "type": "array", @@ -3283,6 +3047,9 @@ "versionName": { "type": "string" }, + "vertical": { + "type": "string" + }, "workflowName": { "type": "string" } @@ -3583,32 +3350,6 @@ }, "title": "PriceAdjustmentRes" }, - "ProcessInstanceDetails": { - "type": "object", - "properties": { - "customerId": { - "type": "integer", - "format": "int64" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "loyaltyPan": { - "type": "string" - }, - "tillId": { - "type": "integer", - "format": "int64" - }, - "version": { - "type": "string" - }, - "workflowName": { - "type": "string" - } - }, - "title": "ProcessInstanceDetails" - }, "Product": { "type": "object", "properties": { @@ -3633,6 +3374,9 @@ "PumpReserve": { "type": "object", "properties": { + "cardIdentifier": { + "type": "string" + }, "currencyCode": { "type": "string" }, @@ -3642,18 +3386,12 @@ "languageCode": { "type": "string" }, - "loyaltyPan": { - "type": "string" - }, - "methodOfPaymentId": { + "merchantIdentifier": { "type": "string" }, "paymentId": { "type": "string" }, - "paymentProviderName": { - "type": "string" - }, "preAuthAmount": { "type": "string" }, @@ -3662,6 +3400,9 @@ }, "siteId": { "type": "string" + }, + "siteName": { + "type": "string" } }, "title": "PumpReserve" @@ -4474,13 +4215,13 @@ "customerInfo": { "$ref": "#/definitions/CustomerInfo" }, - "loyaltyPan": { + "digitalCard": { "type": "string" }, - "paymentId": { + "merchantIdentifier": { "type": "string" }, - "paymentProviderName": { + "paymentId": { "type": "string" }, "registrationAmount": { @@ -4588,6 +4329,9 @@ "currencyCode": { "type": "string" }, + "digitalCard": { + "type": "string" + }, "extCorrelationId": { "type": "string" }, @@ -4600,6 +4344,12 @@ "languageCode": { "type": "string" }, + "maskedCard": { + "type": "string" + }, + "merchantId": { + "type": "string" + }, "metaData": { "type": "object", "additionalProperties": { @@ -4625,12 +4375,18 @@ "preAuthAmount": { "type": "string" }, + "processInstanceId": { + "type": "string" + }, "pumpNumber": { "type": "string" }, "siteId": { "type": "string" }, + "siteName": { + "type": "string" + }, "startTimestamp": { "type": "string" }, @@ -4640,8 +4396,11 @@ "type": { "type": "string" }, - "workFlowDetails": { - "$ref": "#/definitions/ProcessInstanceDetails" + "workFlowName": { + "type": "string" + }, + "workFlowVersion": { + "type": "string" } }, "title": "TxnStatusBo" @@ -4845,6 +4604,13 @@ "version": { "type": "string" }, + "vertical": { + "type": "string", + "enum": [ + "FUELLING", + "NON" + ] + }, "workFlowName": { "type": "string" } @@ -4888,6 +4654,28 @@ "rollBackProperties": { "type": "object" }, + "rollbackName": { + "type": "string" + }, + "rollbackType": { + "type": "string", + "enum": [ + "CCCaptureAction", + "addTransactionAction", + "authorizePaymentWithPsp", + "confirmAuthWithPSPAction", + "eghlCapturePaymentAction", + "eghlTokenizationAction", + "emptyAction", + "generatePaymentIdAction", + "ifredeemPointsAction", + "invalid", + "oAuthHttpAction", + "offerEvaluationAction", + "redeemPointsAction", + "saveCCardAction" + ] + }, "serialNumber": { "type": "integer", "format": "int32" @@ -4928,6 +4716,13 @@ "items": { "$ref": "#/definitions/WorkflowStep" } + }, + "vertical": { + "type": "string", + "enum": [ + "FUELLING", + "NON" + ] } }, "title": "WorkflowProcess" From 5cb9075688b8bc042e7f0f9e24f88ef8fb1d230f Mon Sep 17 00:00:00 2001 From: Prince Date: Fri, 24 Jun 2022 12:05:32 +0530 Subject: [PATCH 145/150] UPDATE orchestrator.json --- orchestrator.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/orchestrator.json b/orchestrator.json index 0af75f56e02..684b89462f8 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -4329,6 +4329,9 @@ "currencyCode": { "type": "string" }, + "customerId": { + "type": "string" + }, "digitalCard": { "type": "string" }, From c74982803212bde2e6a4fceb35c1af02bdff906c Mon Sep 17 00:00:00 2001 From: Prince Date: Wed, 6 Jul 2022 10:16:29 +0530 Subject: [PATCH 146/150] update orchestrator.json --- orchestrator.json | 52 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 41 insertions(+), 11 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index 684b89462f8..2a232383347 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -10,7 +10,7 @@ }, "license": {} }, - "host": "orchestratoradmin.crm-nightly-new.cctools.capillarytech.com", + "host": "localhost:8100", "basePath": "/", "tags": [ { @@ -658,7 +658,7 @@ "description": "tokenizeRO", "required": true, "schema": { - "$ref": "#/definitions/TokenizeRO" + "$ref": "#/definitions/TokenizeROReq" } } ], @@ -2793,7 +2793,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/TokenizeRO" + "$ref": "#/definitions/TokenizeRORes" }, "errors": { "type": "array", @@ -3017,6 +3017,9 @@ "type": "string", "format": "date-time" }, + "diffJson": { + "type": "string" + }, "id": { "type": "integer", "format": "int64" @@ -3050,6 +3053,9 @@ "vertical": { "type": "string" }, + "workflowJson": { + "type": "string" + }, "workflowName": { "type": "string" } @@ -3158,6 +3164,9 @@ "PreAuthorizeStep": { "type": "object", "properties": { + "paymentId": { + "type": "string" + }, "processInstanceId": { "type": "string" }, @@ -4206,7 +4215,28 @@ }, "title": "Terminal" }, - "TokenizeRO": { + "TokenizeROReq": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string" + }, + "customerInfo": { + "$ref": "#/definitions/CustomerInfo" + }, + "merchantIdentifier": { + "type": "string" + }, + "paymentId": { + "type": "string" + }, + "registrationAmount": { + "type": "string" + } + }, + "title": "TokenizeROReq" + }, + "TokenizeRORes": { "type": "object", "properties": { "currencyCode": { @@ -4228,7 +4258,7 @@ "type": "string" } }, - "title": "TokenizeRO" + "title": "TokenizeRORes" }, "Tracker": { "type": "object", @@ -4365,6 +4395,12 @@ "methodOfPaymentId": { "type": "string" }, + "mopId": { + "type": "string" + }, + "mopName": { + "type": "string" + }, "orgId": { "type": "integer", "format": "int64" @@ -4647,16 +4683,10 @@ "name": { "type": "string" }, - "properties": { - "type": "object" - }, "retrialCount": { "type": "integer", "format": "int32" }, - "rollBackProperties": { - "type": "object" - }, "rollbackName": { "type": "string" }, From d497dd8498fab438eb7d828750c985ba18f21540 Mon Sep 17 00:00:00 2001 From: Omkar Pote <68005268+omkar-pote@users.noreply.github.com> Date: Tue, 20 Sep 2022 20:11:18 +0530 Subject: [PATCH 147/150] Update orchestrator.json --- orchestrator.json | 509 ++++++++++++++++++++++++++++++++++------------ 1 file changed, 382 insertions(+), 127 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index 2a232383347..9d87c0556e3 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -21,14 +21,14 @@ "name": "admin-workflow-resource", "description": "Admin Workflow Resource" }, - { - "name": "cancel-sandbox", - "description": "Cancel Sandbox" - }, { "name": "eghl-call-back-resource", "description": "Eghl Call Back Resource" }, + { + "name": "eghl-reconciliation", + "description": "EGHL Reconciliation" + }, { "name": "health-check-resource", "description": "Health Check Resource" @@ -49,10 +49,6 @@ "name": "psp-performance-resource", "description": "Psp Performance Resource" }, - { - "name": "psp-reconciliation", - "description": "PSP Reconciliation" - }, { "name": "pump-life-cycle-resource", "description": "Pump Life Cycle Resource" @@ -62,8 +58,16 @@ "description": "Pump Performance Resource" }, { - "name": "shell-server-to-server-resource", - "description": "Shell Server To Server Resource" + "name": "register-rest-controller", + "description": "Register Rest Controller" + }, + { + "name": "site-cancel-resource", + "description": "Site Cancel Resource" + }, + { + "name": "site-server-to-server-resource", + "description": "Site Server To Server Resource" }, { "name": "swagger-config-resource", @@ -83,6 +87,114 @@ } ], "paths": { + "/hi": { + "post": { + "tags": [ + "register-rest-controller" + ], + "summary": "register", + "operationId": "registerUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, + "/orchestrator/payments/app": { + "get": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "get", + "operationId": "getUsingGET_1", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, "/orchestrator/payments/app/pumpReserve/{version}": { "post": { "tags": [ @@ -658,7 +770,7 @@ "description": "tokenizeRO", "required": true, "schema": { - "$ref": "#/definitions/TokenizeROReq" + "$ref": "#/definitions/TokenizeRO" } } ], @@ -829,7 +941,7 @@ "/orchestrator/payments/v1/site/cancel": { "post": { "tags": [ - "cancel-sandbox" + "site-cancel-resource" ], "summary": "cancel", "operationId": "cancelUsingPOST", @@ -894,7 +1006,7 @@ "/orchestrator/payments/v1/site/finalize-txn": { "post": { "tags": [ - "shell-server-to-server-resource" + "site-server-to-server-resource" ], "summary": "finalizeTransaction", "operationId": "finalizeTransactionUsingPOST", @@ -959,7 +1071,7 @@ "/orchestrator/payments/v1/site/get-offers": { "post": { "tags": [ - "shell-server-to-server-resource" + "site-server-to-server-resource" ], "summary": "offerEvaluation", "operationId": "offerEvaluationUsingPOST", @@ -1343,29 +1455,43 @@ ] } }, - "/reconciliation/capture": { - "post": { + "/v1/workflow": { + "get": { "tags": [ - "psp-reconciliation" - ], - "summary": "reconciliationCapture", - "operationId": "reconciliationCaptureUsingPOST", - "consumes": [ - "application/json" + "admin-workflow-resource" ], + "summary": "get", + "operationId": "getUsingGET", "produces": [ "*/*" ], + "parameters": [ + { + "name": "allVersions", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "required": false, + "type": "string" + } + ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/GetEntityResponse" } }, - "201": { - "description": "Created" - }, "401": { "description": "Unauthorized" }, @@ -1398,26 +1524,35 @@ ] } ] - } - }, - "/reconciliation/registration-reversal": { + }, "post": { "tags": [ - "psp-reconciliation" + "admin-workflow-resource" ], - "summary": "reconciliationRegistrationReversal", - "operationId": "reconciliationRegistrationReversalUsingPOST", + "summary": "create", + "operationId": "createUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], + "parameters": [ + { + "in": "body", + "name": "workflowProcess", + "description": "workflowProcess", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowProcess" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/SingleResponse«WorkFlowCreationResponse»" } }, "201": { @@ -1457,43 +1592,40 @@ ] } }, - "/v1/workflow": { - "get": { + "/v1/workflow/promotion": { + "put": { "tags": [ "admin-workflow-resource" ], - "summary": "get", - "operationId": "getUsingGET", + "summary": "promoteWorkFlow", + "operationId": "promoteWorkFlowUsingPUT", + "consumes": [ + "application/json" + ], "produces": [ "*/*" ], "parameters": [ { - "name": "allVersions", - "in": "query", - "required": false, - "type": "boolean" - }, - { - "name": "name", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "version", - "in": "query", - "required": false, - "type": "string" + "in": "body", + "name": "workFlowPromote", + "description": "workFlowPromote", + "required": true, + "schema": { + "$ref": "#/definitions/WorkFlowPromote" + } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/GetEntityResponse" + "$ref": "#/definitions/UpdatedEntityResponse" } }, + "201": { + "description": "Created" + }, "401": { "description": "Unauthorized" }, @@ -1526,35 +1658,26 @@ ] } ] - }, + } + }, + "/v1/workflow/psp/reconciliation/capture": { "post": { "tags": [ - "admin-workflow-resource" + "eghl-reconciliation" ], - "summary": "create", - "operationId": "createUsingPOST", + "summary": "reconciliationCapture", + "operationId": "reconciliationCaptureUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], - "parameters": [ - { - "in": "body", - "name": "workflowProcess", - "description": "workflowProcess", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowProcess" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SingleResponse«WorkFlowCreationResponse»" + "type": "string" } }, "201": { @@ -1594,35 +1717,81 @@ ] } }, - "/v1/workflow/promotion": { - "put": { + "/v1/workflow/psp/reconciliation/fuelling-reversal": { + "post": { "tags": [ - "admin-workflow-resource" + "eghl-reconciliation" ], - "summary": "promoteWorkFlow", - "operationId": "promoteWorkFlowUsingPUT", + "summary": "reconciliationFuellingReversal", + "operationId": "reconciliationFuellingReversalUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], - "parameters": [ - { - "in": "body", - "name": "workFlowPromote", - "description": "workFlowPromote", - "required": true, + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/WorkFlowPromote" + "type": "string" } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] } + ] + } + }, + "/v1/workflow/psp/reconciliation/registration-reversal": { + "post": { + "tags": [ + "eghl-reconciliation" + ], + "summary": "reconciliationRegistrationReversal", + "operationId": "reconciliationRegistrationReversalUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/UpdatedEntityResponse" + "type": "string" } }, "201": { @@ -2212,6 +2381,9 @@ "processInstanceId": { "type": "string" }, + "resetStepOnFailure": { + "type": "boolean" + }, "version": { "type": "string" }, @@ -2224,31 +2396,67 @@ "AppTransactionStatusResponse": { "type": "object", "properties": { + "billingAmount": { + "type": "string" + }, + "billingLines": { + "type": "array", + "items": { + "type": "string" + } + }, "customerId": { "type": "integer", "format": "int64" }, + "digitalCard": { + "type": "string" + }, + "maskedCard": { + "type": "string" + }, + "mop": { + "type": "string" + }, + "mopName": { + "type": "string" + }, "paymentId": { "type": "string" }, + "pointsAllocated": { + "type": "string" + }, "preAuthAmount": { "type": "string" }, "processInstanceId": { "type": "string" }, + "pspReferenceNumber": { + "type": "string" + }, + "pumpActivateTime": { + "type": "string" + }, "pumpNumber": { "type": "string" }, + "pumpReserveTime": { + "type": "string" + }, "stationId": { "type": "string" }, "transactionState": { "type": "string", "enum": [ + "BILLING_IN_PROGRESS", "BILL_GENERATED", + "CARD_REGISTERED", "FUELING_CANCELLED_BY_CUSTOMER", "FUELING_CANCELLED_BY_STATION", + "IN_PROGRESS", "PSP_AUTH_FAIL", "PUMP_ACTIVATION_FAIL", "PUMP_ACTIVATION_SUCCESS", @@ -2793,7 +3001,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/TokenizeRORes" + "$ref": "#/definitions/TokenizeRO" }, "errors": { "type": "array", @@ -2825,6 +3033,9 @@ "OfferEvaluation": { "type": "object", "properties": { + "PredictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "applicableVouchers": { "type": "array", "items": { @@ -2843,12 +3054,12 @@ "posData": { "$ref": "#/definitions/PosData" }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "receipt": { "$ref": "#/definitions/Receipt" }, + "remainder": { + "type": "number" + }, "requestData": { "$ref": "#/definitions/RequestData" }, @@ -2885,6 +3096,9 @@ "OfferEvaluationReq": { "type": "object", "properties": { + "PredictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "applicableVouchers": { "type": "array", "items": { @@ -2903,12 +3117,12 @@ "posData": { "$ref": "#/definitions/PosDataReq" }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "receipt": { "$ref": "#/definitions/Receipt" }, + "remainder": { + "type": "number" + }, "requestData": { "$ref": "#/definitions/RequestDataReq" }, @@ -2945,6 +3159,9 @@ "OfferEvaluationRes": { "type": "object", "properties": { + "PredictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "applicableVouchers": { "type": "array", "items": { @@ -2963,12 +3180,12 @@ "posData": { "$ref": "#/definitions/PosDataRes" }, - "predictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "receipt": { "$ref": "#/definitions/Receipt" }, + "remainder": { + "type": "number" + }, "requestData": { "$ref": "#/definitions/RequestDataRes" }, @@ -3103,7 +3320,7 @@ "PosData": { "type": "object", "properties": { - "languageCode": { + "LanguageCode": { "type": "string" }, "posTimeStamp": { @@ -3149,7 +3366,7 @@ "PosDataRes": { "type": "object", "properties": { - "languageCode": { + "LanguageCode": { "type": "string" }, "posTimeStamp": { @@ -3179,13 +3396,16 @@ "PredictedTender": { "type": "object", "properties": { - "acquire": { + "acquirer": { "type": "string" }, + "amount": { + "type": "number" + }, "methodOfPayment": { "type": "string" }, - "subtractDiscountAmount": { + "substractDiscountAmount": { "type": "boolean" } }, @@ -3434,6 +3654,9 @@ "cartEvaluationID": { "type": "string" }, + "extCorrelationId": { + "type": "string" + }, "payTokenID": { "type": "string" }, @@ -3524,6 +3747,9 @@ "cartEvaluationID": { "type": "string" }, + "extCorrelationID": { + "type": "string" + }, "overallResult": { "type": "string" }, @@ -3554,6 +3780,9 @@ "cartEvaluationID": { "type": "string" }, + "extCorrelationID": { + "type": "string" + }, "overallResult": { "type": "string" }, @@ -3649,6 +3878,9 @@ "SaleItemReq": { "type": "object", "properties": { + "LineNo": { + "type": "string" + }, "additionalProductCode": { "type": "string" }, @@ -3661,9 +3893,6 @@ "categoryCode": { "type": "string" }, - "lineNo": { - "type": "string" - }, "loyaltyOffers": { "type": "array", "items": { @@ -3828,6 +4057,9 @@ "taxReferenceNumber": { "type": "string" }, + "terminalID": { + "type": "string" + }, "timeStamp": { "type": "string" }, @@ -4065,6 +4297,9 @@ }, "message": { "type": "string" + }, + "resetStep": { + "type": "boolean" } }, "title": "StatusCode" @@ -4097,6 +4332,12 @@ "acquirerID": { "type": "string" }, + "cashRedeemed": { + "type": "number" + }, + "currencyCode": { + "type": "string" + }, "methodOfPayment": { "type": "string" }, @@ -4171,6 +4412,12 @@ "acquirerID": { "type": "string" }, + "cashRedeemed": { + "type": "number" + }, + "currencyCode": { + "type": "string" + }, "methodOfPayment": { "type": "string" }, @@ -4215,28 +4462,7 @@ }, "title": "Terminal" }, - "TokenizeROReq": { - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "merchantIdentifier": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "TokenizeROReq" - }, - "TokenizeRORes": { + "TokenizeRO": { "type": "object", "properties": { "currencyCode": { @@ -4245,9 +4471,6 @@ "customerInfo": { "$ref": "#/definitions/CustomerInfo" }, - "digitalCard": { - "type": "string" - }, "merchantIdentifier": { "type": "string" }, @@ -4258,7 +4481,7 @@ "type": "string" } }, - "title": "TokenizeRORes" + "title": "TokenizeRO" }, "Tracker": { "type": "object", @@ -4287,6 +4510,9 @@ "$ref": "#/definitions/ApplicableVoucher" } }, + "billingNumber": { + "type": "string" + }, "cardValues": { "type": "array", "items": { @@ -4429,6 +4655,9 @@ "startTimestamp": { "type": "string" }, + "startTimestampOld": { + "type": "string" + }, "status": { "type": "string" }, @@ -4497,6 +4726,9 @@ "type": "string" }, "startTimestamp": { + "type": "string" + }, + "startTimestampOld": { "type": "string", "format": "date-time" }, @@ -4555,9 +4787,19 @@ "$ref": "#/definitions/Product" } }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, "voucherCode": { "type": "string" }, + "voucherQuantity": { + "type": "integer", + "format": "int32" + }, "voucherType": { "type": "string" }, @@ -4613,9 +4855,19 @@ "$ref": "#/definitions/Product" } }, + "promotionType": { + "type": "string" + }, + "referenceID": { + "type": "string" + }, "voucherCode": { "type": "string" }, + "voucherQuantity": { + "type": "integer", + "format": "int32" + }, "voucherType": { "type": "string" }, @@ -4779,6 +5031,9 @@ "serialNumber": { "type": "integer", "format": "int32" + }, + "startUserStep": { + "type": "boolean" } }, "title": "WorkflowStep" @@ -4793,4 +5048,4 @@ "title": "_2c2pCallbackRequest" } } -} \ No newline at end of file +} From 50f5b2708e72954f879c69005d6a78140fdb0c34 Mon Sep 17 00:00:00 2001 From: Omkar Pote <68005268+omkar-pote@users.noreply.github.com> Date: Wed, 23 Nov 2022 18:13:33 +0530 Subject: [PATCH 148/150] Update orchestrator.json --- orchestrator.json | 738 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 598 insertions(+), 140 deletions(-) diff --git a/orchestrator.json b/orchestrator.json index 9d87c0556e3..aaa55433a45 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -29,6 +29,10 @@ "name": "eghl-reconciliation", "description": "EGHL Reconciliation" }, + { + "name": "external-api-error-code-mapping-resource", + "description": "External API Error Code Mapping Resource" + }, { "name": "health-check-resource", "description": "Health Check Resource" @@ -45,6 +49,10 @@ "name": "payments-resource", "description": "Payments Resource" }, + { + "name": "psp-auth-support-resource", + "description": "Psp Auth Support Resource" + }, { "name": "psp-performance-resource", "description": "Psp Performance Resource" @@ -87,24 +95,109 @@ } ], "paths": { - "/hi": { + "/external/errorcode/mapping": { + "get": { + "tags": [ + "external-api-error-code-mapping-resource" + ], + "summary": "getMapping", + "operationId": "getMappingUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "brand", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "SHELL" + ] + }, + { + "name": "useCase", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CARD_REGISTRATION", + "FUELING", + "NON" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ExternalAPIErrorCodeMappingDto" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + }, "post": { "tags": [ - "register-rest-controller" + "external-api-error-code-mapping-resource" ], - "summary": "register", - "operationId": "registerUsingPOST", + "summary": "create", + "operationId": "createUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], + "parameters": [ + { + "in": "body", + "name": "errorMapping", + "description": "errorMapping", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalAPIErrorCodeMapping" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/SingleResponse«ExternalAPIErrorCodeMappingResponse»" } }, "201": { @@ -144,23 +237,44 @@ ] } }, - "/orchestrator/payments/app": { - "get": { + "/external/errorcode/mapping/bulk": { + "post": { "tags": [ - "pump-life-cycle-resource" + "external-api-error-code-mapping-resource" + ], + "summary": "bulkCreate", + "operationId": "bulkCreateUsingPOST", + "consumes": [ + "application/json" ], - "summary": "get", - "operationId": "getUsingGET_1", "produces": [ "*/*" ], + "parameters": [ + { + "in": "body", + "name": "errorMappingList", + "description": "errorMappingList", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ExternalAPIErrorCodeMapping" + } + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "type": "integer", + "format": "int32" } }, + "201": { + "description": "Created" + }, "401": { "description": "Unauthorized" }, @@ -195,47 +309,80 @@ ] } }, - "/orchestrator/payments/app/pumpReserve/{version}": { + "/hi": { "post": { "tags": [ - "test-fuelling-workflow-resource" + "register-rest-controller" ], - "summary": "pumpReserveWithGivenVersion", - "operationId": "pumpReserveWithGivenVersionUsingPOST", + "summary": "register", + "operationId": "registerUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], - "parameters": [ - { - "in": "body", - "name": "pumpReserve", - "description": "pumpReserve", - "required": true, + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/PumpReserve" + "type": "string" } }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ { - "name": "version", - "in": "path", - "description": "version", - "required": true, - "type": "string" + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] } + ] + } + }, + "/orchestrator/payments/app": { + "get": { + "tags": [ + "pump-life-cycle-resource" + ], + "summary": "get", + "operationId": "getUsingGET_1", + "produces": [ + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MobileResponseBody«PumpReserve»" + "type": "string" } }, - "201": { - "description": "Created" - }, "401": { "description": "Unauthorized" }, @@ -270,13 +417,13 @@ ] } }, - "/orchestrator/payments/app/register-paymentIdV1": { + "/orchestrator/payments/app/pumpReserve/{version}": { "post": { "tags": [ - "mobile-card-registration-resource" + "test-fuelling-workflow-resource" ], - "summary": "registerPaymentId", - "operationId": "registerPaymentIdUsingPOST", + "summary": "pumpReserveWithGivenVersion", + "operationId": "pumpReserveWithGivenVersionUsingPOST", "consumes": [ "application/json" ], @@ -286,19 +433,26 @@ "parameters": [ { "in": "body", - "name": "cardRegisterRO", - "description": "cardRegisterRO", + "name": "pumpReserve", + "description": "pumpReserve", "required": true, "schema": { - "$ref": "#/definitions/CardRegisterRO" + "$ref": "#/definitions/PumpReserve" } + }, + { + "name": "version", + "in": "path", + "description": "version", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MobileResponseBody«CardRegisterRO»" + "$ref": "#/definitions/MobileResponseBody«PumpReserve»" } }, "201": { @@ -546,6 +700,82 @@ ] } }, + "/orchestrator/payments/app/v1/hash/{paymentId}": { + "get": { + "tags": [ + "psp-auth-support-resource" + ], + "summary": "hashing", + "operationId": "hashingUsingGET", + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "paymentId", + "in": "path", + "description": "paymentId", + "required": true, + "type": "string" + }, + { + "name": "pspName", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "2C2P", + "EGHL" + ] + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HashingSupportResponse" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + }, + "security": [ + { + "X-CAP-API-AUTH-ORG-ID": [ + "global" + ] + }, + { + "X-CAP-API-AUTH-ENTITY-ID": [ + "global" + ] + }, + { + "X-CAP-ENTITY-CODE": [ + "global" + ] + }, + { + "X-CAP-ENTITY-ID": [ + "global" + ] + } + ] + } + }, "/orchestrator/payments/app/v1/pump-activate": { "post": { "tags": [ @@ -2360,6 +2590,12 @@ "actionName": { "type": "string" }, + "brand": { + "type": "string", + "enum": [ + "SHELL" + ] + }, "customerId": { "type": "integer", "format": "int64" @@ -2367,6 +2603,9 @@ "customerInfo": { "$ref": "#/definitions/CustomerInfo" }, + "entityCode": { + "type": "string" + }, "entityId": { "type": "integer", "format": "int64" @@ -2374,6 +2613,13 @@ "input": { "type": "object" }, + "merchantIDStrategy": { + "type": "string", + "enum": [ + "ORG_LEVEL", + "PER_STORE" + ] + }, "orgId": { "type": "integer", "format": "int64" @@ -2384,6 +2630,17 @@ "resetStepOnFailure": { "type": "boolean" }, + "rollbackOnFailure": { + "type": "boolean" + }, + "useCase": { + "type": "string", + "enum": [ + "CARD_REGISTRATION", + "FUELING", + "NON" + ] + }, "version": { "type": "string" }, @@ -2412,6 +2669,12 @@ "digitalCard": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, "maskedCard": { "type": "string" }, @@ -2454,6 +2717,7 @@ "BILLING_IN_PROGRESS", "BILL_GENERATED", "CARD_REGISTERED", + "CARD_REGISTER_IN_PROGRESS", "FUELING_CANCELLED_BY_CUSTOMER", "FUELING_CANCELLED_BY_STATION", "IN_PROGRESS", @@ -2477,7 +2741,7 @@ "ApplicableVoucher": { "type": "object", "properties": { - "additionVoucherInfo": { + "additionalVoucherInfo": { "type": "string" }, "expiryDate": { @@ -2544,7 +2808,7 @@ "ApplicableVoucherRes": { "type": "object", "properties": { - "additionVoucherInfo": { + "additionalVoucherInfo": { "type": "string" }, "expiryDate": { @@ -2622,6 +2886,9 @@ "CancelRequest": { "type": "object", "properties": { + "customerID": { + "type": "string" + }, "paymentID": { "type": "string" } @@ -2652,27 +2919,6 @@ }, "title": "CancelResponse" }, - "CardRegisterRO": { - "type": "object", - "properties": { - "currencyCode": { - "type": "string" - }, - "customerInfo": { - "$ref": "#/definitions/CustomerInfo" - }, - "merchantIdentifier": { - "type": "string" - }, - "paymentId": { - "type": "string" - }, - "registrationAmount": { - "type": "string" - } - }, - "title": "CardRegisterRO" - }, "CardValue": { "type": "object", "properties": { @@ -2762,6 +3008,109 @@ }, "title": "CustomerInfo" }, + "ExternalAPIErrorCodeMapping": { + "type": "object", + "properties": { + "apiName": { + "type": "string" + }, + "brand": { + "type": "string", + "enum": [ + "SHELL" + ] + }, + "errorNumber": { + "type": "integer", + "format": "int32" + }, + "otaErrorNumber": { + "type": "string" + }, + "retryable": { + "type": "boolean" + }, + "useCase": { + "type": "string", + "enum": [ + "CARD_REGISTRATION", + "FUELING", + "NON" + ] + } + }, + "title": "ExternalAPIErrorCodeMapping" + }, + "ExternalAPIErrorCodeMappingDto": { + "type": "object", + "properties": { + "apiName": { + "type": "string" + }, + "brand": { + "type": "string", + "enum": [ + "SHELL" + ] + }, + "errorNumber": { + "type": "integer", + "format": "int32" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "otaErrorNumber": { + "type": "string" + }, + "retryable": { + "type": "boolean" + }, + "useCase": { + "type": "string", + "enum": [ + "CARD_REGISTRATION", + "FUELING", + "NON" + ] + } + }, + "title": "ExternalAPIErrorCodeMappingDto" + }, + "ExternalAPIErrorCodeMappingResponse": { + "type": "object", + "properties": { + "apiName": { + "type": "string" + }, + "brand": { + "type": "string", + "enum": [ + "SHELL" + ] + }, + "errorCode": { + "type": "integer", + "format": "int32" + }, + "otaErrorNumber": { + "type": "string" + }, + "retryable": { + "type": "boolean" + }, + "useCase": { + "type": "string", + "enum": [ + "CARD_REGISTRATION", + "FUELING", + "NON" + ] + } + }, + "title": "ExternalAPIErrorCodeMappingResponse" + }, "GetEntityResponse": { "type": "object", "properties": { @@ -2792,6 +3141,36 @@ }, "title": "GetEntityResponse" }, + "HashingSupportResponse": { + "type": "object", + "properties": { + "hash": { + "type": "string" + }, + "success": { + "type": "boolean" + } + }, + "title": "HashingSupportResponse" + }, + "IntermediateCatchEvent": { + "type": "object", + "properties": { + "intermediateCatchEventType": { + "type": "string", + "enum": [ + "DELAYED_TIMER" + ] + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "title": "IntermediateCatchEvent" + }, "LoyaltyDetails": { "type": "object", "properties": { @@ -2898,39 +3277,6 @@ }, "title": "MobilePaymentData" }, - "MobileResponseBody«CardRegisterRO»": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/CardRegisterRO" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - }, - "processInstanceId": { - "type": "string" - }, - "success": { - "type": "boolean" - }, - "violations": { - "type": "array", - "items": { - "$ref": "#/definitions/Violation" - } - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCode" - } - } - }, - "title": "MobileResponseBody«CardRegisterRO»" - }, "MobileResponseBody«PreAuthorizeStep»": { "type": "object", "properties": { @@ -3033,9 +3379,6 @@ "OfferEvaluation": { "type": "object", "properties": { - "PredictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "applicableVouchers": { "type": "array", "items": { @@ -3054,6 +3397,9 @@ "posData": { "$ref": "#/definitions/PosData" }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "receipt": { "$ref": "#/definitions/Receipt" }, @@ -3096,9 +3442,6 @@ "OfferEvaluationReq": { "type": "object", "properties": { - "PredictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "applicableVouchers": { "type": "array", "items": { @@ -3117,6 +3460,9 @@ "posData": { "$ref": "#/definitions/PosDataReq" }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "receipt": { "$ref": "#/definitions/Receipt" }, @@ -3159,9 +3505,6 @@ "OfferEvaluationRes": { "type": "object", "properties": { - "PredictedTender": { - "$ref": "#/definitions/PredictedTender" - }, "applicableVouchers": { "type": "array", "items": { @@ -3180,6 +3523,9 @@ "posData": { "$ref": "#/definitions/PosDataRes" }, + "predictedTender": { + "$ref": "#/definitions/PredictedTender" + }, "receipt": { "$ref": "#/definitions/Receipt" }, @@ -3253,6 +3599,13 @@ "isDefault": { "type": "boolean" }, + "merchantIdStrategy": { + "type": "string", + "enum": [ + "ORG_LEVEL", + "PER_STORE" + ] + }, "orgId": { "type": "integer", "format": "int64" @@ -3264,10 +3617,10 @@ "type": "string", "format": "date-time" }, - "versionName": { + "useCase": { "type": "string" }, - "vertical": { + "versionName": { "type": "string" }, "workflowJson": { @@ -3603,6 +3956,12 @@ "PumpReserve": { "type": "object", "properties": { + "additionalFields": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "cardIdentifier": { "type": "string" }, @@ -3624,6 +3983,13 @@ "preAuthAmount": { "type": "string" }, + "pspIdentifier": { + "type": "string", + "enum": [ + "2C2P", + "EGHL" + ] + }, "pumpNumber": { "type": "string" }, @@ -4034,8 +4400,7 @@ "type": "string" }, "extraDiscountAmount": { - "type": "number", - "format": "double" + "type": "number" }, "loyaltyPointAmount": { "type": "integer", @@ -4045,8 +4410,7 @@ "type": "string" }, "netAmount": { - "type": "number", - "format": "double" + "type": "number" }, "siteAddress": { "type": "string" @@ -4064,16 +4428,13 @@ "type": "string" }, "totalAmount": { - "type": "number", - "format": "double" + "type": "number" }, "totalDiscountAmount": { - "type": "number", - "format": "double" + "type": "number" }, "totalTaxAmount": { - "type": "number", - "format": "double" + "type": "number" }, "transactionNumber": { "type": "string" @@ -4093,6 +4454,36 @@ }, "title": "ShellTransactionResponse" }, + "SingleResponse«ExternalAPIErrorCodeMappingResponse»": { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/ExternalAPIErrorCodeMappingResponse" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + }, + "processId": { + "type": "string" + }, + "violations": { + "type": "array", + "items": { + "$ref": "#/definitions/Violation" + } + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusCode" + } + } + }, + "title": "SingleResponse«ExternalAPIErrorCodeMappingResponse»" + }, "SingleResponse«List«UserTransactionBo»»": { "type": "object", "properties": { @@ -4297,9 +4688,6 @@ }, "message": { "type": "string" - }, - "resetStep": { - "type": "boolean" } }, "title": "StatusCode" @@ -4342,8 +4730,7 @@ "type": "string" }, "methodOfPaymentID": { - "type": "integer", - "format": "int32" + "type": "string" }, "netTenderAmount": { "type": "number" @@ -4422,8 +4809,7 @@ "type": "string" }, "methodOfPaymentID": { - "type": "integer", - "format": "int32" + "type": "string" }, "netTenderAmount": { "type": "number" @@ -4465,6 +4851,12 @@ "TokenizeRO": { "type": "object", "properties": { + "additionalFields": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "currencyCode": { "type": "string" }, @@ -4477,6 +4869,13 @@ "paymentId": { "type": "string" }, + "pspIdentifier": { + "type": "string", + "enum": [ + "2C2P", + "EGHL" + ] + }, "registrationAmount": { "type": "string" } @@ -4582,6 +4981,9 @@ "TxnStatusBo": { "type": "object", "properties": { + "cardType": { + "type": "string" + }, "currencyCode": { "type": "string" }, @@ -4892,16 +5294,17 @@ "WorkFlowPromote": { "type": "object", "properties": { - "version": { - "type": "string" - }, - "vertical": { + "usecase": { "type": "string", "enum": [ - "FUELLING", + "CARD_REGISTRATION", + "FUELING", "NON" ] }, + "version": { + "type": "string" + }, "workFlowName": { "type": "string" } @@ -4919,6 +5322,9 @@ "XOR" ] }, + "connectBoundaryEvent": { + "type": "boolean" + }, "delayTimeInRetrial": { "type": "integer", "format": "int32" @@ -4929,6 +5335,9 @@ "httpCallInputPropertiesRollback": { "$ref": "#/definitions/ActionInput" }, + "intermediateCatchEvent": { + "$ref": "#/definitions/IntermediateCatchEvent" + }, "isAsync": { "type": "boolean" }, @@ -4948,17 +5357,25 @@ "CCCaptureAction", "addTransactionAction", "authorizePaymentWithPsp", + "cardRegistrationTimedOutAction", "confirmAuthWithPSPAction", - "eghlCapturePaymentAction", - "eghlTokenizationAction", + "customerLockAction", + "dummyAction", + "eghlHashGenerationAction", "emptyAction", "generatePaymentIdAction", - "ifredeemPointsAction", "invalid", "oAuthHttpAction", "offerEvaluationAction", - "redeemPointsAction", - "saveCCardAction" + "publishNotificationAction", + "pumpAuthNotificationAction", + "pumpAuthReversalNotificationAction", + "pumpReserveTimedOutAction", + "releaseCustomerLockAction", + "saveCCardAction", + "tokenizationReversalWithPSPAction", + "txnAddNotificationAction", + "verifyAuthWithPSPAction" ] }, "serialNumber": { @@ -4971,17 +5388,25 @@ "CCCaptureAction", "addTransactionAction", "authorizePaymentWithPsp", + "cardRegistrationTimedOutAction", "confirmAuthWithPSPAction", - "eghlCapturePaymentAction", - "eghlTokenizationAction", + "customerLockAction", + "dummyAction", + "eghlHashGenerationAction", "emptyAction", "generatePaymentIdAction", - "ifredeemPointsAction", "invalid", "oAuthHttpAction", "offerEvaluationAction", - "redeemPointsAction", - "saveCCardAction" + "publishNotificationAction", + "pumpAuthNotificationAction", + "pumpAuthReversalNotificationAction", + "pumpReserveTimedOutAction", + "releaseCustomerLockAction", + "saveCCardAction", + "tokenizationReversalWithPSPAction", + "txnAddNotificationAction", + "verifyAuthWithPSPAction" ] } }, @@ -4990,9 +5415,25 @@ "WorkflowProcess": { "type": "object", "properties": { + "brand": { + "type": "string", + "enum": [ + "SHELL" + ] + }, + "countryCode": { + "type": "string" + }, "isAsync": { "type": "boolean" }, + "merchantIDStrategy": { + "type": "string", + "enum": [ + "ORG_LEVEL", + "PER_STORE" + ] + }, "name": { "type": "string" }, @@ -5002,10 +5443,11 @@ "$ref": "#/definitions/WorkflowStep" } }, - "vertical": { + "useCase": { "type": "string", "enum": [ - "FUELLING", + "CARD_REGISTRATION", + "FUELING", "NON" ] } @@ -5021,6 +5463,16 @@ "$ref": "#/definitions/WorkflowInputAction" } }, + "boundaryEventType": { + "type": "string", + "enum": [ + "DELAYED_TIMER" + ] + }, + "delayedTimeInMillis": { + "type": "integer", + "format": "int64" + }, "maxWaitTimeInMillis": { "type": "integer", "format": "int32" @@ -5032,6 +5484,12 @@ "type": "integer", "format": "int32" }, + "startBoundaryEventActionList": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowInputAction" + } + }, "startUserStep": { "type": "boolean" } From 127bec00230070786c15f73dfcdb751babb6e27b Mon Sep 17 00:00:00 2001 From: Meghana Revanna Date: Mon, 29 Apr 2024 23:58:56 +0530 Subject: [PATCH 149/150] changed stage url (#8) --- swagger_sdk_gen.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swagger_sdk_gen.sh b/swagger_sdk_gen.sh index 484b96b0620..ab619b85535 100644 --- a/swagger_sdk_gen.sh +++ b/swagger_sdk_gen.sh @@ -8,7 +8,7 @@ if [ "$Branch" = "snapshot" ] elif [ "$Branch" = "production" ] then url="https://intouch-api-swagger.crm-staging-new.cc.capillarytech.com/swagger.json" - version="https://newapi.crm-staging-new.cc.capillarytech.com/version" + version="https://newapi.intouch-a-crm-crm-staging-new.cc.capillarytech.com/version" else " No Branch is selected" fi curl -k $version -o config.json From f1d7d83d4360d8a96091f9c87bafe4db0b9eb584 Mon Sep 17 00:00:00 2001 From: onkar-ct Date: Mon, 29 Jun 2026 17:02:23 +0530 Subject: [PATCH 150/150] Sprint ota txn v2 (#14) * Add fuelType, fuelGrade, isSubsidyRequested to TxnStatusBo in orchestrator.json * trigger ci --------- Co-authored-by: onkar-ct <> --- orchestrator.json | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/orchestrator.json b/orchestrator.json index aaa55433a45..c8ea1308369 100644 --- a/orchestrator.json +++ b/orchestrator.json @@ -5071,6 +5071,15 @@ }, "workFlowVersion": { "type": "string" + }, + "fuelType": { + "type": "string" + }, + "fuelGrade": { + "type": "string" + }, + "isSubsidyRequested": { + "type": "boolean" } }, "title": "TxnStatusBo"