---
title: "Conta"
description: "Perfil, biblioteca, indicações e preferências."
---
usernamespace
Perfil, biblioteca, indicações e preferências.
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `attachPhysicalBonds`
POST/user/physicalBonds/attach
Assinatura:
```ts
attachPhysicalBonds(body?: AttachPhysicalBondsBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `bondNumber` | `string` | sim |
| `securityCode` | `string` | sim |
### Tipos
```ts
type AttachPhysicalBondsBody = { "bondNumber": string; "securityCode": string; };
type AttachPhysicalBondsResponse = { "message": string; "bond": { "number": string; "raffleUUID": string; }; };
```
### Exemplo
```ts
const response = await sdk.user.attachPhysicalBonds({ "bondNumber": "string", "securityCode": "string" });
```
Testar esta função no playground
## `deleteProfile`
DELETE/user/profile
Assinatura:
```ts
deleteProfile(body?: DeleteProfileBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `reason` | `"TOO_MANY_NOTIFICATIONS" \| "DONT_KNOW_THE_SITE" \| "CANNOT_CONTACT_SUPPORT" \| "DONT_TRUST_THEY_WILL_WIN" \| "STOPPED_PURCHASING" \| "OTHER_REASON"` | sim |
| `details` | `string` | sim |
### Tipos
```ts
type DeleteProfileBody = { "reason": "TOO_MANY_NOTIFICATIONS" | "DONT_KNOW_THE_SITE" | "CANNOT_CONTACT_SUPPORT" | "DONT_TRUST_THEY_WILL_WIN" | "STOPPED_PURCHASING" | "OTHER_REASON"; "details": string; };
type DeleteProfileResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.deleteProfile({ "reason": "TOO_MANY_NOTIFICATIONS", "details": "string" });
```
Testar esta função no playground
## `downloadDigitalLibraryItemUrl`
POST/user/digital-library/items/:id/download-url
Assinatura:
```ts
downloadDigitalLibraryItemUrl(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type DownloadDigitalLibraryItemUrlParams = { "id": string; };
type DownloadDigitalLibraryItemUrlResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.downloadDigitalLibraryItemUrl("string");
```
Testar esta função no playground
## `getBalanceHistory`
GET/user/balance/history
Assinatura:
```ts
getBalanceHistory(query?: GetBalanceHistoryQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `limit` | `number` | não |
| `wallet` | `"CREDITS" \| "CHECKING_ACCOUNT" \| "POINTS"` | não |
### Tipos
```ts
type GetBalanceHistoryQuery = { "page"?: number; "limit"?: number; "wallet"?: "CREDITS" | "CHECKING_ACCOUNT" | "POINTS"; };
type GetBalanceHistoryResponse = { "overview": { "currentPage": number; "maxPage": number; "totalItems": number; }; "items": Array<{ "id": number; "value": number; "amount": number; "operation": string; "status": string; "source": string; "wallet": string; "description": string; "errorMessage"?: string; "createdAt": string; }>; };
```
### Exemplo
```ts
const response = await sdk.user.getBalanceHistory();
```
Testar esta função no playground
## `getBondsRaffle`
GET/user/guest/bonds/raffles/:uuid
Assinatura:
```ts
getBondsRaffle(uuid: string, query?: GetBondsRaffleQuery, 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 GetBondsRaffleParams = { "uuid": string; };
type GetBondsRaffleQuery = { "page"?: number; "perPage"?: number; };
type GetBondsRaffleResponse = { "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; }; "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.user.getBondsRaffle("string");
```
Testar esta função no playground
## `getCommunicationOptions`
GET/user/communication-options
Assinatura:
```ts
getCommunicationOptions(settings?: SdkSettings): Promise
```
### Tipos
```ts
type GetCommunicationOptionsResponse = { "mediums": { "SMS": boolean; "PUSH": boolean; "WHATSAPP": boolean; "EMAIL": boolean; }; "categories": { "PAYMENT_STATUS": boolean; "PROMOTIONAL": boolean; "MARKETING": boolean; "NEWSLETTER": boolean; }; };
```
### Exemplo
```ts
const response = await sdk.user.getCommunicationOptions();
```
Testar esta função no playground
## `getDigitalLibrary`
GET/user/digital-library
Assinatura:
```ts
getDigitalLibrary(query?: GetDigitalLibraryQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `perPage` | `number` | não |
### Tipos
```ts
type GetDigitalLibraryQuery = { "page"?: number; "perPage"?: number; };
type GetDigitalLibraryResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.getDigitalLibrary();
```
Testar esta função no playground
## `getDigitalLibraryItemDetail`
GET/user/digital-library/items/:id/detail
Assinatura:
```ts
getDigitalLibraryItemDetail(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type GetDigitalLibraryItemDetailParams = { "id": string; };
type GetDigitalLibraryItemDetailResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.getDigitalLibraryItemDetail("string");
```
Testar esta função no playground
## `getDigitalLibraryItemPlayback`
GET/user/digital-library/items/:id/playback
Assinatura:
```ts
getDigitalLibraryItemPlayback(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type GetDigitalLibraryItemPlaybackParams = { "id": string; };
type GetDigitalLibraryItemPlaybackResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.getDigitalLibraryItemPlayback("string");
```
Testar esta função no playground
## `getNotificationsInfo`
GET/user/notifications/info
Assinatura:
```ts
getNotificationsInfo(settings?: SdkSettings): Promise
```
### Tipos
```ts
type GetNotificationsInfoResponse = { "id": { "value": string; "hash": string; }; "email": { "value": string; "hash": string; }; "tel": { "value": string; "hash": string; }; };
```
### Exemplo
```ts
const response = await sdk.user.getNotificationsInfo();
```
Testar esta função no playground
## `getProfile`
GET/user/profile
Assinatura:
```ts
getProfile(settings?: SdkSettings): Promise
```
### Tipos
```ts
type GetProfileResponse = { "id": number; "email": string; "name"?: string; "originalName"?: string; "socialName"?: string | null; "cpf": string; "idd"?: string; "tel": string; "birthdate"?: string; "gender"?: "M" | "F" | "O" | "N" | null; "address": { "cep": string; "streetName": string; "number"?: string; "neighborhood": string; "complement"?: string; "city": string; "state": string; }; "creditsAmount"?: number; "checkingAccountAmount"?: number; };
```
### Exemplo
```ts
const response = await sdk.user.getProfile();
```
Testar esta função no playground
## `getReferralHistory`
GET/user/referral/history
Assinatura:
```ts
getReferralHistory(query?: GetReferralHistoryQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `from` | `string` | não |
| `to` | `string` | não |
| `page` | `number` | não |
| `perPage` | `number` | não |
### Tipos
```ts
type GetReferralHistoryQuery = { "from"?: string; "to"?: string; "page"?: number; "perPage"?: number; };
type GetReferralHistoryResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.getReferralHistory();
```
Testar esta função no playground
## `getReferralProgram`
GET/user/referral/me
Assinatura:
```ts
getReferralProgram(settings?: SdkSettings): Promise
```
### Tipos
```ts
type GetReferralProgramResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.getReferralProgram();
```
Testar esta função no playground
## `listGuestPurchasedRaffle`
GET/user/guest/bonds
Assinatura:
```ts
listGuestPurchasedRaffle(query?: ListGuestPurchasedRaffleQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
| `drawedAt` | `"FUTURE" \| "PAST"` | não |
### Tipos
```ts
type ListGuestPurchasedRaffleQuery = { "page"?: number; "drawedAt"?: "FUTURE" | "PAST"; };
type ListGuestPurchasedRaffleResponse = 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.user.listGuestPurchasedRaffle();
```
Testar esta função no playground
## `listReferralPublicLinks`
GET/user/referral/me/links
Assinatura:
```ts
listReferralPublicLinks(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListReferralPublicLinksResponse = { "links": Array<{ "campaignId": string; "link": string; }>; };
```
### Exemplo
```ts
const response = await sdk.user.listReferralPublicLinks();
```
Testar esta função no playground
## `setCommunicationOptions`
POST/user/communication-options
Assinatura:
```ts
setCommunicationOptions(body?: SetCommunicationOptionsBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `mediums` | `{ "SMS": boolean; "PUSH": boolean; "WHATSAPP": boolean; "EMAIL": boolean; }` | sim |
| `categories` | `{ "PAYMENT_STATUS": boolean; "PROMOTIONAL": boolean; "MARKETING": boolean; "NEWSLETTER": boolean; }` | sim |
### Tipos
```ts
type SetCommunicationOptionsBody = { "mediums": { "SMS": boolean; "PUSH": boolean; "WHATSAPP": boolean; "EMAIL": boolean; }; "categories": { "PAYMENT_STATUS": boolean; "PROMOTIONAL": boolean; "MARKETING": boolean; "NEWSLETTER": boolean; }; };
type SetCommunicationOptionsResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.user.setCommunicationOptions({ "mediums": { "SMS": true, "PUSH": true, "WHATSAPP": true, "EMAIL": true }, "categories": { "PAYMENT_STATUS": true, "PROMOTIONAL": true, "MARKETING": true, "NEWSLETTER": true } });
```
Testar esta função no playground
## `updateProfile`
PUT/user/profile
Assinatura:
```ts
updateProfile(body?: UpdateProfileBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `email` | `string` | não |
| `name` | `string` | não |
| `originalName` | `string` | não |
| `socialName` | `string \| null` | não |
| `idd` | `string` | não |
| `tel` | `string` | não |
| `birthdate` | `string` | não |
| `gender` | `"M" \| "F" \| "O" \| "N" \| null` | não |
| `address` | `{ "cep"?: string; "streetName"?: string \| null; "number"?: string; "neighborhood"?: string \| null; "complement"?: string; }` | não |
### Tipos
```ts
type UpdateProfileBody = { "email"?: string; "name"?: string; "originalName"?: string; "socialName"?: string | null; "idd"?: string; "tel"?: string; "birthdate"?: string; "gender"?: "M" | "F" | "O" | "N" | null; "address"?: { "cep"?: string; "streetName"?: string | null; "number"?: string; "neighborhood"?: string | null; "complement"?: string; }; };
type UpdateProfileResponse = { "id": number; "email": string; "name"?: string; "originalName"?: string; "socialName"?: string | null; "cpf": string; "idd"?: string; "tel": string; "birthdate"?: string; "gender"?: "M" | "F" | "O" | "N" | null; "address": { "cep": string; "streetName": string; "number"?: string; "neighborhood": string; "complement"?: string; "city": string; "state": string; }; "creditsAmount"?: number; "checkingAccountAmount"?: number; };
```
### Exemplo
```ts
const response = await sdk.user.updateProfile({ "email": "string", "name": "string", "originalName": "string", "socialName": "string", "idd": "string", "tel": "string", "birthdate": "string", "gender": "M", "address": { "cep": "string", "streetName": "string", "number": "string", "neighborhood": "string", "complement": "string" } });
```
Testar esta função no playground