Skip to content

Commit eae9516

Browse files
noffnoff
authored
Merge pull request #9 from rees46/feat/member-object
feat: extract member props to separate object
2 parents c050ae9 + f21ec6d commit eae9516

4 files changed

Lines changed: 55 additions & 37 deletions

File tree

‎docs/integration/loyalty/subscriptions/join.md‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,13 @@ curl --header "Content-Type: application/json" \
5858
"success": true,
5959
"payload": {
6060
"message": "Member is joined to subscription",
61-
"identifier": "...",
62-
"subscription": "...",
63-
"plan": "...",
64-
"paid_till": "...",
65-
"limits_reset_date": "..."
61+
"member": {
62+
"identifier": "...",
63+
"subscription": "...",
64+
"plan": "...",
65+
"paid_till": "...",
66+
"limits_reset_date": "..."
67+
}
6668
}
6769
}
6870
```
@@ -80,12 +82,13 @@ curl --header "Content-Type: application/json" \
8082

8183
Расшифровка ответа:
8284

83-
| Параметр | Описание |
84-
|---------------------------|----------------------------------------------------------------------|
85-
| success | Запрос выполнен успешно или нет |
86-
| payload.message | Сообщение с результатом обработки запроса |
87-
| payload.identifier | Идентификатор участника программы лояльности в формате `7XXXXXXXXXX` |
88-
| payload.subscription | Уникальный код подписки |
89-
| payload.plan | Уникальный код плана |
90-
| payload.paid_till | Дата, до которой оплачена подписка |
91-
| payload.limits_reset_date | Дата, когда будет выполнен следующий сброс лимитов |
85+
| Параметр | Описание |
86+
|----------------------------------|----------------------------------------------------|
87+
| success | Запрос выполнен успешно или нет |
88+
| payload.message | Сообщение с результатом обработки запроса |
89+
| payload.member | Объект подписчика |
90+
| payload.member.identifier | Идентификатор подписчика |
91+
| payload.member.subscription | Уникальный код подписки |
92+
| payload.member.plan | Уникальный код плана |
93+
| payload.member.paid_till | Дата, до которой оплачена подписка |
94+
| payload.member.limits_reset_date | Дата, когда будет выполнен следующий сброс лимитов |

‎docs/integration/loyalty/subscriptions/leave.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,13 @@ curl --header "Content-Type: application/json" \
4949
"success": true,
5050
"payload": {
5151
"message": "The subscription is cancelled",
52-
"identifier": "...",
53-
"subscription": "..."
52+
"member": {
53+
"identifier": "...",
54+
"subscription": "...",
55+
"plan": "...",
56+
"paid_till": "...",
57+
"limits_reset_date": "..."
58+
}
5459
}
5560
}
5661
```
@@ -68,9 +73,10 @@ curl --header "Content-Type: application/json" \
6873

6974
Расшифровка ответа:
7075

71-
| Параметр | Описание |
72-
|---------------------------|----------------------------------------------------------------------|
73-
| success | Запрос выполнен успешно или нет |
74-
| payload.message | Сообщение с результатом обработки запроса |
75-
| payload.identifier | Идентификатор участника программы лояльности в формате `7XXXXXXXXXX` |
76-
| payload.subscription | Уникальный код подписки |
76+
| Параметр | Описание |
77+
|-----------------------------|----------------------------------------------------------------------|
78+
| success | Запрос выполнен успешно или нет |
79+
| payload.message | Сообщение с результатом обработки запроса |
80+
| payload.member | Объект подписчика |
81+
| payload.member.identifier | Идентификатор участника программы лояльности в формате `7XXXXXXXXXX` |
82+
| payload.member.subscription | Уникальный код подписки |

‎docs/integration/loyalty/subscriptions/members.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@ curl https://api.rees46.ru/loyalty/subscriptions/members?shop_id=...&shop_secret
4040
"paid_till": "...",
4141
"limits_reset_date": "..."
4242
},
43-
...
43+
{
44+
"identifier": "...",
45+
"subscription": "...",
46+
"plan": "...",
47+
"paid_till": "...",
48+
"limits_reset_date": "..."
49+
}
4450
]
4551
}
4652
}

‎docs/integration/loyalty/subscriptions/prolong.md‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ curl --header "Content-Type: application/json" \
4949
"success": true,
5050
"payload": {
5151
"message": "The subscription is prolonged",
52-
"identifier": "...",
53-
"subscription": "...",
54-
"plan": "...",
55-
"paid_till": "...",
56-
"limits_reset_date": "..."
52+
"member": {
53+
"identifier": "...",
54+
"subscription": "...",
55+
"plan": "...",
56+
"paid_till": "...",
57+
"limits_reset_date": "..."
58+
}
5759
}
5860
}
5961
```
@@ -71,12 +73,13 @@ curl --header "Content-Type: application/json" \
7173

7274
Расшифровка ответа:
7375

74-
| Параметр | Описание |
75-
|---------------------------|----------------------------------------------------------------------|
76-
| success | Запрос выполнен успешно или нет |
77-
| payload.message | Сообщение с результатом обработки запроса |
78-
| payload.identifier | Идентификатор участника программы лояльности в формате `7XXXXXXXXXX` |
79-
| payload.subscription | Уникальный код подписки |
80-
| payload.plan | Уникальный код плана |
81-
| payload.paid_till | Дата, до которой оплачена подписка |
82-
| payload.limits_reset_date | Дата, когда будет выполнен следующий сброс лимитов |
76+
| Параметр | Описание |
77+
|----------------------------------|----------------------------------------------------------------------|
78+
| success | Запрос выполнен успешно или нет |
79+
| payload.message | Сообщение с результатом обработки запроса |
80+
| payload.member | Объект подписчика |
81+
| payload.member.identifier | Идентификатор участника программы лояльности в формате `7XXXXXXXXXX` |
82+
| payload.member.subscription | Уникальный код подписки |
83+
| payload.member.plan | Уникальный код плана |
84+
| payload.member.paid_till | Дата, до которой оплачена подписка |
85+
| payload.member.limits_reset_date | Дата, когда будет выполнен следующий сброс лимитов |

0 commit comments

Comments
 (0)