---
title: "Sorteios"
description: "Sorteios, categorias, resultados e títulos."
---
rafflesnamespace
Sorteios, categorias, resultados e títulos.
22métodos
rafflesnamespace
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `createReminder`
POST/user/raffles/:uuid/reminder
Assinatura:
```ts
createReminder(uuid: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Tipos
```ts
type CreateReminderParams = { "uuid": string; };
type CreateReminderResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.createReminder("string");
```
Testar esta função no playground
## `getBonds`
GET/user/raffles/:uuid/bonds
Assinatura:
```ts
getBonds(uuid: string, query?: GetBondsQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `perPage` | `number` | não |
### Tipos
```ts
type GetBondsParams = { "uuid": string; };
type GetBondsQuery = { "page"?: number; "perPage"?: number; };
type GetBondsResponse = { "raffle": { "id": number; "uuid": string; "title": string; "thumbnail": string; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; "isOpenForPurchase": boolean; }; "numbers": Array; "total": number; "instantPrizes"?: false | Array<{ "number": string; "awardedItem"?: { "icon"?: string; "title": string; "subtitle": string; }; "type": "SCRATCH_CARD"; "itemsFound": Array<{ "icon"?: string; "title": string; "subtitle": string; }>; }>; "bonds": Array<{ "luckyNumber": string; "matrixChances": Array<{ "chanceIndex": number; "numbers": Array; }>; }>; };
```
### Exemplo
```ts
const response = await sdk.raffles.getBonds("string");
```
Testar esta função no playground
## `getCategory`
GET/raffles/categories/:slug
Assinatura:
```ts
getCategory(slug: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `slug` | `string` |
### Tipos
```ts
type GetCategoryParams = { "slug": string; };
type GetCategoryResponse = { "slug": string; "label": string; "description": string; "iconUrl": string; "displayOrder": number; "color": string; "isMainCategory"?: boolean; "activeRaffles": Array<{ "uuid": string; "title": string; "excerpt": string; "description": string; "thumbnail": string; "price": number; "status": "WAITING" | "OPEN" | "SOLD_OUT" | "CLOSED" | "SUSPENDED" | "ENDED" | "PRIVATE"; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }> | Array<{ "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; "userHasPurchasedTickets"?: boolean; "reseller"?: { "name": string; "photo": string; }; }>; };
```
### Exemplo
```ts
const response = await sdk.raffles.getCategory("string");
```
Testar esta função no playground
## `getCombos`
GET/raffles/:id/combos
Assinatura:
```ts
getCombos(id: number | string | "recent", settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Tipos
```ts
type GetCombosParams = { "id": number | string | "recent"; };
type GetCombosResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.getCombos(0);
```
Testar esta função no playground
## `getDrawnNumbers`
GET/user/raffles/:uuid/drawn-numbers
Assinatura:
```ts
getDrawnNumbers(uuid: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Tipos
```ts
type GetDrawnNumbersParams = { "uuid": string; };
type GetDrawnNumbersResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.getDrawnNumbers("string");
```
Testar esta função no playground
## `getItems`
GET/raffles/:id/items
Assinatura:
```ts
getItems(id: number | string | "recent", settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Tipos
```ts
type GetItemsParams = { "id": number | string | "recent"; };
type GetItemsResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.getItems(0);
```
Testar esta função no playground
## `getLegacyRaffle`
GET/raffle/:id
Assinatura:
```ts
getLegacyRaffle(id: number | string | "recent", query?: GetLegacyRaffleQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `affiliate_id` | `string \| number` | não |
| `reseller_id` | `string \| number` | não |
| `reseller_slug` | `string \| number` | não |
| `reseller_uuid` | `string` | não |
### Tipos
```ts
type GetLegacyRaffleParams = { "id": number | string | "recent"; };
type GetLegacyRaffleQuery = { "affiliate_id"?: string | number; "reseller_id"?: string | number; "reseller_slug"?: string | number; "reseller_uuid"?: string; };
type GetLegacyRaffleResponse = { "uuid": string; "title": string; "excerpt": string; "description": string; "thumbnail": string; "price": number; "status": "WAITING" | "OPEN" | "SOLD_OUT" | "CLOSED" | "SUSPENDED" | "ENDED" | "PRIVATE"; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }> | Array<{ "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; "userHasPurchasedTickets"?: boolean; "reseller"?: { "name": string; "photo": string; }; };
```
### Exemplo
```ts
const response = await sdk.raffles.getLegacyRaffle(0);
```
Testar esta função no playground
## `getOrders`
GET/user/raffles/:uuid/orders
Assinatura:
```ts
getOrders(uuid: string, query?: GetOrdersQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `simplified` | `boolean` | não |
| `includeTickets` | `boolean` | não |
### Tipos
```ts
type GetOrdersParams = { "uuid": string; };
type GetOrdersQuery = { "simplified"?: boolean; "includeTickets"?: boolean; };
type GetOrdersResponse = Array<{ "id": number; "uuid": string; "method": unknown; "methods": Array<"CARD" | "PICPAY" | "PIX" | "CREDITS" | "API" | "POINTS" | "DIGITAL_WALLET">; "value": number; "originalValue"?: number; "pointsValue"?: number; "source": "APP" | "API" | "PHYSICAL" | "DESKTOP_WEB" | "MOBILE_WEB" | "TABLET_WEB" | "EMBED" | "LANDING_PAGE" | "WEBSITE" | "UNKNOWN" | "STUB" | "SUBSCRIPTION"; "status": "CREATED" | "PENDING" | "ANALYSIS" | "APPROVED" | "REFUSED" | "CANCELLED" | "REFUNDED" | "CHARGEDBACK"; "expiresAt"?: string; "canChangPaymentMethod": boolean; "authorizationOnly"?: boolean; "instantPrizesWon"?: number; "appliedOffers"?: Array; "unlockedOffers"?: Array; "bonds"?: { "count": number; }; "data": { "involvedRaffles"?: Record; "statusMessage"?: string; "user"?: { "name": string; "cpf"?: string; "needNewPassword"?: boolean; }; "reseller"?: { "name": string; }; }; "payer"?: { "id": number; "name": string; "document": string; "email": string; "phone"?: string; "address": { "streetName": string; "number"?: string; "complement"?: string; "neighborhood": string; "city": string; "state": string; "cep": string; }; }; "blocks"?: unknown; "items": unknown; "instructions"?: { "code": string; } | { "url": string; } | { "clientSecret": string; }; "createdAt": string; "updatedAt": string; "token"?: string; "links"?: { "self": string; }; "subscriptionAuthorization"?: { "planName": string; "recurringValue": number; "billingLabel": string; "firstChargeAt"?: string; }; "externalServices"?: Array<{ "name": string; "data"?: Record; }>; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.getOrders("string");
```
Testar esta função no playground
## `getPrizesInstantStats`
GET/raffles/:id/prizes/instant/stats
Assinatura:
```ts
getPrizesInstantStats(id: number | string | "recent", query?: GetPrizesInstantStatsQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
### Tipos
```ts
type GetPrizesInstantStatsParams = { "id": number | string | "recent"; };
type GetPrizesInstantStatsQuery = { "page"?: number; };
type GetPrizesInstantStatsResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.getPrizesInstantStats(0);
```
Testar esta função no playground
## `getRaffle`
GET/raffles/:id
Assinatura:
```ts
getRaffle(id: number | string | "recent", query?: GetRaffleQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `affiliate_id` | `string \| number` | não |
| `reseller_id` | `string \| number` | não |
| `reseller_slug` | `string \| number` | não |
| `reseller_uuid` | `string` | não |
### Tipos
```ts
type GetRaffleParams = { "id": number | string | "recent"; };
type GetRaffleQuery = { "affiliate_id"?: string | number; "reseller_id"?: string | number; "reseller_slug"?: string | number; "reseller_uuid"?: string; };
type GetRaffleResponse = { "uuid": string; "title": string; "excerpt": string; "description": string; "thumbnail": string; "price": number; "status": "WAITING" | "OPEN" | "SOLD_OUT" | "CLOSED" | "SUSPENDED" | "ENDED" | "PRIVATE"; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }> | Array<{ "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; "userHasPurchasedTickets"?: boolean; "reseller"?: { "name": string; "photo": string; }; };
```
### Exemplo
```ts
const response = await sdk.raffles.getRaffle(0);
```
Testar esta função no playground
## `getReminder`
GET/user/raffles/:uuid/reminder
Assinatura:
```ts
getReminder(uuid: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Tipos
```ts
type GetReminderParams = { "uuid": string; };
type GetReminderResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.getReminder("string");
```
Testar esta função no playground
## `getResults`
GET/raffles/:id/results
Assinatura:
```ts
getResults(id: number | string | "recent", query?: GetResultsQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `number \| string \| "recent"` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `limit` | `number` | não |
| `kind` | `unknown \| "ANY_KIND"` | não |
| `category` | `string` | não |
### Tipos
```ts
type GetResultsParams = { "id": number | string | "recent"; };
type GetResultsQuery = { "page"?: number; "limit"?: number; "kind"?: unknown | "ANY_KIND"; "category"?: string; };
type GetResultsResponse = { "id": number; "uuid": string; "title": string; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "thumbnail": null | string; "highestMatrixNumber"?: number; "edition": string; "excerpt": null | string; "endedAt": string; "month": number; "year": number; "digitsPerLuckyNumber": number; "results": Array<{ "prize": { "id"?: number; "raffleKind"?: string; "name": string; }; "winner"?: { "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }; "winners"?: Array<{ "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }>; "drawnNumbers"?: Array; }>; } | Array<{ "raffle": { "uuid": string; "title": string; "drawDate": string; }; "prize": { "title": string; }; "winner": { "name": string; "socialName"?: null | string; "city"?: null | string; "state"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "number": string; }; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.getResults(0);
```
Testar esta função no playground
## `listActive`
GET/raffles/active
Assinatura:
```ts
listActive(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListActiveResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.listActive();
```
Testar esta função no playground
## `listActiveRegulations`
GET/raffles/active/regulations
Assinatura:
```ts
listActiveRegulations(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListActiveRegulationsResponse = { "raffles": Array<{ "uuid": string; "title": string; "regulation"?: string; }>; };
```
### Exemplo
```ts
const response = await sdk.raffles.listActiveRegulations();
```
Testar esta função no playground
## `listCategories`
GET/raffles/categories
Assinatura:
```ts
listCategories(query?: ListCategoriesQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `attributes` | `string` | não |
### Tipos
```ts
type ListCategoriesQuery = { "attributes"?: string; };
type ListCategoriesResponse = Array<{ "slug"?: string; "label"?: string; "description"?: string; "iconUrl"?: string; "displayOrder"?: number; "color"?: string; "featured"?: boolean; "isMainCategory"?: boolean; "firstDrawDate"?: string | null; "lastDrawDate"?: string | null; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listCategories();
```
Testar esta função no playground
## `listDailyResults`
GET/daily-raffle/results
Assinatura:
```ts
listDailyResults(query?: ListDailyResultsQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `date` | `string` | sim |
### Tipos
```ts
type ListDailyResultsQuery = { "date": string; };
type ListDailyResultsResponse = Array<{ "title": string; "time": string; "prizes": Array<{ "title"?: string; "winner": { "number": string | number; "user": { "photoUrl"?: string; "name": string; "city": string; "state": string; }; "reseller"?: { "name": string; }; }; }>; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listDailyResults({ "date": "string" });
```
Testar esta função no playground
## `listLegacyRaffle`
GET/raffle/list
Assinatura:
```ts
listLegacyRaffle(query?: ListLegacyRaffleQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
### Tipos
```ts
type ListLegacyRaffleQuery = { "page"?: number; };
type ListLegacyRaffleResponse = Array<{ "uuid": string; "title": string; "excerpt": string; "thumbnail": string; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listLegacyRaffle();
```
Testar esta função no playground
## `listLegacyResults`
GET/raffle/results
Assinatura:
```ts
listLegacyResults(query?: ListLegacyResultsQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `year` | `number` | não |
| `month` | `number` | não |
| `endDate` | `string` | não |
| `kind` | `unknown \| "ANY_KIND"` | sim |
| `category` | `string` | não |
### Tipos
```ts
type ListLegacyResultsQuery = { "page"?: number; "year"?: number; "month"?: number; "endDate"?: string; "kind": unknown | "ANY_KIND"; "category"?: string; };
type ListLegacyResultsResponse = Array<{ "id": number; "uuid": string; "title": string; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "thumbnail": null | string; "highestMatrixNumber"?: number; "edition": string; "excerpt": null | string; "endedAt": string; "month": number; "year": number; "digitsPerLuckyNumber": number; "results": Array<{ "prize": { "id"?: number; "raffleKind"?: string; "name": string; }; "winner"?: { "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }; "winners"?: Array<{ "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }>; "drawnNumbers"?: Array; }>; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listLegacyResults({ "kind": "ANY_KIND" });
```
Testar esta função no playground
## `listLive`
GET/raffles/live
Assinatura:
```ts
listLive(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListLiveResponse = { "raffles": Array<{ "uuid": string; "title": string; "drawDate"?: string; "embedURL": string; "streamThumbnailURL": string; "startedAt": string; "prizes": Array<{ "name": string; }>; }>; };
```
### Exemplo
```ts
const response = await sdk.raffles.listLive();
```
Testar esta função no playground
## `listNearest`
GET/raffles/nearest
Assinatura:
```ts
listNearest(query?: ListNearestQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `kind` | `unknown` | sim |
### Tipos
```ts
type ListNearestQuery = { "kind": unknown; };
type ListNearestResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.raffles.listNearest({ "kind": "string" });
```
Testar esta função no playground
## `listRaffles`
GET/user/raffles
Assinatura:
```ts
listRaffles(query?: ListRafflesQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `drawedAt` | `"FUTURE" \| "PAST"` | não |
### Tipos
```ts
type ListRafflesQuery = { "page"?: number; "drawedAt"?: "FUTURE" | "PAST"; };
type ListRafflesResponse = Array<{ "uuid": string; "title": string; "thumbnail": string; "susepProcess"?: string; "regulation"?: string; "digitsPerLuckyNumber"?: number; "kind"?: "MAIN" | "SECONDARY" | "GAMBLING"; "edition"?: string; "gambling"?: { "minimumBetPrice"?: string; "maximumBetPrice"?: string; "highestMultiplier"?: number; }; "hideRaffleCountdown"?: boolean | null; "marquee"?: { "text": string; }; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "highestMatrixNumber"?: number; "participationRules"?: { "canPurchaseBondsDirectly"?: boolean; "allowedCountryStates"?: Array; "allowedCities"?: Array; "supportsFastSignUp"?: boolean; }; "whereToWatch"?: { "facebook"?: string; "youtube"?: string; "twitch"?: string; }; "startAt": string; "endAt": string; "prizes"?: Array<{ "id": number; "name": string; "raffleKind": string; }>; "instantPrizes"?: { "drawMethods": Array; }; "cart"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; "at"?: { "LANDING_PAGE"?: { "selectorAmounts"?: Array; "defaultAmountButtonIndex"?: number; "defaultAmountForLandingPage"?: number; "popularAmountButtonIndex"?: number; "increasingAmount"?: number; "minimumAmount"?: number; "selectorButtonLabels"?: Array<{ "text": string; "color": string; "icon"?: string; } | null>; }; }; }; "category"?: { "slug": string; }; "drawDate"?: string; "results"?: Array<{ "winner": { "number": number; "name": string; "city": string; "state": string; "neighborhood": string; }; "prize": { "name": string; }; }>; "bondCount": number; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listRaffles();
```
Testar esta função no playground
## `listResults`
GET/raffles/results
Assinatura:
```ts
listResults(query?: ListResultsQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `year` | `number` | não |
| `month` | `number` | não |
| `endDate` | `string` | não |
| `limit` | `number` | não |
| `kind` | `unknown \| "ANY_KIND"` | sim |
| `category` | `string` | não |
### Tipos
```ts
type ListResultsQuery = { "page"?: number; "year"?: number; "month"?: number; "endDate"?: string; "limit"?: number; "kind": unknown | "ANY_KIND"; "category"?: string; };
type ListResultsResponse = Array<{ "id": number; "uuid": string; "title": string; "gallery"?: Array<{ "_id"?: string; "type": "YOUTUBE"; "purpose": "RESULTS_LIVE"; "url": string; } | { "_id"?: string; "type": "LIVESTREAM"; "endedAt"?: string; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "RESULT"; "embedURL": string; "thumbnailURL": string; "publishedAt": string; } | { "_id"?: string; "type": "IMAGE"; "mediaId"?: string; "url"?: string; "purpose": "BANNER" | "RESULTS_BANNER"; } | { "_id"?: string; "type": "VIDEO"; "mediaId"?: string; "variants"?: Array<{ "format": string; "url": string; "dimensions": string; }>; }>; "thumbnail": null | string; "highestMatrixNumber"?: number; "edition": string; "excerpt": null | string; "endedAt": string; "month": number; "year": number; "digitsPerLuckyNumber": number; "results": Array<{ "prize": { "id"?: number; "raffleKind"?: string; "name": string; }; "winner"?: { "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }; "winners"?: Array<{ "number": string; "name": string; "city"?: null | string; "state"?: null | string; "neighborhood"?: null | string; "photoUrl"?: null | string; "customText"?: null | string; "reseller": null | { "name": null | string; }; "earnedMoney"?: number; "video"?: null | { "source": "YOUTUBE"; "url": string; "orientation": "VERTICAL" | "HORIZONTAL"; }; "external"?: boolean; }>; "drawnNumbers"?: Array; }>; }>;
```
### Exemplo
```ts
const response = await sdk.raffles.listResults({ "kind": "ANY_KIND" });
```
Testar esta função no playground