Skip to content

Commit

Permalink
in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
@p-zielinski
p-zielinski committed Dec 1, 2023
1 parent 6232827 commit 0dd2ba5
Showing 1 changed file with 62 additions and 52 deletions.
114 changes: 62 additions & 52 deletions reference/OpenAPI.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,38 @@
"-category"
]
},
"ParameterResultListPublications": {
"type": "string",
"enum": [
"SUCCESS",
"FAILURE"
]
},
"ParameterVoucherTypeListPublications": {
"type": "string",
"enum": [
"discount",
"loyalty",
"lucky_draw"
]
},
"ParameterOrderListPublications": {
"type": "string",
"enum": [
"id",
"-id",
"voucher_code",
"-voucher_code",
"tracking_id",
"-tracking_id",
"customer_id",
"-customer_id",
"created_at",
"-created_at",
"channel",
"-channel"
]
},
"ParameterOrderListPromotionTiers": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -481,7 +513,7 @@
},
"ParameterCampaignId": {
"type": "string",
"example": "cust_nk0N1uNQ1YnupAoJGOgvsODC"
"example": "camp_rRsfatlwN7unSeUIJDCYedal"
},
"ParameterPromotionTierId": {
"type": "string",
Expand All @@ -491,6 +523,14 @@
"type": "string",
"example": "stack_KOIde7AUf08at12lZ1r3OfFL"
},
"ParameterRewardAssignmentId": {
"type": "string",
"example": "rewa_m9hEAu10KsPcLhGXiHG85aY0"
},
"ParameterRewardId": {
"type": "string",
"example": "rew_2erjvECLs92GYzKbak3QkyTV"
},
"ParameterCreatedBeforeAfter": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -47195,8 +47235,7 @@
},
{
"schema": {
"type": "string",
"example": "rewa_m9hEAu10KsPcLhGXiHG85aY0"
"$ref": "#/components/schemas/ParameterRewardAssignmentId"
},
"in": "query",
"name": "assignment_id",
Expand Down Expand Up @@ -47482,8 +47521,7 @@
"parameters": [
{
"schema": {
"type": "string",
"example": "rew_2erjvECLs92GYzKbak3QkyTV"
"$ref": "#/components/schemas/ParameterRewardId"
},
"name": "rewardId",
"in": "path",
Expand Down Expand Up @@ -47775,7 +47813,7 @@
"parameters": [
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterRewardId"
},
"name": "rewardId",
"in": "path",
Expand Down Expand Up @@ -48029,8 +48067,7 @@
"parameters": [
{
"schema": {
"type": "string",
"example": "rew_2erjvECLs92GYzKbak3QkyTV"
"$ref": "#/components/schemas/ParameterRewardId"
},
"name": "rewardId",
"in": "path",
Expand All @@ -48039,8 +48076,7 @@
},
{
"schema": {
"type": "string",
"example": "rewa_YkwQ5ezNYTQV2geodMVhTpy4"
"$ref": "#/components/schemas/ParameterRewardAssignmentId"
},
"name": "assignmentId",
"in": "path",
Expand Down Expand Up @@ -48253,16 +48289,15 @@
"parameters": [
{
"schema": {
"type": "boolean"
"$ref": "#/components/schemas/ParameterBoolean"
},
"in": "query",
"name": "join_once",
"description": "Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer."
},
{
"schema": {
"type": "string",
"example": "PROMO-1LwwzYI"
"$ref": "#/components/schemas/ParameterCode"
},
"in": "query",
"name": "voucher",
Expand All @@ -48280,8 +48315,7 @@
},
{
"schema": {
"type": "string",
"example": "custom_publication_source_id"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "source_id",
Expand All @@ -48305,7 +48339,7 @@
"style": "deepObject",
"explode": true,
"schema": {
"type": "object"
"$ref": "#/components/schemas/ParameterObject"
}
}
],
Expand Down Expand Up @@ -48542,95 +48576,71 @@
},
{
"schema": {
"type": "string",
"enum": [
"id",
"-id",
"voucher_code",
"-voucher_code",
"tracking_id",
"-tracking_id",
"customer_id",
"-customer_id",
"created_at",
"-created_at",
"channel",
"-channel"
]
"$ref": "#/components/schemas/ParameterOrderListPublications"
},
"in": "query",
"name": "order",
"description": "Sorts the results using one of the filtering options, where the dash `-` preceding a sorting option means sorting in a descending order."
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "campaign",
"description": "Filters by a given campaign name."
},
{
"schema": {
"type": "string",
"example": "cust_jl33V8ZDQJp4goU1z8DmFioo"
"$ref": "#/components/schemas/ParameterCustomerId"
},
"in": "query",
"name": "customer",
"description": "Filters by a unique customer ID."
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterCode"
},
"in": "query",
"name": "voucher",
"description": "Filters by a given voucher code."
},
{
"schema": {
"type": "string",
"enum": [
"SUCCESS",
"FAILURE"
]
"$ref": "#/components/schemas/ParameterResultListPublications"
},
"in": "query",
"name": "result",
"description": "Filters by a publication result."
},
{
"schema": {
"type": "string",
"enum": [
"discount",
"loyalty",
"lucky_draw"
]
"$ref": "#/components/schemas/ParameterVoucherTypeListPublications"
},
"in": "query",
"name": "voucher_type",
"description": "Filters by a voucher type."
},
{
"schema": {
"type": "boolean"
"$ref": "#/components/schemas/ParameterBoolean"
},
"in": "query",
"name": "is_referral_code",
"description": "This filter works only for the `true` option. If set to `true`, the query returns only publications of codes from referral campaigns. "
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "filters",
"description": "Allows for combining the filters mentioned in the endpoint description."
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "source_id",
Expand Down Expand Up @@ -48806,7 +48816,7 @@
"parameters": [
{
"schema": {
"type": "boolean"
"$ref": "#/components/schemas/ParameterBoolean"
},
"in": "query",
"name": "join_once",
Expand Down Expand Up @@ -50560,15 +50570,15 @@
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "tracking_id",
"description": "A tracking identifier of a user that validated the voucher. This identifier is generated during voucher validation based on your internal ID (e.g., email, database ID) during the first request. This is a hashed customer source ID. If the request is performed for the first time, pass the internal ID to track the customer. **Although not all information is required, the extra information helps prevent fraud.**"
},
{
"schema": {
"type": "string"
"$ref": "#/components/schemas/ParameterString"
},
"in": "query",
"name": "amount",
Expand Down

0 comments on commit 0dd2ba5

Please sign in to comment.