---
title: "Ofertas"
description: "Ofertas públicas e ofertas personalizadas."
---
<div class="lm-ref-kicker"><code>offers</code><span>namespace</span></div>

Ofertas públicas e ofertas personalizadas.

<div class="lm-ref-stats lm-ref-stats--compact">
  <div class="lm-ref-stat"><strong>5</strong><span>métodos</span></div>
  <div class="lm-ref-stat"><code>offers</code><span>namespace</span></div>
</div>

> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.

## `claimOffer`

<div class="lm-endpoint"><span class="lm-http lm-http--post">POST</span><code>/user/offers/:id/claim</code></div>

Assinatura:

```ts
claimOffer(id: string, body?: ClaimOfferBody, settings?: SdkSettings): Promise<ClaimOfferResponse>
```

### Parâmetros de rota

| Nome | Tipo |
|---|---|
| `id` | `string` |

### Body

| Nome | Tipo | Obrigatório |
|---|---|---|
| `code` | `string` | não |

### Tipos

```ts
type ClaimOfferParams = { "id": string; };
type ClaimOfferBody = { "code"?: string; };
type ClaimOfferResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.offers.claimOffer("string", { "code": "string" });
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=offers&method=claimOffer">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `getOffers`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/offers</code></div>

Assinatura:

```ts
getOffers(query?: GetOffersQuery, settings?: SdkSettings): Promise<GetOffersResponse>
```

### Query

| Nome | Tipo | Obrigatório |
|---|---|---|
| `id` | `string \| number` | não |
| `code` | `string` | não |

### Tipos

```ts
type GetOffersQuery = { "id"?: string | number; "code"?: string; };
type GetOffersResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.offers.getOffers();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=offers&method=getOffers">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listCoupons`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/user/offers/coupons</code></div>

Assinatura:

```ts
listCoupons(settings?: SdkSettings): Promise<ListCouponsResponse>
```

### Tipos

```ts
type ListCouponsResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.offers.listCoupons();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=offers&method=listCoupons">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listOffers`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/user/offers</code></div>

Assinatura:

```ts
listOffers(settings?: SdkSettings): Promise<ListOffersResponse>
```

### Tipos

```ts
type ListOffersResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.offers.listOffers();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=offers&method=listOffers">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>

## `listPublic`

<div class="lm-endpoint"><span class="lm-http lm-http--get">GET</span><code>/offers/public</code></div>

Assinatura:

```ts
listPublic(settings?: SdkSettings): Promise<ListPublicResponse>
```

### Tipos

```ts
type ListPublicResponse = unknown;
```

### Exemplo

```ts
const response = await sdk.offers.listPublic();
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=offers&method=listPublic">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>