renames in progress

voucherifyio · Nov 29, 2023 · 7b167e6 · 7b167e6
1 parent 1c5f1f9
commit 7b167e6
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 44 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -660,8 +660,8 @@ Added `required` and `description` attributes in `LoyaltiesListMemberRewardsResp
 ## 20231025 - Vouchers
 
 **Changes in models**
-- Removed `gift_card_transaction_identity`, `gift_card_transaction_created` - these types were combined into the `gift_card_transaction_base` model
-- Fixed the enum defined for `fields` property in `voucher_transactions_export_parameters` and `voucher_transactions_filters` models
+- Removed `GiftCardTransactionIdentity`, `GiftCardTransactionCreated` - these types were combined into the `GiftCardTransactionBase` model
+- Fixed the enum defined for `fields` property in `VoucherTransactionsExportParameters` and `VoucherTransactionsFilters` models
 
 ## 20231025 - List Loyalty Tiers
 
@@ -788,35 +788,35 @@ Endpoint change:
 **New models**
 - vouchers_list_vouchers_transactions_response_body (old `1_res_vouchers_code_transactions`)
 - voucher_transaction (old `1_obj_gift_card_transaction_object`)
-- gift_card_transaction
-- gift_card_transaction_identity
-- gift_card_transaction_base
-- gift_card_transaction_created
-- gift_card_transaction_details
-- gift_card_transaction_redemption_details (old `1_obj_gift_card_transaction_object_redemption`)
-- gift_card_transaction_refund_details (old `1_obj_gift_card_transaction_object_refund`)
-- gift_card_transaction_addition_details (old `1_obj_gift_card_transaction_object_addition`)
-- gift_card_transaction_removal_details (old `1_obj_gift_card_transaction_object_removal`)
-
-- vouchers_export_transactions_request_body (old `1_req_create_gift_card_transactions_export`
-- voucher_transactions_export (old `1_obj_export_transactions_object`)
-- voucher_transactions_export_parameters (old `1_obj_export_gift_card_transactions`)
-- voucher_transactions_filters (old `16_obj_export_gift_card_transactions`)
-- voucher_transactions_export_filter_conditions (old `16_obj_filter_gift_card_transactions_voucher_id`)
+- GiftCardTransaction
+- GiftCardTransactionIdentity
+- GiftCardTransactionBase
+- GiftCardTransactionCreated
+- GiftCardTransactionDetails
+- GiftCardTransactionRedemptionDetails (old `1_obj_gift_card_transaction_object_redemption`)
+- GiftCardTransactionRefundDetails (old `1_obj_gift_card_transaction_object_refund`)
+- GiftCardTransactionAdditionDetails (old `1_obj_gift_card_transaction_object_addition`)
+- GiftCardTransactionRemovalDetails (old `1_obj_gift_card_transaction_object_removal`)
+
+- VouchersExportTransactionsRequestBody (old `1_req_create_gift_card_transactions_export`
+- VoucherTransactionsExport (old `1_obj_export_transactions_object`)
+- VoucherTransactionsExportParameters (old `1_obj_export_gift_card_transactions`)
+- VoucherTransactionsFilters (old `16_obj_export_gift_card_transactions`)
+- VoucherTransactionsExportFilterConditions (old `16_obj_filter_gift_card_transactions_voucher_id`)
 
 - validation_rules_list_rules_assignments_response_body (old `13_res_validation-rules_validationRuleId_assignments`)
 - validation_rule_assignment (old `13_obj_validation_rule_assignment_object`)
 
 **Removed models**
-- `8_obj_export_loyalty_card_transactions` - used only in one place, replaced with: `voucher_transactions_export_parameters` in `8_req_create_loyalty_card_transactions_export` schema
+- `8_obj_export_loyalty_card_transactions` - used only in one place, replaced with: `VoucherTransactionsExportParameters` in `8_req_create_loyalty_card_transactions_export` schema
 
 **Endpoint changes**
 
 - Added missing method for endpoint: GET `/vouchers/{code}/transactions (client.vouchers.listTransactions(code, query))`
     - Response body schema: `vouchers_list_vouchers_transactions_response_body`
 
 - Added missing method for endpoint: POST `/vouchers/{code}/transactions/export (client.vouchers.exportTransactions(code, body))`
-    - Request body schema: `vouchers_export_transactions_request_body`
+    - Request body schema: `VouchersExportTransactionsRequestBody`
 
 - Added missing method for endpoint: GET `/validation-rules-assignments (client.client.validationRules.listRulesAssignments(validationRuleId))`
     - Request body schema: `validation_rules_list_rules_assignments_response_body`

diff --git a/reference/OpenAPI.json b/reference/OpenAPI.json
@@ -5857,64 +5857,65 @@
         "description": "List of voucher transactions",
         "oneOf": [
           {
-            "$ref": "#/components/schemas/gift_card_transaction"
+            "$ref": "#/components/schemas/GiftCardTransaction"
           },
           {
             "$ref": "#/components/schemas/LoyaltyCardTransaction"
           }
         ]
       },
-      "gift_card_transaction": {
+
+      "GiftCardTransaction": {
         "title": "Gift Card Transaction",
         "description": "List of gift card transactions",
         "oneOf": [
           {
             "title": "Redemption",
             "allOf": [
               {
-                "$ref": "#/components/schemas/gift_card_transaction_base"
+                "$ref": "#/components/schemas/GiftCardTransactionBase"
               },
               {
-                "$ref": "#/components/schemas/gift_card_transaction_redemption_details"
+                "$ref": "#/components/schemas/GiftCardTransactionRedemptionDetails"
               }
             ]
           },
           {
             "title": "Refund",
             "allOf": [
               {
-                "$ref": "#/components/schemas/gift_card_transaction_base"
+                "$ref": "#/components/schemas/GiftCardTransactionBase"
               },
               {
-                "$ref": "#/components/schemas/gift_card_transaction_refund_details"
+                "$ref": "#/components/schemas/GiftCardTransactionRefundDetails"
               }
             ]
           },
           {
             "title": "Addition",
             "allOf": [
               {
-                "$ref": "#/components/schemas/gift_card_transaction_base"
+                "$ref": "#/components/schemas/GiftCardTransactionBase"
               },
               {
-                "$ref": "#/components/schemas/gift_card_transaction_addition_details"
+                "$ref": "#/components/schemas/GiftCardTransactionAdditionDetails"
               }
             ]
           },
           {
             "title": "Removal",
             "allOf": [
               {
-                "$ref": "#/components/schemas/gift_card_transaction_base"
+                "$ref": "#/components/schemas/GiftCardTransactionBase"
               },
               {
-                "$ref": "#/components/schemas/gift_card_transaction_removal_details"
+                "$ref": "#/components/schemas/GiftCardTransactionRemovalDetails"
               }
             ]
           }
         ]
       },
-      "gift_card_transaction_base": {
+      "GiftCardTransactionBase": {
         "type": "object",
         "title": "Gift Card Transaction Base",
         "properties": {
@@ -5974,7 +5975,7 @@
           "created_at"
         ]
       },
-      "gift_card_transaction_redemption_details": {
+      "GiftCardTransactionRedemptionDetails": {
         "title": "Redemption",
         "description": "When credits are used to pay for an order.",
         "type": "object",
@@ -6113,7 +6114,7 @@
           "details"
         ]
       },
-      "gift_card_transaction_refund_details": {
+      "GiftCardTransactionRefundDetails": {
         "title": "Refund",
         "description": "When funds are credited back to a card through a redemption rollback.",
         "type": "object",
@@ -6267,7 +6268,7 @@
           "details"
         ]
       },
-      "gift_card_transaction_addition_details": {
+      "GiftCardTransactionAdditionDetails": {
         "title": "Addition",
         "description": "When funds are deposited to a gift card.",
         "type": "object",
@@ -6376,7 +6377,7 @@
           "details"
         ]
       },
-      "gift_card_transaction_removal_details": {
+      "GiftCardTransactionRemovalDetails": {
         "title": "Removal",
         "description": "When funds are removed from a gift card.",
         "type": "object",
@@ -6485,18 +6486,18 @@
           "details"
         ]
       },
-      "vouchers_export_transactions_request_body": {
+      "VouchersExportTransactionsRequestBody": {
         "type": "object",
         "title": "Create Gift Card Transactions Export Request Body",
         "description": "Request body schema for **POST** `/vouchers/transactions/export`.",
         "properties": {
           "parameters": {
-            "$ref": "#/components/schemas/voucher_transactions_export_parameters",
+            "$ref": "#/components/schemas/VoucherTransactionsExportParameters",
             "description": "Contains the parameters that define the data to be exported."
           }
         }
       },
-      "voucher_transactions_export_parameters": {
+      "VoucherTransactionsExportParameters": {
         "description": "List of available fields and filters that can be exported with a gift card or loyalty card transactions export along with the sorting order of the returned data.",
         "title": "Export Transactions",
         "type": "object",
@@ -6532,7 +6533,7 @@
           }
         }
       },
-      "voucher_transactions_export": {
+      "VoucherTransactionsExport": {
         "title": "Export",
         "type": "object",
         "description": "This is an object representing an export. \n\n Using this endpoint, you can export voucher transactions as a CSV file. This functionality works asynchronously and comes down to the following steps: create an export object and return its id so you can track its status, trigger a CSV file generation, change the status to SCHEDULED when the generation is over, store the file in S3 and change the status to DONE. Now you can download it.\n\nWith parameters you can select which fields will be exported. An export request will almost always result in a single file being generated by the system. However, when your volume of data is large, the system may split the results into multiple chunks.",
@@ -6577,7 +6578,7 @@
             ]
           },
           "parameters": {
-            "$ref": "#/components/schemas/voucher_transactions_filters"
+            "$ref": "#/components/schemas/VoucherTransactionsFilters"
           },
           "result": {
             "type": [
@@ -30264,7 +30265,7 @@
           }
         }
       },
-      "voucher_transactions_filters": {
+      "VoucherTransactionsFilters": {
         "description": "List of available fields and filters that can be exported with gift card or loyalty card transactions along with the sorting order of the returned data.",
         "title": "Voucher Transactions",
         "type": "object",
@@ -30299,7 +30300,7 @@
             }
           },
           "filters": {
-            "$ref": "#/components/schemas/voucher_transactions_export_filter_conditions"
+            "$ref": "#/components/schemas/VoucherTransactionsExportFilterConditions"
           }
         },
         "required": [
@@ -30580,7 +30581,7 @@
           }
         }
       },
-      "voucher_transactions_export_filter_conditions": {
+      "VoucherTransactionsExportFilterConditions": {
         "description": "Filter condition.",
         "title": "Filter by voucher ID",
         "type": "object",
@@ -43026,7 +43027,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/vouchers_export_transactions_request_body"
+                "$ref": "#/components/schemas/VouchersExportTransactionsRequestBody"
               },
               "examples": {
                 "Example": {
@@ -43059,7 +43060,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/voucher_transactions_export"
+                  "$ref": "#/components/schemas/VoucherTransactionsExport"
                 },
                 "examples": {
                   "Example": {