Skip to content

Commit

Permalink
requested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@p-zielinski
p-zielinski committed Nov 2, 2023
1 parent 5b4e95a commit 8731043
Showing 1 changed file with 39 additions and 32 deletions.
71 changes: 39 additions & 32 deletions reference/OpenAPI.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14221,25 +14221,6 @@
"type": "object",
"description": "This data model represents the request body for the `/validations` endpoint.",
"properties": {
"options": {
"type": "object",
"description": "Configure parameters returned in the response.",
"properties": {
"expand": {
"type": "array",
"description": "Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details. \n\n| **Expand Option** | **Response Body** |\n|:---|:---|\n| [\"order\"] | - Same response as fallback response (without an options object).<br>- Order data with calculated discounts are listed in each child redeemable object.<br>- Metadata not included for each discount type. |\n| [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. |\n| [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br>- Includes `metadata` for each discount type. |\n| [\"category\"] | - Returns an expanded `categories` object, showing details about the category. |",
"items": {
"type": "string",
"enum": [
"order",
"redemption",
"redeemable",
"category"
]
}
}
}
},
"redeemables": {
"type": "array",
"minItems": 1,
Expand All @@ -14265,22 +14246,45 @@
]
}
},
"session": {
"$ref": "#/components/schemas/Session",
"description": "Schema model for session lock object. The session object is required to establish a session between multiple parallel validation and redemption requests. If you only send the type parameter in the request, then by default the session lock will be established for 7 days. Read more on establishing a validation session."
"order": {
"$ref": "#/components/schemas/OrderRequest",
"description": "Order information."
},
"customer": {
"$ref": "#/components/schemas/CustomerRequest",
"description": "Customer's information."
},
"order": {
"$ref": "#/components/schemas/OrderRequest",
"description": "Order information."
"session": {
"$ref": "#/components/schemas/Session",
"description": "Schema model for session lock object. The session object is required to establish a session between multiple parallel validation and redemption requests. If you only send the type parameter in the request, then by default the session lock will be established for 7 days. Read more on establishing a validation session."
},
"tracking_id": {
"description": "Is correspondent to Customer's source_id",
"type": "string"
},
"metadata": {
"type": "object",
"description": "A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format."
}
},
"options": {
"type": "object",
"description": "Configure parameters returned in the response.",
"properties": {
"expand": {
"type": "array",
"description": "Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details. \n\n| **Expand Option** | **Response Body** |\n|:---|:---|\n| [\"order\"] | - Same response as fallback response (without an options object).<br>- Order data with calculated discounts are listed in each child redeemable object.<br>- Metadata not included for each discount type. |\n| [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. |\n| [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br>- Includes `metadata` for each discount type. |\n| [\"category\"] | - Returns an expanded `categories` object, showing details about the category. |",
"items": {
"type": "string",
"enum": [
"order",
"redemption",
"redeemable",
"category"
]
}
}
}
},
},
"required": [
"redeemables"
Expand Down Expand Up @@ -14326,7 +14330,8 @@
"type": "string",
"description": "Redeemable's object type.",
"enum": [
"voucher"
"voucher",
"promotion_tier"
]
},
"order": {
Expand Down Expand Up @@ -14389,14 +14394,15 @@
"type": "string",
"description": "Redeemable's object type.",
"enum": [
"voucher"
"voucher",
"promotion_tier"
]
},
"result": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/e_error"
"$ref": "#/components/schemas/Error"
}
}
}
Expand All @@ -14421,7 +14427,8 @@
"type": "string",
"description": "Redeemable's object type.",
"enum": [
"voucher"
"voucher",
"promotion_tier"
]
},
"result": {
Expand Down Expand Up @@ -14494,7 +14501,7 @@
},
"inapplicable_redeemables": {
"type": "array",
"description": "Lists validation results of each redeemable. If a redeemable can be applied, the API returns `\"status\": \"APPLICABLE\"`.",
"description": "Lists validation results of each inapplicable redeemable.",
"items": {
"allOf": [
{
Expand Down Expand Up @@ -15981,7 +15988,7 @@
},
"inapplicable_redeemables": {
"type": "array",
"description": "Lists validation results of each redeemable. If a redeemable can be applied, the API returns `\"status\": \"APPLICABLE\"`.",
"description": "Lists validation results of each inapplicable redeemable.",
"items": {
"$ref": "#/components/schemas/ValidationsRedeemableInapplicable"
}
Expand Down

0 comments on commit 8731043

Please sign in to comment.