Network.Google.Script.Types

Service Configuration

scriptService :: ServiceConfig

Default request referring to version v1 of the Google Apps Script Execution API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

mailGoogleComScope :: Proxy '["https://mail.google.com/"]

View and manage your mail

m8FeedsScope :: Proxy '["https://www.google.com/m8/feeds"]

Manage your contacts

adminDirectoryUserScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.user"]

View and manage the provisioning of users on your domain

userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]

View your email address

formsCurrentOnlyScope :: Proxy '["https://www.googleapis.com/auth/forms.currentonly"]

View and manage forms that this application has been installed in

driveScope :: Proxy '["https://www.googleapis.com/auth/drive"]

View and manage the files in your Google Drive

adminDirectoryGroupScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.group"]

View and manage the provisioning of groups on your domain

calendarFeedsScope :: Proxy '["https://www.google.com/calendar/feeds"]

Manage your calendars

formsScope :: Proxy '["https://www.googleapis.com/auth/forms"]

View and manage your forms in Google Drive

spreadsheetsScope :: Proxy '["https://www.googleapis.com/auth/spreadsheets"]

View and manage your spreadsheets in Google Drive

groupsScope :: Proxy '["https://www.googleapis.com/auth/groups"]

View and manage your Google Groups

Status

data Status

If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.

See: status smart constructor.

Instances

Eq Status

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Data Status

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status

toConstr :: Status -> Constr

dataTypeOf :: Status -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Status)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status)

gmapT :: (forall b. Data b => b -> b) -> Status -> Status

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r

gmapQ :: (forall d. Data d => d -> u) -> Status -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status

Show Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

Generic Status

Associated Types

type Rep Status :: * -> *

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

ToJSON Status

Methods

toJSON :: Status -> Value

toEncoding :: Status -> Encoding

toJSONList :: [Status] -> Value

toEncodingList :: [Status] -> Encoding

FromJSON Status

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

type Rep Status

type Rep Status = D1 (MetaData "Status" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "Status'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem]))) ((:*:) (S1 (MetaSel (Just Symbol "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

status :: Status

Creates a value of Status with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDetails
• sCode
• sMessage

sDetails :: Lens' Status [StatusDetailsItem]

An array that contains a single `ExecutionError` object that provides information about the nature of the error.

sCode :: Lens' Status (Maybe Int32)

The status code, which should be an enum value of google.rpc.Code.

sMessage :: Lens' Status (Maybe Text)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Operation

data Operation

The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to limitations in Apps Script. If the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field. If the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error. If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.

See: operation smart constructor.

Instances

Eq Operation

Methods

(==) :: Operation -> Operation -> Bool

(/=) :: Operation -> Operation -> Bool

Data Operation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Operation -> c Operation

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Operation

toConstr :: Operation -> Constr

dataTypeOf :: Operation -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Operation)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Operation)

gmapT :: (forall b. Data b => b -> b) -> Operation -> Operation

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r

gmapQ :: (forall d. Data d => d -> u) -> Operation -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Operation -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Operation -> m Operation

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

Generic Operation

Associated Types

type Rep Operation :: * -> *

Methods

from :: Operation -> Rep Operation x

to :: Rep Operation x -> Operation

ToJSON Operation

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

FromJSON Operation

Methods

parseJSON :: Value -> Parser Operation

parseJSONList :: Value -> Parser [Operation]

type Rep Operation

type Rep Operation = D1 (MetaData "Operation" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "Operation'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_oDone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_oError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Status)))) ((:*:) (S1 (MetaSel (Just Symbol "_oResponse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OperationResponse))) ((:*:) (S1 (MetaSel (Just Symbol "_oName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_oMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OperationMetadata)))))))

operation :: Operation

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oDone
• oError
• oResponse
• oName
• oMetadata

oDone :: Lens' Operation (Maybe Bool)

This field is not used.

oError :: Lens' Operation (Maybe Status)

If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.

oResponse :: Lens' Operation (Maybe OperationResponse)

If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.

oName :: Lens' Operation (Maybe Text)

This field is not used.

oMetadata :: Lens' Operation (Maybe OperationMetadata)

This field is not used.

ExecutionRequest

data ExecutionRequest

A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script will return results based on the implementation of the script.

See: executionRequest smart constructor.

Instances

Eq ExecutionRequest

Methods

(==) :: ExecutionRequest -> ExecutionRequest -> Bool

(/=) :: ExecutionRequest -> ExecutionRequest -> Bool

Data ExecutionRequest

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutionRequest -> c ExecutionRequest

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutionRequest

toConstr :: ExecutionRequest -> Constr

dataTypeOf :: ExecutionRequest -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutionRequest)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutionRequest)

gmapT :: (forall b. Data b => b -> b) -> ExecutionRequest -> ExecutionRequest

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionRequest -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionRequest -> r

gmapQ :: (forall d. Data d => d -> u) -> ExecutionRequest -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutionRequest -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutionRequest -> m ExecutionRequest

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionRequest -> m ExecutionRequest

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionRequest -> m ExecutionRequest

Show ExecutionRequest

Methods

showsPrec :: Int -> ExecutionRequest -> ShowS

show :: ExecutionRequest -> String

showList :: [ExecutionRequest] -> ShowS

Generic ExecutionRequest

Associated Types

type Rep ExecutionRequest :: * -> *

Methods

from :: ExecutionRequest -> Rep ExecutionRequest x

to :: Rep ExecutionRequest x -> ExecutionRequest

ToJSON ExecutionRequest

Methods

toJSON :: ExecutionRequest -> Value

toEncoding :: ExecutionRequest -> Encoding

toJSONList :: [ExecutionRequest] -> Value

toEncodingList :: [ExecutionRequest] -> Encoding

FromJSON ExecutionRequest

Methods

parseJSON :: Value -> Parser ExecutionRequest

parseJSONList :: Value -> Parser [ExecutionRequest]

type Rep ExecutionRequest

type Rep ExecutionRequest = D1 (MetaData "ExecutionRequest" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "ExecutionRequest'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_erFunction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_erSessionState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_erDevMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_erParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JSONValue]))))))

executionRequest :: ExecutionRequest

Creates a value of ExecutionRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• erFunction
• erSessionState
• erDevMode
• erParameters

erFunction :: Lens' ExecutionRequest (Maybe Text)

The name of the function to execute in the given script. The name does not include parentheses or parameters.

erSessionState :: Lens' ExecutionRequest (Maybe Text)

This field is not used.

erDevMode :: Lens' ExecutionRequest (Maybe Bool)

If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Execution API. Optional; default is `false`.

erParameters :: Lens' ExecutionRequest [JSONValue]

The parameters to be passed to the function being executed. The type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific objects (such as a `Document` or `Calendar`); they can only be primitive types such as a `string`, `number`, `array`, `object`, or `boolean`. Optional.

StatusDetailsItem

data StatusDetailsItem

Instances

Eq StatusDetailsItem

Methods

(==) :: StatusDetailsItem -> StatusDetailsItem -> Bool

(/=) :: StatusDetailsItem -> StatusDetailsItem -> Bool

Data StatusDetailsItem

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StatusDetailsItem -> c StatusDetailsItem

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StatusDetailsItem

toConstr :: StatusDetailsItem -> Constr

dataTypeOf :: StatusDetailsItem -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StatusDetailsItem)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StatusDetailsItem)

gmapT :: (forall b. Data b => b -> b) -> StatusDetailsItem -> StatusDetailsItem

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StatusDetailsItem -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StatusDetailsItem -> r

gmapQ :: (forall d. Data d => d -> u) -> StatusDetailsItem -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StatusDetailsItem -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StatusDetailsItem -> m StatusDetailsItem

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StatusDetailsItem -> m StatusDetailsItem

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StatusDetailsItem -> m StatusDetailsItem

Show StatusDetailsItem

Methods

showsPrec :: Int -> StatusDetailsItem -> ShowS

show :: StatusDetailsItem -> String

showList :: [StatusDetailsItem] -> ShowS

Generic StatusDetailsItem

Associated Types

type Rep StatusDetailsItem :: * -> *

Methods

from :: StatusDetailsItem -> Rep StatusDetailsItem x

to :: Rep StatusDetailsItem x -> StatusDetailsItem

ToJSON StatusDetailsItem

Methods

toJSON :: StatusDetailsItem -> Value

toEncoding :: StatusDetailsItem -> Encoding

toJSONList :: [StatusDetailsItem] -> Value

toEncodingList :: [StatusDetailsItem] -> Encoding

FromJSON StatusDetailsItem

Methods

parseJSON :: Value -> Parser StatusDetailsItem

parseJSONList :: Value -> Parser [StatusDetailsItem]

type Rep StatusDetailsItem

type Rep StatusDetailsItem = D1 (MetaData "StatusDetailsItem" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" True) (C1 (MetaCons "StatusDetailsItem'" PrefixI True) (S1 (MetaSel (Just Symbol "_sdiAddtional") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text JSONValue))))

statusDetailsItem

Arguments

:: HashMap Text JSONValue

sdiAddtional

-> StatusDetailsItem

Creates a value of StatusDetailsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sdiAddtional

sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)

Properties of the object. Contains field 'type with type URL.

ScriptStackTraceElement

data ScriptStackTraceElement

A stack trace through the script that shows where the execution failed.

See: scriptStackTraceElement smart constructor.

Instances

Eq ScriptStackTraceElement

Methods

(==) :: ScriptStackTraceElement -> ScriptStackTraceElement -> Bool

(/=) :: ScriptStackTraceElement -> ScriptStackTraceElement -> Bool

Data ScriptStackTraceElement

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScriptStackTraceElement -> c ScriptStackTraceElement

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScriptStackTraceElement

toConstr :: ScriptStackTraceElement -> Constr

dataTypeOf :: ScriptStackTraceElement -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScriptStackTraceElement)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScriptStackTraceElement)

gmapT :: (forall b. Data b => b -> b) -> ScriptStackTraceElement -> ScriptStackTraceElement

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScriptStackTraceElement -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScriptStackTraceElement -> r

gmapQ :: (forall d. Data d => d -> u) -> ScriptStackTraceElement -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScriptStackTraceElement -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScriptStackTraceElement -> m ScriptStackTraceElement

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScriptStackTraceElement -> m ScriptStackTraceElement

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScriptStackTraceElement -> m ScriptStackTraceElement

Show ScriptStackTraceElement

Methods

showsPrec :: Int -> ScriptStackTraceElement -> ShowS

show :: ScriptStackTraceElement -> String

showList :: [ScriptStackTraceElement] -> ShowS

Generic ScriptStackTraceElement

Associated Types

type Rep ScriptStackTraceElement :: * -> *

Methods

from :: ScriptStackTraceElement -> Rep ScriptStackTraceElement x

to :: Rep ScriptStackTraceElement x -> ScriptStackTraceElement

ToJSON ScriptStackTraceElement

Methods

toJSON :: ScriptStackTraceElement -> Value

toEncoding :: ScriptStackTraceElement -> Encoding

toJSONList :: [ScriptStackTraceElement] -> Value

toEncodingList :: [ScriptStackTraceElement] -> Encoding

FromJSON ScriptStackTraceElement

Methods

parseJSON :: Value -> Parser ScriptStackTraceElement

parseJSONList :: Value -> Parser [ScriptStackTraceElement]

type Rep ScriptStackTraceElement

type Rep ScriptStackTraceElement = D1 (MetaData "ScriptStackTraceElement" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "ScriptStackTraceElement'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ssteFunction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ssteLineNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))

scriptStackTraceElement :: ScriptStackTraceElement

Creates a value of ScriptStackTraceElement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ssteFunction
• ssteLineNumber

ssteFunction :: Lens' ScriptStackTraceElement (Maybe Text)

The name of the function that failed.

ssteLineNumber :: Lens' ScriptStackTraceElement (Maybe Int32)

The line number where the script failed.

ExecutionError

data ExecutionError

An object that provides information about the nature of an error in the Apps Script Execution API. If an `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single one of these `ExecutionError` objects.

See: executionError smart constructor.

Instances

Eq ExecutionError

Methods

(==) :: ExecutionError -> ExecutionError -> Bool

(/=) :: ExecutionError -> ExecutionError -> Bool

Data ExecutionError

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutionError -> c ExecutionError

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutionError

toConstr :: ExecutionError -> Constr

dataTypeOf :: ExecutionError -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutionError)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutionError)

gmapT :: (forall b. Data b => b -> b) -> ExecutionError -> ExecutionError

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionError -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionError -> r

gmapQ :: (forall d. Data d => d -> u) -> ExecutionError -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutionError -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutionError -> m ExecutionError

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionError -> m ExecutionError

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionError -> m ExecutionError

Show ExecutionError

Methods

showsPrec :: Int -> ExecutionError -> ShowS

show :: ExecutionError -> String

showList :: [ExecutionError] -> ShowS

Generic ExecutionError

Associated Types

type Rep ExecutionError :: * -> *

Methods

from :: ExecutionError -> Rep ExecutionError x

to :: Rep ExecutionError x -> ExecutionError

ToJSON ExecutionError

Methods

toJSON :: ExecutionError -> Value

toEncoding :: ExecutionError -> Encoding

toJSONList :: [ExecutionError] -> Value

toEncodingList :: [ExecutionError] -> Encoding

FromJSON ExecutionError

Methods

parseJSON :: Value -> Parser ExecutionError

parseJSONList :: Value -> Parser [ExecutionError]

type Rep ExecutionError

type Rep ExecutionError = D1 (MetaData "ExecutionError" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "ExecutionError'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_eeScriptStackTraceElements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ScriptStackTraceElement]))) ((:*:) (S1 (MetaSel (Just Symbol "_eeErrorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eeErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

executionError :: ExecutionError

Creates a value of ExecutionError with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eeScriptStackTraceElements
• eeErrorType
• eeErrorMessage

eeScriptStackTraceElements :: Lens' ExecutionError [ScriptStackTraceElement]

An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.

eeErrorType :: Lens' ExecutionError (Maybe Text)

The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.

eeErrorMessage :: Lens' ExecutionError (Maybe Text)

The error message thrown by Apps Script, usually localized into the user's language.

OperationMetadata

data OperationMetadata

This field is not used.

See: operationMetadata smart constructor.

Instances

Eq OperationMetadata

Methods

(==) :: OperationMetadata -> OperationMetadata -> Bool

(/=) :: OperationMetadata -> OperationMetadata -> Bool

Data OperationMetadata

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OperationMetadata -> c OperationMetadata

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OperationMetadata

toConstr :: OperationMetadata -> Constr

dataTypeOf :: OperationMetadata -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c OperationMetadata)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OperationMetadata)

gmapT :: (forall b. Data b => b -> b) -> OperationMetadata -> OperationMetadata

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OperationMetadata -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OperationMetadata -> r

gmapQ :: (forall d. Data d => d -> u) -> OperationMetadata -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OperationMetadata -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OperationMetadata -> m OperationMetadata

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationMetadata -> m OperationMetadata

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationMetadata -> m OperationMetadata

Show OperationMetadata

Methods

showsPrec :: Int -> OperationMetadata -> ShowS

show :: OperationMetadata -> String

showList :: [OperationMetadata] -> ShowS

Generic OperationMetadata

Associated Types

type Rep OperationMetadata :: * -> *

Methods

from :: OperationMetadata -> Rep OperationMetadata x

to :: Rep OperationMetadata x -> OperationMetadata

ToJSON OperationMetadata

Methods

toJSON :: OperationMetadata -> Value

toEncoding :: OperationMetadata -> Encoding

toJSONList :: [OperationMetadata] -> Value

toEncodingList :: [OperationMetadata] -> Encoding

FromJSON OperationMetadata

Methods

parseJSON :: Value -> Parser OperationMetadata

parseJSONList :: Value -> Parser [OperationMetadata]

type Rep OperationMetadata

type Rep OperationMetadata = D1 (MetaData "OperationMetadata" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" True) (C1 (MetaCons "OperationMetadata'" PrefixI True) (S1 (MetaSel (Just Symbol "_omAddtional") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text JSONValue))))

operationMetadata

Arguments

:: HashMap Text JSONValue

omAddtional

-> OperationMetadata

Creates a value of OperationMetadata with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• omAddtional

omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)

Properties of the object. Contains field 'type with type URL.

OperationResponse

data OperationResponse

If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.

See: operationResponse smart constructor.

Instances

Eq OperationResponse

Methods

(==) :: OperationResponse -> OperationResponse -> Bool

(/=) :: OperationResponse -> OperationResponse -> Bool

Data OperationResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OperationResponse -> c OperationResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OperationResponse

toConstr :: OperationResponse -> Constr

dataTypeOf :: OperationResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c OperationResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OperationResponse)

gmapT :: (forall b. Data b => b -> b) -> OperationResponse -> OperationResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OperationResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OperationResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> OperationResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OperationResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OperationResponse -> m OperationResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationResponse -> m OperationResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OperationResponse -> m OperationResponse

Show OperationResponse

Methods

showsPrec :: Int -> OperationResponse -> ShowS

show :: OperationResponse -> String

showList :: [OperationResponse] -> ShowS

Generic OperationResponse

Associated Types

type Rep OperationResponse :: * -> *

Methods

from :: OperationResponse -> Rep OperationResponse x

to :: Rep OperationResponse x -> OperationResponse

ToJSON OperationResponse

Methods

toJSON :: OperationResponse -> Value

toEncoding :: OperationResponse -> Encoding

toJSONList :: [OperationResponse] -> Value

toEncodingList :: [OperationResponse] -> Encoding

FromJSON OperationResponse

Methods

parseJSON :: Value -> Parser OperationResponse

parseJSONList :: Value -> Parser [OperationResponse]

type Rep OperationResponse

type Rep OperationResponse = D1 (MetaData "OperationResponse" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" True) (C1 (MetaCons "OperationResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_orAddtional") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text JSONValue))))

operationResponse

Arguments

:: HashMap Text JSONValue

orAddtional

-> OperationResponse

Creates a value of OperationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• orAddtional

orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)

Properties of the object. Contains field 'type with type URL.

ExecutionResponse

data ExecutionResponse

An object that provides the return value of a function executed through the Apps Script Execution API. If an `run` call succeeds and the script function returns successfully, the response body's `response` field will contain this `ExecutionResponse` object.

See: executionResponse smart constructor.

Instances

Eq ExecutionResponse

Methods

(==) :: ExecutionResponse -> ExecutionResponse -> Bool

(/=) :: ExecutionResponse -> ExecutionResponse -> Bool

Data ExecutionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutionResponse -> c ExecutionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutionResponse

toConstr :: ExecutionResponse -> Constr

dataTypeOf :: ExecutionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutionResponse)

gmapT :: (forall b. Data b => b -> b) -> ExecutionResponse -> ExecutionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ExecutionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutionResponse -> m ExecutionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionResponse -> m ExecutionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutionResponse -> m ExecutionResponse

Show ExecutionResponse

Methods

showsPrec :: Int -> ExecutionResponse -> ShowS

show :: ExecutionResponse -> String

showList :: [ExecutionResponse] -> ShowS

Generic ExecutionResponse

Associated Types

type Rep ExecutionResponse :: * -> *

Methods

from :: ExecutionResponse -> Rep ExecutionResponse x

to :: Rep ExecutionResponse x -> ExecutionResponse

ToJSON ExecutionResponse

Methods

toJSON :: ExecutionResponse -> Value

toEncoding :: ExecutionResponse -> Encoding

toJSONList :: [ExecutionResponse] -> Value

toEncodingList :: [ExecutionResponse] -> Encoding

FromJSON ExecutionResponse

Methods

parseJSON :: Value -> Parser ExecutionResponse

parseJSONList :: Value -> Parser [ExecutionResponse]

type Rep ExecutionResponse

type Rep ExecutionResponse = D1 (MetaData "ExecutionResponse" "Network.Google.Script.Types.Product" "gogol-script-0.2.0-1ojfgFuXLcear11PYOLXk" False) (C1 (MetaCons "ExecutionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_erStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_erResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JSONValue)))))

executionResponse :: ExecutionResponse

Creates a value of ExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• erStatus
• erResult

erStatus :: Lens' ExecutionResponse (Maybe Text)

erResult :: Lens' ExecutionResponse (Maybe JSONValue)

The return value of the script function. The type will match the type returned in Apps Script. Functions called through the Execution API cannot return Apps Script-specific objects (such as a `Document` or `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`.