pokepurple/addons/twitcher/generated/twitch_get_drops_entitlements.gd

179 lines
5.2 KiB
GDScript3
Raw Permalink Normal View History

@tool
extends TwitchData
# CLASS GOT AUTOGENERATED DON'T CHANGE MANUALLY. CHANGES CAN BE OVERWRITTEN EASILY.
class_name TwitchGetDropsEntitlements
##
## #/components/schemas/GetDropsEntitlementsResponse
class Response extends TwitchData:
## The list of entitlements.
@export var data: Array[TwitchDropsEntitlement]:
set(val):
data = val
track_data(&"data", val)
## The information used to page through the list of results. The object is empty if there are no more pages left to page through. [Read More](https://dev.twitch.tv/docs/api/guide#pagination)
@export var pagination: ResponsePagination:
set(val):
pagination = val
track_data(&"pagination", val)
var response: BufferedHTTPClient.ResponseData
## Constructor with all required fields.
static func create(_data: Array[TwitchDropsEntitlement]) -> Response:
var response: Response = Response.new()
response.data = _data
return response
static func from_json(d: Dictionary) -> Response:
var result: Response = Response.new()
if d.get("data", null) != null:
for value in d["data"]:
result.data.append(TwitchDropsEntitlement.from_json(value))
if d.get("pagination", null) != null:
result.pagination = ResponsePagination.from_json(d["pagination"])
return result
func _has_pagination() -> bool:
if pagination == null: return false
if pagination.cursor == null || pagination.cursor == "": return false
return true
var _next_page: Callable
var _cur_iter: int = 0
func next_page() -> Response:
var response: Response = await _next_page.call()
_cur_iter = 0
_next_page = response._next_page
data = response.data
pagination = response.pagination
return response
func _iter_init(iter: Array) -> bool:
if data.is_empty(): return false
iter[0] = data[0]
return data.size() > 0
func _iter_next(iter: Array) -> bool:
if data.size() - 1 > _cur_iter:
_cur_iter += 1
iter[0] = data[_cur_iter]
if data.size() - 1 == _cur_iter && not _has_pagination():
return false
return true
func _iter_get(iter: Variant) -> Variant:
if data.size() - 1 == _cur_iter && _has_pagination():
await next_page()
return iter
## The information used to page through the list of results. The object is empty if there are no more pages left to page through. [Read More](https://dev.twitch.tv/docs/api/guide#pagination)
## #/components/schemas/GetDropsEntitlementsResponse/Pagination
class ResponsePagination extends TwitchData:
## The cursor used to get the next page of results. Set the requests _after_ query parameter to this value to page forward through the results.
@export var cursor: String:
set(val):
cursor = val
track_data(&"cursor", val)
## Constructor with all required fields.
static func create() -> ResponsePagination:
var response_pagination: ResponsePagination = ResponsePagination.new()
return response_pagination
static func from_json(d: Dictionary) -> ResponsePagination:
var result: ResponsePagination = ResponsePagination.new()
if d.get("cursor", null) != null:
result.cursor = d["cursor"]
return result
## All optional parameters for TwitchAPI.get_drops_entitlements
## #/components/schemas/GetDropsEntitlementsOpt
class Opt extends TwitchData:
## An ID that identifies the entitlement to get. Include this parameter for each entitlement you want to get. For example, `id=1234&id=5678`. You may specify a maximum of 100 IDs.
@export var id: Array[String]:
set(val):
id = val
track_data(&"id", val)
## An ID that identifies a user that was granted entitlements.
@export var user_id: String:
set(val):
user_id = val
track_data(&"user_id", val)
## An ID that identifies a game that offered entitlements.
@export var game_id: String:
set(val):
game_id = val
track_data(&"game_id", val)
## The entitlements fulfillment status. Used to filter the list to only those with the specified status. Possible values are:
##
## * CLAIMED
## * FULFILLED
@export var fulfillment_status: String:
set(val):
fulfillment_status = val
track_data(&"fulfillment_status", val)
## The cursor used to get the next page of results. The **Pagination** object in the response contains the cursors value. [Read More](https://dev.twitch.tv/docs/api/guide#pagination)
@export var after: String:
set(val):
after = val
track_data(&"after", val)
## The maximum number of entitlements to return per page in the response. The minimum page size is 1 entitlement per page and the maximum is 1000\. The default is 20.
@export var first: int:
set(val):
first = val
track_data(&"first", val)
## Constructor with all required fields.
static func create() -> Opt:
var opt: Opt = Opt.new()
return opt
static func from_json(d: Dictionary) -> Opt:
var result: Opt = Opt.new()
if d.get("id", null) != null:
for value in d["id"]:
result.id.append(value)
if d.get("user_id", null) != null:
result.user_id = d["user_id"]
if d.get("game_id", null) != null:
result.game_id = d["game_id"]
if d.get("fulfillment_status", null) != null:
result.fulfillment_status = d["fulfillment_status"]
if d.get("after", null) != null:
result.after = d["after"]
if d.get("first", null) != null:
result.first = d["first"]
return result