throttle

Documentation

Index

• type Request
  • func (r *Request) Get(c *sa.Client, user string) (*Response, error)
  • func (r *Request) Put(c *sa.Client, user string) (*Response, error)
• type Response
  • func (r *Response) IsSignatureValid(c *sa.Client) (bool, error)

Types

type Request

type Request struct {
}

Request :

Empty Request struct for easy function access.

func (*Request) Get

func (r *Request) Get(c *sa.Client, user string) (*Response, error)

Get :

Executes a post to the users throttle/ endpoint.

Parameters:

[Required] r: should have all required fields of the struct populated before using.
[Required] c: passing in the client containing authorization and host information.
[Required] user: the user id of the user you wish to get the throttle status for.

Returns:

Response: Struct marshaled from the Json response from the API endpoints.
Error: If an error is encountered, response will be nil and the error must be handled.

func (*Request) Put

func (r *Request) Put(c *sa.Client, user string) (*Response, error)

Put :

Executes a put request to the users throttle/ endpoint.

Parameters:

[Required] r: should have all required fields of the struct populated before using.
[Required] c: passing in the client containing authorization and host information.
[Required] user: the user id of the user you wish to reset the throttle status for.

Returns:

Response: Struct marshaled from the Json response from the API endpoints.
Error: If an error is encountered, response will be nil and the error must be handled.

type Response

type Response struct {
	Status       string         `json:"status"`
	Message      string         `json:"message"`
	Count        int            `json:"count,omitempty"`
	RawJSON      string         `json:"-"`
	HTTPResponse *http.Response `json:"-"`
}

Response :

Response struct that will be populated after the request.

func (*Response) IsSignatureValid

func (r *Response) IsSignatureValid(c *sa.Client) (bool, error)

IsSignatureValid :

Helper function to validate the SecureAuth Response signature in X-SA-SIGNATURE

Parameters:

[Required] r: response struct with HTTPResponse
[Required] c: passing in the client with application id and key

Returns:

bool: if true, computed signature matches X-SA-SIGNATURE. if false, computed signature does not match.
error: If an error is encountered, bool will be false and the error must be handled.