Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Premium Apps: SKU and Entitlement fields #6477

Merged
merged 9 commits into from
Oct 13, 2023

Conversation

colinloretz
Copy link
Contributor

@colinloretz colinloretz commented Oct 6, 2023

Addressing docs for Entitlements (#6476)

The subscription_id, promotion_id, deleted, and gift_code_flags fields are undocumented.

  • Added deleted.
  • subscription_id, promotion_id and gift_code_flags to remain undocumented at this time
  • Updated before and after param descriptions for List Entitlements to be more explicit. Snowflake IDs are time-ordered.

Addressing docs for SKUs (#6468)

The flags field is mentioned in a bunch of places in the SKU documentation but it's not documented.
Furthermore, the json includes a bunch more info that aren't present in the object structure documentation.

For both models:

  • The JSON examples DO contain fields not included in the table. Fields that can be used by devs today are documented in the tables with descriptions. Something we hope to address in the future but for now, rely on the defined fields.

Copy link
Contributor

@Lulalaby Lulalaby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good
thumbs up

@mkrasnitski
Copy link

Are the before and after parameters mutually exclusive in any way?

@Luc1412
Copy link

Luc1412 commented Oct 8, 2023

  • Added deleted.

I talked to mason regarding this when implementing Rapptz/discord.py#9453. From what he told me, the deleted field got no relevance. (Might even not work or change for premium SKUs) And we should rely on ends_at not being refreshed.
So it actually got any value?

@appellation
Copy link
Contributor

Entitlements can be deleted in some scenarios. This field should be documented so that apps can use it.

@Luc1412
Copy link

Luc1412 commented Oct 10, 2023

Entitlements can be deleted in some scenarios. This field should be documented so that apps can use it.

If Discord themselves manually delete it due to refunds/fraud for example. For normal expiry it won't be set True. However does it even will be available when it's deleted, since it also disappears when deleting a test entitlement.

If it's not true when it expires, it may be better to point it out, as it can be misleading.

docs/topics/Gateway_Events.md Outdated Show resolved Hide resolved
docs/topics/Gateway_Events.md Outdated Show resolved Hide resolved
docs/topics/Gateway_Events.md Outdated Show resolved Hide resolved
docs/topics/Gateway_Events.md Outdated Show resolved Hide resolved
@colinloretz colinloretz merged commit b8feadd into discord:main Oct 13, 2023
3 checks passed
KubaZ2 added a commit to NetCordDev/NetCord that referenced this pull request Oct 14, 2023
mccoderpy added a commit to mccoderpy/discord.py-message-components that referenced this pull request Nov 4, 2023
shaydewael pushed a commit to Jupith/discord-api-docs that referenced this pull request May 14, 2024
* Remove consumed from entitlements as not usable by devs

* Reorder sku fields to match sku example json

* Document 'deleted' field on SKUs

* Update 'before?' and 'after?' desc for entitlement pagination

* Add to SKU flags

* Add ENTITLEMENT_* to Gateway Events

* Update ENTITLEMENT_* gateway event descriptions

* Clarify ENTITLEMENT_UPDATE and recurring subscriptions

* Fix inconsistency in PREMIUM_REQUIRED docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants