spacetraders_sdk - v1.0.0

utils/api

Types

ApiError

</> 
pub type ApiError {
  HttpcError(httpc.HttpError)
  JsonDecodeError(json.DecodeError)
  ResponseError(ErrorResponse)
}

Constructors

ApiResponse

</> 
pub type ApiResponse(a) =
  Result(a, ApiError)

ErrorResponse

</> 
pub type ErrorResponse {
  ErrorResponse(
    code: Int,
    message: String,
    data: option.Option(dynamic.Dynamic),
    request_id: option.Option(String),
  )
}

Constructors

PagedData

</> 
pub type PagedData(data) {
  PagedData(data: data, meta: meta.Meta)
}

Constructors

Values

data_decoder

</> 
pub fn data_decoder(
  decoder: decode.Decoder(data),
) -> decode.Decoder(data)

delete

</> 
pub fn delete(
  auth_method: auth.AuthMethod,
  path: String,
) -> request.Request(BitArray)

error_decoder

</> 
pub fn error_decoder() -> decode.Decoder(ErrorResponse)

error_response_decoder

</> 
pub fn error_response_decoder() -> decode.Decoder(ErrorResponse)

get

</> 
pub fn get(
  auth_method: auth.AuthMethod,
  path: String,
) -> request.Request(BitArray)

get_page

</> 
pub fn get_page(
  auth_method: auth.AuthMethod,
  path: String,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

get_page_query

</> 
pub fn get_page_query(
  auth_method: auth.AuthMethod,
  path: String,
  page: option.Option(Int),
  limit: option.Option(Int),
  query: List(#(String, String)),
) -> request.Request(BitArray)

get_query

</> 
pub fn get_query(
  auth_method: auth.AuthMethod,
  path: String,
  query: List(#(String, String)),
) -> request.Request(BitArray)

paged_data_decoder

</> 
pub fn paged_data_decoder(
  decoder: decode.Decoder(data),
) -> decode.Decoder(PagedData(data))

parse_data_response

</> 
pub fn parse_data_response(
  response: response.Response(BitArray),
  decoder: decode.Decoder(data),
) -> Result(data, ApiError)

parse_error_response

</> 
pub fn parse_error_response(
  response: response.Response(BitArray),
) -> Result(data, ApiError)

parse_paged_data_response

</> 
pub fn parse_paged_data_response(
  response: response.Response(BitArray),
  decoder: decode.Decoder(data),
) -> Result(PagedData(data), ApiError)

parse_response

</> 
pub fn parse_response(
  response: response.Response(BitArray),
  decoder: decode.Decoder(data),
) -> Result(data, ApiError)

patch

</> 
pub fn patch(
  auth_method: auth.AuthMethod,
  path: String,
) -> request.Request(BitArray)

patch_json

</> 
pub fn patch_json(
  auth_method: auth.AuthMethod,
  path: String,
  body: json.Json,
) -> request.Request(BitArray)

patch_text

</> 
pub fn patch_text(
  auth_method: auth.AuthMethod,
  path: String,
  body: String,
) -> request.Request(BitArray)

post

</> 
pub fn post(
  auth_method: auth.AuthMethod,
  path: String,
) -> request.Request(BitArray)

post_json

</> 
pub fn post_json(
  auth_method: auth.AuthMethod,
  path: String,
  body: json.Json,
) -> request.Request(BitArray)

post_text

</> 
pub fn post_text(
  auth_method: auth.AuthMethod,
  path: String,
  body: String,
) -> request.Request(BitArray)

put

</> 
pub fn put(
  auth_method: auth.AuthMethod,
  path: String,
) -> request.Request(BitArray)

put_json

</> 
pub fn put_json(
  auth_method: auth.AuthMethod,
  path: String,
  body: json.Json,
) -> request.Request(BitArray)

put_text

</> 
pub fn put_text(
  auth_method: auth.AuthMethod,
  path: String,
  body: String,
) -> request.Request(BitArray)

send

</> 
pub fn send(
  request: request.Request(BitArray),
) -> Result(response.Response(BitArray), ApiError)

time_decoder

</> 
pub fn time_decoder() -> decode.Decoder(birl.Time)

try_send

</> 
pub fn try_send(
  request: request.Request(BitArray),
  apply fun: fn(response.Response(BitArray)) -> Result(
    data,
    ApiError,
  ),
) -> Result(data, ApiError)
✨ Search Document