Skip to content

Commit

Permalink
remove required on everything
Browse files Browse the repository at this point in the history
  • Loading branch information
@p-zielinski
p-zielinski committed Jul 8, 2024
1 parent f4d9409 commit 0f94f49
Show file tree
Hide file tree
Showing 904 changed files with 8,154 additions and 12,445 deletions.
762 changes: 12 additions & 750 deletions api/openapi.yaml
View file

Large diffs are not rendered by default.

33 changes: 16 additions & 17 deletions docs/ApplicableTo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**_object** | [**ObjectEnum**](#ObjectEnum) | This object stores information about the product collection. | |
|**id** | **String** | Unique product collection ID assigned by Voucherify. | |
|**sourceId** | **String** | The source ID from your inventory system. | [optional] |
|**productId** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] |
|**productSourceId** | **String** | Parent product's source ID from your inventory system. | [optional] |
|**strict** | **Boolean** | | |
|**price** | **BigDecimal** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. | [optional] |
|**priceFormula** | **BigDecimal** | Formula used to calculate the discounted price of an item. | [optional] |
|**effect** | **ApplicableToEffect** | | |
|**quantityLimit** | **Integer** | The maximum number of units allowed to be discounted per order line item. | [optional] |
|**aggregatedQuantityLimit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
|**amountLimit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
|**aggregatedAmountLimit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] |
|**orderItemIndices** | **List<Integer>** | | [optional] |
| Name | Type | Description |
|------------ | ------------- | ------------- |
|**_object** | [**ObjectEnum**](#ObjectEnum) | This object stores information about the product collection. |
|**id** | **String** | Unique product collection ID assigned by Voucherify. |
|**sourceId** | **String** | The source ID from your inventory system. |
|**productId** | **String** | Parent product's unique ID assigned by Voucherify. |
|**productSourceId** | **String** | Parent product's source ID from your inventory system. |
|**strict** | **Boolean** | |
|**price** | **BigDecimal** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. |
|**priceFormula** | **BigDecimal** | Formula used to calculate the discounted price of an item. |
|**effect** | **ApplicableToEffect** | |
|**quantityLimit** | **Integer** | The maximum number of units allowed to be discounted per order line item. |
|**aggregatedQuantityLimit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. |
|**amountLimit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. |
|**aggregatedAmountLimit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) |
|**orderItemIndices** | **List<Integer>** | |



Expand All @@ -31,7 +31,6 @@
| PRODUCT | "product" |
| SKU | "sku" |
| PRODUCTS_COLLECTION | "products_collection" |
| UNKNOWN_ENUM | "unknown_enum" |



2 changes: 0 additions & 2 deletions docs/ApplicableToEffect.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,5 @@

* `MOST_EXPENSIVE` (value: `"APPLY_TO_MOST_EXPENSIVE"`)

* `UNKNOWN_ENUM` (value: `"unknown_enum"`)



14 changes: 6 additions & 8 deletions docs/ApplicableToResultList.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**data** | [**List<ApplicableTo>**](ApplicableTo.md) | Contains array of items to which the discount can apply. | |
|**total** | **Integer** | Total number of objects defining included products, SKUs, or product collections. | |
|**_object** | [**ObjectEnum**](#ObjectEnum) | The type of the object represented by JSON. | |
|**dataRef** | [**DataRefEnum**](#DataRefEnum) | The type of the object represented by JSON. | |
| Name | Type | Description |
|------------ | ------------- | ------------- |
|**data** | [**List<ApplicableTo>**](ApplicableTo.md) | Contains array of items to which the discount can apply. |
|**total** | **Integer** | Total number of objects defining included products, SKUs, or product collections. |
|**_object** | [**ObjectEnum**](#ObjectEnum) | The type of the object represented by JSON. |
|**dataRef** | [**DataRefEnum**](#DataRefEnum) | The type of the object represented by JSON. |



Expand All @@ -19,7 +19,6 @@
| Name | Value |
|---- | -----|
| LIST | "list" |
| UNKNOWN_ENUM | "unknown_enum" |



Expand All @@ -28,7 +27,6 @@
| Name | Value |
|---- | -----|
| DATA | "data" |
| UNKNOWN_ENUM | "unknown_enum" |



6 changes: 3 additions & 3 deletions docs/AsyncActions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Response to requests that are processed asynchronously.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**asyncActionId** | **String** | The ID of the scheduled asynchronous action. | |
| Name | Type | Description |
|------------ | ------------- | ------------- |
|**asyncActionId** | **String** | The ID of the scheduled asynchronous action. |



24 changes: 11 additions & 13 deletions docs/BusValRuleAssignment.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ Assignments of business validation rule

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The unique identifier for a assignment | |
|**ruleId** | **String** | The unique identifier for a rule | |
|**relatedObjectId** | **String** | The unique identifier for a related object | |
|**relatedObjectType** | **String** | The type of related object | |
|**createdAt** | **OffsetDateTime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
|**updatedAt** | **OffsetDateTime** | Timestamp representing the date and time when the object was last updated in ISO 8601 format. | [optional] |
|**_object** | [**ObjectEnum**](#ObjectEnum) | The type of the object represented by JSON. | |
|**validationStatus** | [**ValidationStatusEnum**](#ValidationStatusEnum) | The validation status of the assignment | [optional] |
|**validationOmittedRules** | **List<String>** | The list of omitted rules | [optional] |
| Name | Type | Description |
|------------ | ------------- | ------------- |
|**id** | **String** | The unique identifier for a assignment |
|**ruleId** | **String** | The unique identifier for a rule |
|**relatedObjectId** | **String** | The unique identifier for a related object |
|**relatedObjectType** | **String** | The type of related object |
|**createdAt** | **OffsetDateTime** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. |
|**updatedAt** | **OffsetDateTime** | Timestamp representing the date and time when the object was last updated in ISO 8601 format. |
|**_object** | [**ObjectEnum**](#ObjectEnum) | The type of the object represented by JSON. |
|**validationStatus** | [**ValidationStatusEnum**](#ValidationStatusEnum) | The validation status of the assignment |
|**validationOmittedRules** | **List<String>** | The list of omitted rules |



Expand All @@ -25,7 +25,6 @@ Assignments of business validation rule
| Name | Value |
|---- | -----|
| VALIDATION_RULES_ASSIGNMENT | "validation_rules_assignment" |
| UNKNOWN_ENUM | "unknown_enum" |



Expand All @@ -36,7 +35,6 @@ Assignments of business validation rule
| VALID | "VALID" |
| PARTIALLY_VALID | "PARTIALLY_VALID" |
| INVALID | "INVALID" |
| UNKNOWN_ENUM | "unknown_enum" |



71 changes: 33 additions & 38 deletions docs/Campaign.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,39 @@

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | Unique campaign ID, assigned by Voucherify. | |
|**name** | **String** | Campaign name. | |
|**description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
|**campaignType** | [**CampaignTypeEnum**](#CampaignTypeEnum) | Type of campaign. | |
|**type** | [**TypeEnum**](#TypeEnum) | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published | |
|**voucher** | [**CampaignVoucher**](CampaignVoucher.md) | | [optional] |
|**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | |
|**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | |
|**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | |
|**validityTimeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) | | [optional] |
|**validityDayOfWeek** | [**List<ValidityDayOfWeekEnum>**](#List<ValidityDayOfWeekEnum>) | Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
|**validityHours** | [**ValidityHours**](ValidityHours.md) | | [optional] |
|**activityDurationAfterPublishing** | **String** | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. | [optional] |
|**vouchersCount** | **Integer** | Total number of unique vouchers in campaign. | [optional] |
|**startDate** | **OffsetDateTime** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. | [optional] |
|**expirationDate** | **OffsetDateTime** | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. | [optional] |
|**active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
|**metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
|**createdAt** | **OffsetDateTime** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | |
|**updatedAt** | **OffsetDateTime** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
|**category** | **String** | Unique category name. | [optional] |
|**creationStatus** | [**CreationStatusEnum**](#CreationStatusEnum) | Indicates the status of the campaign creation. | |
|**vouchersGenerationStatus** | [**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum) | Indicates the status of the campaign's voucher generation. | |
|**_protected** | **Boolean** | Indicates whether the resource can be deleted. | |
|**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] |
|**categories** | [**List<Category>**](Category.md) | Contains details about the category. | |
|**_object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | |
|**referralProgram** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|**promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] |
|**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] |
| Name | Type | Description |
|------------ | ------------- | ------------- |
|**id** | **String** | Unique campaign ID, assigned by Voucherify. |
|**name** | **String** | Campaign name. |
|**description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. |
|**campaignType** | [**CampaignTypeEnum**](#CampaignTypeEnum) | Type of campaign. |
|**type** | [**TypeEnum**](#TypeEnum) | Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published |
|**voucher** | [**CampaignVoucher**](CampaignVoucher.md) | |
|**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |
|**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. |
|**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. |
|**validityTimeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) | |
|**validityDayOfWeek** | [**List<ValidityDayOfWeekEnum>**](#List<ValidityDayOfWeekEnum>) | Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |
|**validityHours** | [**ValidityHours**](ValidityHours.md) | |
|**activityDurationAfterPublishing** | **String** | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. |
|**vouchersCount** | **Integer** | Total number of unique vouchers in campaign. |
|**startDate** | **OffsetDateTime** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. |
|**expirationDate** | **OffsetDateTime** | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. |
|**active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign |
|**metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. |
|**createdAt** | **OffsetDateTime** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. |
|**updatedAt** | **OffsetDateTime** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. |
|**category** | **String** | Unique category name. |
|**creationStatus** | [**CreationStatusEnum**](#CreationStatusEnum) | Indicates the status of the campaign creation. |
|**vouchersGenerationStatus** | [**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum) | Indicates the status of the campaign's voucher generation. |
|**_protected** | **Boolean** | Indicates whether the resource can be deleted. |
|**categoryId** | **String** | Unique category ID that this campaign belongs to. |
|**categories** | [**List<Category>**](Category.md) | Contains details about the category. |
|**_object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. |
|**referralProgram** | [**ReferralProgram**](ReferralProgram.md) | |
|**loyaltyTiersExpiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | |
|**promotion** | [**PromotionTiersList**](PromotionTiersList.md) | |
|**validationRulesAssignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | |



Expand All @@ -51,7 +51,6 @@
| PROMOTION | "PROMOTION" |
| REFERRAL_PROGRAM | "REFERRAL_PROGRAM" |
| LUCKY_DRAW | "LUCKY_DRAW" |
| UNKNOWN_ENUM | "unknown_enum" |



Expand All @@ -61,7 +60,6 @@
|---- | -----|
| AUTO_UPDATE | "AUTO_UPDATE" |
| STATIC | "STATIC" |
| UNKNOWN_ENUM | "unknown_enum" |



Expand All @@ -76,7 +74,6 @@
| NUMBER_4 | 4 |
| NUMBER_5 | 5 |
| NUMBER_6 | 6 |
| NUMBER_unknown_enum | 11184809 |



Expand All @@ -89,7 +86,6 @@
| FAILED | "FAILED" |
| DRAFT | "DRAFT" |
| MODIFYING | "MODIFYING" |
| UNKNOWN_ENUM | "unknown_enum" |



Expand All @@ -102,7 +98,6 @@
| FAILED | "FAILED" |
| DRAFT | "DRAFT" |
| MODIFYING | "MODIFYING" |
| UNKNOWN_ENUM | "unknown_enum" |



Loading

0 comments on commit 0f94f49

Please sign in to comment.