README.md

Ratelimit

(Ratelimit)

Overview

Available Operations

• SetOverride
• ListOverrides
• GetOverride

SetOverride

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Ratelimit.SetOverride(ctx, operations.SetOverrideRequestBody{
        NamespaceID: unkeygo.String("rlns_1234"),
        NamespaceName: unkeygo.String("email.outbound"),
        Identifier: "user_123",
        Limit: 10,
        Duration: 60000,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.SetOverrideRequestBody	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.SetOverrideResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

ListOverrides

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Ratelimit.ListOverrides(ctx, operations.ListOverridesRequest{
        NamespaceID: unkeygo.String("rlns_1234"),
        NamespaceName: unkeygo.String("email.outbound"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ListOverridesRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListOverridesResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

GetOverride

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Ratelimit.GetOverride(ctx, operations.GetOverrideRequest{
        NamespaceID: unkeygo.String("rlns_1234"),
        NamespaceName: unkeygo.String("email.outbound"),
        Identifier: "user_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.GetOverrideRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetOverrideResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	*/*