Pz/types 010 - loyalties members #238
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcin-slezak
requested changes
Oct 3, 2023
packages/sdk/README.md
Outdated
| @@ -1064,6 +1072,12 @@ client.loyalties.createMember(campaignId, member) | |||
| client.loyalties.getMember(campaignId, memberId) | |||
| ``` | |||
|
|
|||
| #### [Get Loyalty Program Member Without CampaignId](https://docs.voucherify.io/reference/get-member-1) | |||
There was a problem hiding this comment.
Few issues here:
- The header and method name suggest that we do not need a campaign ID, but you expect it in params and link to documentation where the campaign ID is required.
- I do not like naming. I understand that we have two similar endpoints, one that expects just member ID and the second one that needs campaign ID in addition. In documentation, both are described as
Get Member. I guess (but we can confirm it) that the one that needs a campaign ID is a legacy one. We should give a name that will be intuitive for a developer who does not know about the context (legacy method). So, maybegetMemberById?
packages/sdk/README.md
Outdated
| #### [Add Or Remove Loyalty Card Balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1) | ||
|
|
||
| ```javascript | ||
| client.loyalties.addOrRemoveLoyaltyCardBalance(memberId, balance, campaignId) |
There was a problem hiding this comment.
Naming: addOrRemoveLoyaltyCardBalance -> addOrRemoveCardBalance?
p-zielinski
commented
Oct 4, 2023
marcin-slezak
requested changes
Oct 5, 2023
marcin-slezak
requested changes
Oct 11, 2023
marcin-slezak
approved these changes
Oct 12, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
'@voucherify/sdk': minor
Add support for few endpoints of Loyalties API.
GET /loyalties/members/{memberId},GET /loyalties/members/{memberId}/activities,GET /loyalties/members/{memberId}/rewards,POST /loyalties/{campaignId}/members/{memberId}/transfers,GET /loyalties/{campaignId}/members/{memberId}/points-expiration,GET /loyalties/members/{memberId}/transactions,GET /loyalties/{campaignId}/members/{memberId}/transactions,POST /loyalties/members/{memberId}/transactions/exportandPOST /loyalties/{campaignId}/members/{memberId}/transactions/export(examples of usage available in readme.md)LoyaltiesTransferPointsResponseBody,LoyaltiesTransferPointsRequestBody,LoyaltiesListMemberRewardsRequestQuery,LoyaltiesListMemberRewardsResponseBody,LoyaltiesGetPointsExpirationRequestQuery,LoyaltiesGetPointsExpirationResponseBody,LoyaltiesListCardTransactionsRequestQuery,LoyaltiesListCardTransactionsResponseBody,LoyaltiesExportCardTransactionsRequestBody,LoyaltiesExportCardTransactionsResponseBody,LoyaltiesAddOrRemoveCardBalanceRequestBody,LoyaltiesAddOrRemoveCardBalanceResponseBody,LoyaltyCardTransaction,SimpleLoyaltyVoucher,LoyaltiesTransferPoints,LoyaltyCardTransactionsFields,LoyaltyCardTransactionsType,Reward,RewardTypeCampaign,RewardTypeCoin,RewardTypeMaterial,RewardType,RewardAssignment