Request (GogApi)

Request Module

Namespace: GogApi.Internal
Assembly: GogApi.dll

This module contains low-level functions and types to make requests to the GOG API

Types

Type	Description
RequestParameter	Simple record for request parameters

Functions and values

Function or value	Description
`createOptionalRequestParameter name valueOption` Full Usage: `createOptionalRequestParameter name valueOption` Parameters: name : `string` valueOption : `string option` Returns: `RequestParameter list`	Creates an optional RequestParameter name : `string` valueOption : `string option` Returns: `RequestParameter list`
`createRequestParameter name value` Full Usage: `createRequestParameter name value` Parameters: name : `string` value : `string` Returns: `RequestParameter list`	Creates a RequestParameter name : `string` value : `string` Returns: `RequestParameter list`
`jsonConfig` Full Usage: `jsonConfig` Returns: `JsonConfig`	Used config for parsing the JSON API responses Returns: `JsonConfig`
`makeRequest authentication parameters url` Full Usage: `makeRequest authentication parameters url` Parameters: authentication : `Authentication option` parameters : `RequestParameter list` url : `string` Returns: `Async<Result<'T, (string * string)>>`	Function which creates an request which will be parsed into an object after returning authentication : `Authentication option` parameters : `RequestParameter list` url : `string` Returns: `Async<Result<'T, (string * string)>>`
`parseJson rawJson` Full Usage: `parseJson rawJson` Parameters: rawJson : `string` Returns: `Result<'T, (string * string)>`	Helper function which catches exception from FSharp.Json and returns Result type rawJson : `string` Returns: `Result<'T, (string * string)>`
`setupRequest authentication parameters url` Full Usage: `setupRequest authentication parameters url` Parameters: authentication : `Authentication option` parameters : `RequestParameter list` url : `string` Returns: `Async<Response>`	Creates the GET request with correct authentication headers and parameters to given url authentication : `Authentication option` parameters : `RequestParameter list` url : `string` Returns: `Async<Response>`