Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions SDKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ They are slightly modified from the original ones for our needs.

SDK will be generated in `./sdks` directory in the respective language folder.

## Updating SDK version:

### Dotnet:

In order to update the SDK version, we must update 2 files:
- `package.json` - script `generate-sdk-dotnet` - find and update `packageVersion=` value
- `sdks/dotnet/src/Voucherify/Voucherify.nuspec` - find and update `<version>` value

Additionally, we need to copy the updated changelog from `sdks/dotnet/readme.md` to `sdks/dotnet/src/Voucherify/Voucherify.nuspec`

## Command explanation

### `build-update-md-tables-from-openapi`
Expand Down
14 changes: 10 additions & 4 deletions mustache-templates/csharp/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ This SDK is auto-generated (except for tests), so changes made here will be over

## 🏷️ Link tags

[OpenAPI generated from tag](https://github.com/voucherifyio/voucherify-openapi/releases/tag/sdk-dotnet-8.1.0).
[OpenAPI generated from tag](https://github.com/voucherifyio/voucherify-openapi/releases/tag/sdk-dotnet-{{packageVersion}}).

## 🔐 Authorization
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
Expand Down Expand Up @@ -280,7 +280,13 @@ This SDK is auto-generated (except for tests), so changes made here will be over

## 📅 Changelog

- **2024-10-21** - `8.1.0`
- **2025-12-14** - `9.0.0`
- All POST requests now require a payload. As a result, the order of parameters in API method calls may have changed. If you encounter a build error, please check the documentation for the method you are calling.
- `OrdersImportCreateRequestBodyItem` no longer has `CreatedAt` property.
- `RelatedObjectParent` property `Amount` now is `int?` type, instead of `string?`.
- `SegmentsCreateResponseBody` and `SegmentsGetResponseBody` no longer have `InitialSyncStatus` property.
- Added support for advanced filtering while listing vouchers.
- **2025-10-21** - `8.1.0`
- **Invalid/New Enums will be parsed as null**
- **If a property is missing will be simply skipped, please ensure on your side if parameter is expected**
- Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance
Expand All @@ -292,9 +298,9 @@ This SDK is auto-generated (except for tests), so changes made here will be over
- `PointsFormula` is supported now
- `ManagementProjectsStackingRulesUpdateResponseBody` has many more properties now.
- Aligned with the latest OpenAPI definition.
- **2024-05-06** - `8.0.1`
- **2025-05-07** - `8.0.1`
- Added OAuth support for Loyalty Pending Points endpoints.
- **2024-05-06** - `8.0.0`
- **2025-05-07** - `8.0.0`
- The new version of the SDK includes coverage for all Voucherify endpoints and supports typed models.

*Previous versions of the SDK are no longer supported. We highly recommend upgrading to version 8.0.0 or newer, as it is now designated as Long-Term Support (LTS).*
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"generate-sdk-php": "npm run generate-endpoints-coverage-doc -- --generateFor=php;rm -r ./sdks/php/src;npm run prepare-open-api-for-sdk -- --language=php;java -jar openapi-generator-jar/openapi-generator-cli-7.0.1.jar generate -i ./reference/readonly-sdks/php/OpenAPI.json -g php-nextgen -o ./sdks/php -t ./mustache-templates/php-nextgen --additional-properties=variableNamingConvention=camelCase,developerOrganization=voucherify,developerOrganizationUrl=https://www.voucherify.io/,composerPackageName=rspective/voucherify,artifactVersion=5.0.3;npm run search-and-replace-in-files -- --path=php",
"generate-sdk-python": "npm run generate-endpoints-coverage-doc -- --generateFor=python;rm -r ./sdks/python/voucherify_client;npm run prepare-open-api-for-sdk -- --language=python;java -jar openapi-generator-jar/openapi-generator-cli-7.8.0.jar generate -i ./reference/readonly-sdks/python/OpenAPI.json -g python -o ./sdks/python -t ./mustache-templates/python --additional-properties=packageName=voucherify,packageVersion=6.0.0,packageUrl=https://voucherify.io/,projectName=voucherify;npm run search-and-replace-in-files -- --path=python",
"generate-sdk-js": "mv ./sdks/js/test ./sdks/js/testToRestore;scripts/clean-js-sdk-files.sh && npm run generate-endpoints-coverage-doc -- --generateFor=js;npm run prepare-open-api-for-sdk -- --language=js;java -jar openapi-generator-jar/openapi-generator-cli-7.16.0.jar generate -i ./reference/readonly-sdks/js/OpenAPI.json -g javascript -o ./sdks/js -t ./mustache-templates/javascript --additional-properties=packageName=@voucherify/sdk,projectVersion=3.0.1,packageUrl=https://voucherify.io/,projectName=voucherify,licenseName=MIT,npmName=@voucherify/sdk,npmRepository=git+https://github.com/voucherifyio/voucherify-js-sdk.git;mv ./sdks/js/test ./sdks/js/testToDelete;mv ./sdks/js/testToRestore ./sdks/js/test;rm -rf ./sdks/js/testToDelete;rm sdks/js/mocha.opts;rm sdks/js/yarn.lock;node scripts/fix-JS-sdk-types.js;node scripts/fix-JS-sdk-required-properties-types.js",
"generate-sdk-dotnet": "mv ./sdks/dotnet/src/Voucherify.Test ./sdks/dotnet/src/TMP.Test;npm run generate-endpoints-coverage-doc -- --generateFor=dotnet; npm run prepare-open-api-for-sdk -- --language=dotnet; java -jar openapi-generator-jar/openapi-generator-cli-7.12.0.jar generate -i ./reference/readonly-sdks/dotnet/OpenAPI.json -g csharp -o ./sdks/dotnet -t ./mustache-templates/csharp --additional-properties=packageCompany=Voucherify,packageCopyright=MIT,packageAuthors=Voucherify,packageTitle=VoucherifySDK,packageName=Voucherify,hideGenerationTimestamp=true,modelPropertyNaming=PascalCase,nullableReferenceTypes=false,netCoreProjectFile=true,useSourceGeneration=false,optionalMethodArgument=true,packageVersion=8.1.0,conditionalSerialization=true,optionalEmitDefaultValues=true,useDateTimeForDate=true,useDateTimeOffset=true,nullableReferenceTypes=false,targetFramework=netstandard2.0; rm -r ./sdks/dotnet/Voucherify.sln;mv ./sdks/dotnet/src/Voucherify.Test ./sdks/dotnet/src/TODELETE.Test;mv ./sdks/dotnet/src/TMP.Test ./sdks/dotnet/src/Voucherify.Test;rm -r ./sdks/dotnet/src/TODELETE.Test;rm -rf ./sdks/dotnet/src/Voucherify/bin;rm -rf ./sdks/dotnet/lib;npm run search-and-replace-in-files -- --path=dotnet;node scripts/fix-enums-in-dotnet.js;ts-node scripts/fix-dotnet-imports.ts;cd sdks/dotnet;dotnet build src/Voucherify/Voucherify.csproj && mv src/Voucherify/bin/Debug lib;nuget pack src/Voucherify/Voucherify.nuspec;cd ../..;",
"generate-sdk-dotnet": "mv ./sdks/dotnet/src/Voucherify.Test ./sdks/dotnet/src/TMP.Test;npm run generate-endpoints-coverage-doc -- --generateFor=dotnet; npm run prepare-open-api-for-sdk -- --language=dotnet; java -jar openapi-generator-jar/openapi-generator-cli-7.12.0.jar generate -i ./reference/readonly-sdks/dotnet/OpenAPI.json -g csharp -o ./sdks/dotnet -t ./mustache-templates/csharp --additional-properties=packageCompany=Voucherify,packageCopyright=MIT,packageAuthors=Voucherify,packageTitle=VoucherifySDK,packageName=Voucherify,hideGenerationTimestamp=true,modelPropertyNaming=PascalCase,nullableReferenceTypes=false,netCoreProjectFile=true,useSourceGeneration=false,optionalMethodArgument=true,packageVersion=9.0.0,conditionalSerialization=true,optionalEmitDefaultValues=true,useDateTimeForDate=true,useDateTimeOffset=true,nullableReferenceTypes=false,targetFramework=netstandard2.0; rm -r ./sdks/dotnet/Voucherify.sln;mv ./sdks/dotnet/src/Voucherify.Test ./sdks/dotnet/src/TODELETE.Test;mv ./sdks/dotnet/src/TMP.Test ./sdks/dotnet/src/Voucherify.Test;rm -r ./sdks/dotnet/src/TODELETE.Test;rm -rf ./sdks/dotnet/src/Voucherify/bin;rm -rf ./sdks/dotnet/lib;npm run search-and-replace-in-files -- --path=dotnet;node scripts/fix-enums-in-dotnet.js;ts-node scripts/fix-dotnet-imports.ts;cd sdks/dotnet;dotnet build src/Voucherify/Voucherify.csproj && mv src/Voucherify/bin/Debug lib;nuget pack src/Voucherify/Voucherify.nuspec;cd ../..;",
"generate-sdks": "concurrently \"npm run generate-sdk-ruby\" \"npm run generate-sdk-java\" \"npm run generate-sdk-php\" \"npm run generate-sdk-python\" \"npm run generate-sdk-dotnet\"",
"test-sdks": "rm -rf ./logs && mkdir -p logs && (npm run test-dotnet-sdk 2>&1 | tee ./logs/dotnet-tests.log) && echo 'Dotnet SDK test completed - check ./logs/dotnet-tests.log' && (npm run test-ruby-sdk 2>&1 | tee ./logs/ruby-tests.log) && echo 'Ruby SDK test completed - check ./logs/ruby-tests.log' && (npm run test-php-sdk 2>&1 | tee ./logs/php-tests.log) && echo 'Php SDK test completed - check ./logs/php-tests.log' && (npm run test-java-sdk 2>&1 | tee ./logs/java-tests.log) && echo 'Java SDK test completed - check ./logs/java-tests.log' && (npm run test-python-sdk 2>&1 | tee ./logs/python-tests.log) && echo 'Python SDK test completnpmred - check ./logs/python-tests.log'",
"test-python-sdk": "mkdir -p logs && rm -f ./logs/python-tests.log && (cd ./sdks/python && docker build -t python . && docker run --rm python) 2>&1 | tee ./logs/python-tests.log && echo 'Python SDK test completed - check ./logs/python-tests.log'",
Expand Down
4 changes: 2 additions & 2 deletions reference/OpenAPI.json
Original file line number Diff line number Diff line change
Expand Up @@ -26902,7 +26902,7 @@
"description": "Type of reward."
},
"amount": {
"type": "number",
"type": "integer",
"description": "Define the number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000."
}
}
Expand Down Expand Up @@ -100678,4 +100678,4 @@
}
}
}
}
}
Loading