Skip to content

Commit

Permalink
replace RewardAssignemnt with reward_assignment
Browse files Browse the repository at this point in the history
  • Loading branch information
@weronika-kurczyna
weronika-kurczyna committed Oct 18, 2023
1 parent 6076878 commit 0558762
Showing 1 changed file with 92 additions and 153 deletions.
245 changes: 92 additions & 153 deletions reference/OpenAPI.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9465,123 +9465,6 @@
}
}
},
"reward_base": {
"title": "Reward Object Base",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Reward name."
},
"stock": {
"type": [
"integer",
"null"
],
"description": "Configurable for **material rewards**. The number of units of the product that you want to share as reward."
},
"redeemed": {
"type": [
"integer",
"null"
],
"description": "Defines the number of already invoked (successful) reward redemptions.\t"
},
"attributes": {
"type": "object",
"description": "These properties are configurable for **material rewards**.",
"properties": {
"image_url": {
"type": "string",
"description": "The HTTPS URL pointing to the .png or .jpg file."
},
"description": {
"type": "string",
"description": "An arbitrary string that you can attach to a material reward."
}
}
},
"metadata": {
"type": "object",
"description": "The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format."
}
},
"required": [
"name",
"stock",
"redeemed",
"attributes",
"metadata"
]
},
"reward_identity": {
"title": "Reward Object Identity",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
"description": "Unique reward ID, assigned by Voucherify."
}
},
"required": [
"id"
]
},
"reward_response_data": {
"title": "Reward Object Response Data",
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "Timestamp representing the date and time when the reward was created in ISO 8601 format.",
"example": "2022-08-11T14:49:22.586Z",
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"description": "Timestamp representing the date and time when the reward was updated in ISO 8601 format.",
"example": "2022-08-11T16:01:34.885Z",
"format": "date-time"
},
"object": {
"description": "The type of object represented by the JSON. This object stores information about the reward.",
"enum": [
"reward"
]
}
},
"required": [
"created_at",
"updated_at",
"object"
]
},
"reward": {
"title": "Reward",
"description": "This is an object representing a reward.",
"x-tags": [
"REWARDS API"
],
"allOf": [
{
"$ref": "#/components/schemas/reward_identity"
},
{
"$ref": "#/components/schemas/reward_base"
},
{
"$ref": "#/components/schemas/reward_type"
},
{
"$ref": "#/components/schemas/reward_response_data"
}
],
"type": "object"
},
"4_obj_reward_object": {
"title": "Reward Object",
"type": "object",
Expand Down Expand Up @@ -41190,64 +41073,120 @@
"user_id"
]
},
"RewardAssignment": {
"title": "Reward Assignment",
"reward": {
"title": "Reward",
"description": "This is an object representing a reward.",
"x-tags": [
"REWARDS API"
],
"allOf": [
{
"$ref": "#/components/schemas/reward_identity"
},
{
"$ref": "#/components/schemas/reward_base"
},
{
"$ref": "#/components/schemas/reward_type"
},
{
"$ref": "#/components/schemas/reward_response_data"
}
],
"type": "object"
},
"reward_base": {
"title": "Reward Object Base",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique reward assignment ID, assigned by Voucherify."
},
"reward_id": {
"name": {
"type": "string",
"description": "Associated reward ID."
"description": "Reward name."
},
"related_object_id": {
"type": "string",
"description": "Related object ID to which the reward was assigned."
"stock": {
"type": [
"integer",
"null"
],
"description": "Configurable for **material rewards**. The number of units of the product that you want to share as reward."
},
"related_object_type": {
"type": "string",
"description": "Related object type to which the reward was assigned."
"redeemed": {
"type": [
"integer",
"null"
],
"description": "Defines the number of already invoked (successful) reward redemptions.\t"
},
"parameters": {
"attributes": {
"type": "object",
"description": "Defines the cost of the reward.",
"description": "These properties are configurable for **material rewards**.",
"properties": {
"loyalty": {
"type": "object",
"description": "Defines the equivalent points value of the reward.",
"properties": {
"points": {
"type": "integer",
"description": "The number of points required to redeem the reward."
}
},
"required": [
"points"
]
"image_url": {
"type": "string",
"description": "The HTTPS URL pointing to the .png or .jpg file."
},
"description": {
"type": "string",
"description": "An arbitrary string that you can attach to a material reward."
}
}
},
"metadata": {
"type": "object",
"description": "The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format."
}
},
"required": [
"name",
"stock",
"redeemed",
"attributes",
"metadata"
]
},
"reward_identity": {
"title": "Reward Object Identity",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "rew_nIy4gHpQHle2c3pNMwuj7G6j",
"description": "Unique reward ID, assigned by Voucherify."
}
},
"required": [
"id"
]
},
"reward_response_data": {
"title": "Reward Object Response Data",
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "Timestamp representing the date and time when the reward assignment was created in ISO 8601 format.",
"description": "Timestamp representing the date and time when the reward was created in ISO 8601 format.",
"example": "2022-08-11T14:49:22.586Z",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "Timestamp representing the date and time when the reward assignment was updated in ISO 8601 format.",
"type": [
"string",
"null"
],
"description": "Timestamp representing the date and time when the reward was updated in ISO 8601 format.",
"example": "2022-08-11T16:01:34.885Z",
"format": "date-time"
},
"object": {
"type": "string",
"description": "The type of object represented by the JSON. This object stores information about the reward assignment."
"description": "The type of object represented by the JSON. This object stores information about the reward.",
"enum": [
"reward"
]
}
},
"required": [
"id",
"reward_id",
"created_at",
"updated_at",
"object"
]
},
Expand Down Expand Up @@ -43629,7 +43568,7 @@
}
},
"LoyaltiesGetRewardAssignmentResponseBody": {
"$ref": "#/components/schemas/RewardAssignment"
"$ref": "#/components/schemas/reward_assignment"
},
"LoyaltiesGetRewardDetailsResponseBody": {
"$ref": "#/components/schemas/Reward"
Expand Down

0 comments on commit 0558762

Please sign in to comment.