-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Google Apps Script SDK.
--
-- Manages and executes Google Apps Script projects.
--
-- Warning: This is an experimental prototype/preview release
-- which is still under exploratory development and not intended for
-- public use, caveat emptor!
--
-- This library is compatible with version v1 of the API.
@package gogol-script
@version 0.5.0
module Network.Google.Script.Types
-- | Default request referring to version v1 of the Apps Script
-- API. This contains the host and root path used as a starting point for
-- constructing service requests.
scriptService :: ServiceConfig
-- | Read, compose, send, and permanently delete all your email from Gmail
mailGoogleComScope :: Proxy '["https://mail.google.com/"]
-- | See, edit, download, and permanently delete your contacts
m8FeedsScope :: Proxy '["https://www.google.com/m8/feeds"]
-- | View and manage the provisioning of users on your domain
adminDirectoryUserScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.user"]
-- | Create and update Google Apps Script projects
scriptProjectsScope :: Proxy '["https://www.googleapis.com/auth/script.projects"]
-- | View your email address
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
-- | View Google Apps Script project's metrics
scriptMetricsScope :: Proxy '["https://www.googleapis.com/auth/script.metrics"]
-- | View and manage forms that this application has been installed in
formsCurrentOnlyScope :: Proxy '["https://www.googleapis.com/auth/forms.currentonly"]
-- | Create and update Google Apps Script deployments
scriptDeploymentsScope :: Proxy '["https://www.googleapis.com/auth/script.deployments"]
-- | See, edit, create, and delete all of your Google Drive files
driveScope :: Proxy '["https://www.googleapis.com/auth/drive"]
-- | View and manage the provisioning of groups on your domain
adminDirectoryGroupScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.group"]
-- | View Google Apps Script projects
scriptProjectsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.projects.readonly"]
-- | See, edit, share, and permanently delete all the calendars you can
-- access using Google Calendar
calendarFeedsScope :: Proxy '["https://www.google.com/calendar/feeds"]
-- | View and manage your forms in Google Drive
formsScope :: Proxy '["https://www.googleapis.com/auth/forms"]
-- | See, edit, create, and delete your spreadsheets in Google Drive
spreadsheetsScope :: Proxy '["https://www.googleapis.com/auth/spreadsheets"]
-- | View Google Apps Script deployments
scriptDeploymentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.deployments.readonly"]
-- | View and manage your Google Groups
groupsScope :: Proxy '["https://www.googleapis.com/auth/groups"]
-- | View Google Apps Script processes
scriptProcessesScope :: Proxy '["https://www.googleapis.com/auth/script.processes"]
-- | View and manage your Google Docs documents
documentsScope :: Proxy '["https://www.googleapis.com/auth/documents"]
-- | A set of functions. No duplicates are permitted.
--
-- See: googleAppsScriptTypeFunctionSet smart constructor.
data GoogleAppsScriptTypeFunctionSet
-- | Creates a value of GoogleAppsScriptTypeFunctionSet with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeFunctionSet :: GoogleAppsScriptTypeFunctionSet
-- | A list of functions composing the set.
gastfsValues :: Lens' GoogleAppsScriptTypeFunctionSet [GoogleAppsScriptTypeFunction]
-- | API executable entry point configuration.
--
-- See: googleAppsScriptTypeExecutionAPIConfig smart
-- constructor.
data GoogleAppsScriptTypeExecutionAPIConfig
-- | Creates a value of GoogleAppsScriptTypeExecutionAPIConfig with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeExecutionAPIConfig :: GoogleAppsScriptTypeExecutionAPIConfig
-- | Who has permission to run the API executable.
gasteacAccess :: Lens' GoogleAppsScriptTypeExecutionAPIConfig (Maybe GoogleAppsScriptTypeExecutionAPIConfigAccess)
-- | The executions type.
data GoogleAppsScriptTypeProcessProcessType
-- | PROCESS_TYPE_UNSPECIFIED Unspecified type.
ProcessTypeUnspecified :: GoogleAppsScriptTypeProcessProcessType
-- | ADD_ON The process was started from an add-on entry point.
AddOn :: GoogleAppsScriptTypeProcessProcessType
-- | EXECUTION_API The process was started using the Apps Script
-- API.
ExecutionAPI :: GoogleAppsScriptTypeProcessProcessType
-- | TIME_DRIVEN The process was started from a time-based
-- trigger.
TimeDriven :: GoogleAppsScriptTypeProcessProcessType
-- | TRIGGER The process was started from an event-based trigger.
Trigger :: GoogleAppsScriptTypeProcessProcessType
-- | WEBAPP The process was started from a web app entry point.
WebApp :: GoogleAppsScriptTypeProcessProcessType
-- | EDITOR The process was started using the Apps Script IDE.
Editor :: GoogleAppsScriptTypeProcessProcessType
-- | SIMPLE_TRIGGER The process was started from a G Suite simple
-- trigger.
SimpleTrigger :: GoogleAppsScriptTypeProcessProcessType
-- | MENU The process was started from a G Suite menu item.
Menu :: GoogleAppsScriptTypeProcessProcessType
-- | BATCH_TASK The process was started as a task in a batch job.
BatchTask :: GoogleAppsScriptTypeProcessProcessType
-- | If a `run` call succeeds but the script function (or Apps Script
-- itself) throws an exception, the response body's error field contains
-- this `Status` object.
--
-- See: status smart constructor.
data 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:
--
--
status :: Status
-- | An array that contains a single ExecutionError object that provides
-- information about the nature of the error.
sDetails :: Lens' Status [StatusDetailsItem]
-- | The status code. For this API, this value either:
--
--
-- - 10, indicating a `SCRIPT_TIMEOUT` error,
-- - 3, indicating an `INVALID_ARGUMENT` error, or
-- - 1, indicating a `CANCELLED` execution.
--
sCode :: Lens' Status (Maybe Int32)
-- | A developer-facing error message, which is in English. Any user-facing
-- error message is localized and sent in the details field, or localized
-- by the client.
sMessage :: Lens' Status (Maybe Text)
-- | The executing users access level to the script.
data GoogleAppsScriptTypeProcessUserAccessLevel
-- | USER_ACCESS_LEVEL_UNSPECIFIED User access level unspecified
UserAccessLevelUnspecified :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | NONE The user has no access.
None :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | READ The user has read-only access.
Read' :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | WRITE The user has write access.
Write :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | OWNER The user is an owner.
Owner :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | Resource containing usage stats for a given script, based on the
-- supplied filter and mask present in the request.
--
-- See: metrics smart constructor.
data Metrics
-- | Creates a value of Metrics with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
metrics :: Metrics
-- | Number of active users.
mActiveUsers :: Lens' Metrics [MetricsValue]
-- | Number of failed executions.
mFailedExecutions :: Lens' Metrics [MetricsValue]
-- | Number of total executions.
mTotalExecutions :: Lens' Metrics [MetricsValue]
-- | Representation of a single script process execution that was started
-- from the script editor, a trigger, an application, or using the Apps
-- Script API. This is distinct from the `Operation` resource, which only
-- represents executions started via the Apps Script API.
--
-- See: googleAppsScriptTypeProcess smart constructor.
data GoogleAppsScriptTypeProcess
-- | Creates a value of GoogleAppsScriptTypeProcess with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeProcess :: GoogleAppsScriptTypeProcess
-- | The executions status.
gastpProcessStatus :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessStatus)
-- | Time the execution started.
gastpStartTime :: Lens' GoogleAppsScriptTypeProcess (Maybe UTCTime)
-- | Name of the script being executed.
gastpProjectName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
-- | Name of the function the started the execution.
gastpFunctionName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
-- | The executing users access level to the script.
gastpUserAccessLevel :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessUserAccessLevel)
-- | The executions type.
gastpProcessType :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessType)
-- | Duration the execution spent executing.
gastpDuration :: Lens' GoogleAppsScriptTypeProcess (Maybe Scientific)
-- | Who to execute the web app as.
data GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | UNKNOWN_EXECUTE_AS Default value, should not be used.
UnknownExecuteAs :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | USER_ACCESSING The script runs as the user accessing the web
-- app.
UserAccessing :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | USER_DEPLOYING The script runs as the user who deployed the
-- web app. Note that this is not necessarily the owner of the script
-- project.
UserDeploying :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | The script project resource.
--
-- See: project smart constructor.
data Project
-- | Creates a value of Project with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
project :: Project
-- | User who originally created the script.
pCreator :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
-- | User who last modified the script.
pLastModifyUser :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
-- | When the script was last updated.
pUpdateTime :: Lens' Project (Maybe UTCTime)
-- | The script project's Drive ID.
pScriptId :: Lens' Project (Maybe Text)
-- | The title for the project.
pTitle :: Lens' Project (Maybe Text)
-- | The parent's Drive ID that the script will be attached to. This is
-- usually the ID of a Google Document or Google Sheet. This filed is
-- optional, and if not set, a stand-alone script will be created.
pParentId :: Lens' Project (Maybe Text)
-- | When the script was created.
pCreateTime :: Lens' Project (Maybe UTCTime)
-- | A representation of an execution of an Apps Script function started
-- with run. The execution response does not arrive until the function
-- finishes executing. The maximum execution runtime is listed in the
-- Apps Script quotas guide.
--
-- After execution has started, it can have one of four outcomes:
--
--
-- - If the script function returns successfully, the response field
-- contains 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 contains a Status object. The `Status`
-- object's `details` field contains an array with a single
-- ExecutionError object that provides information about the nature of
-- the error.
-- - If the execution has not yet completed, the done field is `false`
-- and the neither the `response` nor `error` fields are present.
-- - If the `run` call itself fails (for example, because of a
-- malformed request or an authorization error), the method returns an
-- HTTP response code in the 4XX range with a different format for the
-- response body. Client libraries automatically convert a 4XX response
-- into an exception class.
--
--
-- See: operation smart constructor.
data 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:
--
--
operation :: Operation
-- | This field indicates whether the script execution has completed. A
-- completed execution has a populated `response` field containing the
-- ExecutionResponse from function that was executed.
oDone :: Lens' Operation (Maybe Bool)
-- | If a `run` call succeeds but the script function (or Apps Script
-- itself) throws an exception, this field contains a Status object. The
-- `Status` object's `details` field contains an array with a single
-- ExecutionError object that provides information about the nature of
-- the error.
oError :: Lens' Operation (Maybe Status)
-- | If the script function returns successfully, this field contains an
-- ExecutionResponse object with the function's return value.
oResponse :: Lens' Operation (Maybe OperationResponse)
-- | Response with the list of Process resources.
--
-- See: listUserProcessesResponse smart constructor.
data ListUserProcessesResponse
-- | Creates a value of ListUserProcessesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listUserProcessesResponse :: ListUserProcessesResponse
-- | Token for the next page of results. If empty, there are no more pages
-- remaining.
luprNextPageToken :: Lens' ListUserProcessesResponse (Maybe Text)
-- | List of processes matching request parameters.
luprProcesses :: Lens' ListUserProcessesResponse [GoogleAppsScriptTypeProcess]
-- | A generic empty message that you can re-use to avoid defining
-- duplicated empty messages in your APIs. A typical example is to use it
-- as the request or the response type of an API method. For instance:
-- service Foo { rpc Bar(google.protobuf.Empty) returns
-- (google.protobuf.Empty); } The JSON representation for `Empty` is
-- empty JSON object `{}`.
--
-- See: empty smart constructor.
data Empty
-- | Creates a value of Empty with the minimum fields required to
-- make a request.
empty :: Empty
-- | A simple user profile resource.
--
-- See: googleAppsScriptTypeUser smart constructor.
data GoogleAppsScriptTypeUser
-- | Creates a value of GoogleAppsScriptTypeUser with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeUser :: GoogleAppsScriptTypeUser
-- | The user's identifying email address.
gastuEmail :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's photo.
gastuPhotoURL :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's domain.
gastuDomain :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's display name.
gastuName :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | A configuration that defines how a deployment is accessed externally.
--
-- See: entryPoint smart constructor.
data EntryPoint
-- | Creates a value of EntryPoint with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
entryPoint :: EntryPoint
-- | An entry point specification for Apps Script API execution calls.
epExecutionAPI :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIEntryPoint)
-- | Add-on properties.
epAddOn :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPoint)
-- | The type of the entry point.
epEntryPointType :: Lens' EntryPoint (Maybe EntryPointEntryPointType)
-- | An entry point specification for web apps.
epWebApp :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeWebAppEntryPoint)
-- | Response with the list of the versions for the specified script
-- project.
--
-- See: listVersionsResponse smart constructor.
data ListVersionsResponse
-- | Creates a value of ListVersionsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listVersionsResponse :: ListVersionsResponse
-- | The token use to fetch the next page of records. if not exist in the
-- response, that means no more versions to list.
lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text)
-- | The list of versions.
lvrVersions :: Lens' ListVersionsResponse [Version]
-- | Who has permission to run the API executable.
data GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | UNKNOWN_ACCESS Default value, should not be used.
UnknownAccess :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | MYSELF Only the user who deployed the web app or executable
-- can access it. Note that this is not necessarily the owner of the
-- script project.
Myself :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | DOMAIN Only users in the same domain as the user who deployed
-- the web app or executable can access it.
Domain :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | ANYONE Any logged in user can access the web app or
-- executable.
Anyone :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | ANYONE_ANONYMOUS Any user, logged in or not, can access the
-- web app or executable.
AnyoneAnonymous :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | A request to run the function in a script. The script is identified by
-- the specified `script_id`. Executing a function on a script returns
-- results based on the implementation of the script.
--
-- See: executionRequest smart constructor.
data 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:
--
--
executionRequest :: ExecutionRequest
-- | The name of the function to execute in the given script. The name does
-- not include parentheses or parameters. It can reference a function in
-- an included library such as `Library.libFunction1`.
erFunction :: Lens' ExecutionRequest (Maybe Text)
-- | Deprecated. For use with Android add-ons only. An ID that
-- represents the user's current session in the Android app for Google
-- Docs or Sheets, included as extra data in the Intent that
-- launches the add-on. When an Android add-on is run with a session
-- state, it gains the privileges of a bound script—that is, it
-- can access information like the user's current cursor position (in
-- Docs) or selected cell (in Sheets). To retrieve the state, call
-- `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
-- Optional.
erSessionState :: Lens' ExecutionRequest (Maybe Text)
-- | 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 Apps Script API. Optional; default is `false`.
erDevMode :: Lens' ExecutionRequest (Maybe Bool)
-- | The parameters to be passed to the function being executed. The object
-- type for each parameter should match the expected type in Apps Script.
-- Parameters cannot be Apps Script-specific object types (such as a
-- `Document` or a `Calendar`); they can only be primitive types such as
-- `string`, `number`, `array`, `object`, or `boolean`. Optional.
erParameters :: Lens' ExecutionRequest [JSONValue]
-- | Response with the list of Process resources.
--
-- See: listScriptProcessesResponse smart constructor.
data ListScriptProcessesResponse
-- | Creates a value of ListScriptProcessesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listScriptProcessesResponse :: ListScriptProcessesResponse
-- | Token for the next page of results. If empty, there are no more pages
-- remaining.
lsprNextPageToken :: Lens' ListScriptProcessesResponse (Maybe Text)
-- | List of processes matching request parameters.
lsprProcesses :: Lens' ListScriptProcessesResponse [GoogleAppsScriptTypeProcess]
data 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:
--
--
statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
-- | Properties of the object. Contains field 'type with type URL.
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
-- | The type of the file.
data FileType
-- | ENUM_TYPE_UNSPECIFIED Undetermined file type; never actually
-- used.
EnumTypeUnspecified :: FileType
-- | SERVER_JS An Apps Script server-side code file.
ServerJs :: FileType
-- | HTML A file containing client-side HTML.
HTML :: FileType
-- | JSON A file in JSON format. This type is only used for the
-- script project's manifest. The manifest file content must match the
-- structure of a valid ScriptManifest
JSON :: FileType
-- | A stack trace through the script that shows where the execution
-- failed.
--
-- See: scriptStackTraceElement smart constructor.
data 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:
--
--
scriptStackTraceElement :: ScriptStackTraceElement
-- | The name of the function that failed.
ssteFunction :: Lens' ScriptStackTraceElement (Maybe Text)
-- | The line number where the script failed.
ssteLineNumber :: Lens' ScriptStackTraceElement (Maybe Int32)
-- | The Content resource.
--
-- See: content smart constructor.
data Content
-- | Creates a value of Content with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
content :: Content
-- | The script project's Drive ID.
cScriptId :: Lens' Content (Maybe Text)
-- | The list of script project files. One of the files is a script
-- manifest; it must be named "appsscript", must have type of JSON, and
-- include the manifest configurations for the project.
cFiles :: Lens' Content [File]
-- | The add-on's required list of supported container types.
data GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | UNKNOWN_ADDON_TYPE Default value, unknown add-on type.
UnknownAddonType :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | GMAIL Add-on type for Gmail.
Gmail :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | DATA_STUDIO Add-on type for Data Studio.
DataStudio :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | Metrics value that holds number of executions counted.
--
-- See: metricsValue smart constructor.
data MetricsValue
-- | Creates a value of MetricsValue with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
metricsValue :: MetricsValue
-- | Required field indicating the start time of the interval.
mvStartTime :: Lens' MetricsValue (Maybe UTCTime)
-- | Indicates the number of executions counted.
mvValue :: Lens' MetricsValue (Maybe Word64)
-- | Required field indicating the end time of the interval.
mvEndTime :: Lens' MetricsValue (Maybe UTCTime)
-- | An add-on entry point.
--
-- See: googleAppsScriptTypeAddOnEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeAddOnEntryPoint
-- | Creates a value of GoogleAppsScriptTypeAddOnEntryPoint with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeAddOnEntryPoint :: GoogleAppsScriptTypeAddOnEntryPoint
-- | The add-on's required post install tip URL.
gastaoepPostInstallTipURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's required list of supported container types.
gastaoepAddOnType :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPointAddOnType)
-- | The add-on's optional report issue URL.
gastaoepReportIssueURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's optional help URL.
gastaoepHelpURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's required title.
gastaoepTitle :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's optional description.
gastaoepDescription :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | Web app entry point configuration.
--
-- See: googleAppsScriptTypeWebAppConfig smart constructor.
data GoogleAppsScriptTypeWebAppConfig
-- | Creates a value of GoogleAppsScriptTypeWebAppConfig with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeWebAppConfig :: GoogleAppsScriptTypeWebAppConfig
-- | Who has permission to run the web app.
gastwacAccess :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigAccess)
-- | Who to execute the web app as.
gastwacExecuteAs :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigExecuteAs)
-- | A resource representing a script project version. A version is a
-- "snapshot" of a script project and is similar to a read-only branched
-- release. When creating deployments, the version to use must be
-- specified.
--
-- See: version smart constructor.
data Version
-- | Creates a value of Version with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
version :: Version
-- | The incremental ID that is created by Apps Script when a version is
-- created. This is system assigned number and is immutable once created.
vVersionNumber :: Lens' Version (Maybe Int32)
-- | The script project's Drive ID.
vScriptId :: Lens' Version (Maybe Text)
-- | The description for this version.
vDescription :: Lens' Version (Maybe Text)
-- | When the version was created.
vCreateTime :: Lens' Version (Maybe UTCTime)
-- | V1 error format.
data Xgafv
-- | 1 v1 error format
X1 :: Xgafv
-- | 2 v2 error format
X2 :: Xgafv
-- | An object that provides information about the nature of an error
-- resulting from an attempted execution of a script function using the
-- Apps Script API. If a run call succeeds but the script function (or
-- Apps Script itself) throws an exception, the response body's error
-- field contains a Status object. The `Status` object's `details` field
-- contains an array with a single one of these `ExecutionError` objects.
--
-- See: executionError smart constructor.
data 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:
--
--
executionError :: ExecutionError
-- | An array of objects that provide a stack trace through the script to
-- show where the execution failed, with the deepest call first.
eeScriptStackTraceElements :: Lens' ExecutionError [ScriptStackTraceElement]
-- | The error type, for example `TypeError` or `ReferenceError`. If the
-- error type is unavailable, this field is not included.
eeErrorType :: Lens' ExecutionError (Maybe Text)
-- | The error message thrown by Apps Script, usually localized into the
-- user's language.
eeErrorMessage :: Lens' ExecutionError (Maybe Text)
-- | A web application entry point.
--
-- See: googleAppsScriptTypeWebAppEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeWebAppEntryPoint
-- | Creates a value of GoogleAppsScriptTypeWebAppEntryPoint with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeWebAppEntryPoint :: GoogleAppsScriptTypeWebAppEntryPoint
-- | The entry point's configuration.
gastwaepEntryPointConfig :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe GoogleAppsScriptTypeWebAppConfig)
-- | The URL for the web application.
gastwaepURL :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe Text)
-- | The type of the entry point.
data EntryPointEntryPointType
-- | ENTRY_POINT_TYPE_UNSPECIFIED An unspecified entry point.
EPEPTEntryPointTypeUnspecified :: EntryPointEntryPointType
-- | WEB_APP A web application entry point.
EPEPTWebApp :: EntryPointEntryPointType
-- | EXECUTION_API An API executable entry point.
EPEPTExecutionAPI :: EntryPointEntryPointType
-- | ADD_ON An Add-On entry point.
EPEPTAddOn :: EntryPointEntryPointType
-- | Request to create a script project.
--
-- See: createProjectRequest smart constructor.
data CreateProjectRequest
-- | Creates a value of CreateProjectRequest with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createProjectRequest :: CreateProjectRequest
-- | The title for the project.
cprTitle :: Lens' CreateProjectRequest (Maybe Text)
-- | The Drive ID of a parent file that the created script project is bound
-- to. This is usually the ID of a Google Doc, Google Sheet, Google Form,
-- or Google Slides file. If not set, a standalone script project is
-- created.
cprParentId :: Lens' CreateProjectRequest (Maybe Text)
-- | The executions status.
data GoogleAppsScriptTypeProcessProcessStatus
-- | PROCESS_STATUS_UNSPECIFIED Unspecified status.
ProcessStatusUnspecified :: GoogleAppsScriptTypeProcessProcessStatus
-- | RUNNING The process is currently running.
Running :: GoogleAppsScriptTypeProcessProcessStatus
-- | PAUSED The process has paused.
Paused :: GoogleAppsScriptTypeProcessProcessStatus
-- | COMPLETED The process has completed.
Completed :: GoogleAppsScriptTypeProcessProcessStatus
-- | CANCELED The process was cancelled.
Canceled :: GoogleAppsScriptTypeProcessProcessStatus
-- | FAILED The process failed.
Failed :: GoogleAppsScriptTypeProcessProcessStatus
-- | TIMED_OUT The process timed out.
TimedOut :: GoogleAppsScriptTypeProcessProcessStatus
-- | UNKNOWN Process status unknown.
Unknown :: GoogleAppsScriptTypeProcessProcessStatus
-- | DELAYED The process is delayed, waiting for quota.
Delayed :: GoogleAppsScriptTypeProcessProcessStatus
-- | Metadata the defines how a deployment is configured.
--
-- See: deploymentConfig smart constructor.
data DeploymentConfig
-- | Creates a value of DeploymentConfig with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deploymentConfig :: DeploymentConfig
-- | The version number on which this deployment is based.
dcVersionNumber :: Lens' DeploymentConfig (Maybe Int32)
-- | The script project's Drive ID.
dcScriptId :: Lens' DeploymentConfig (Maybe Text)
-- | The manifest file name for this deployment.
dcManifestFileName :: Lens' DeploymentConfig (Maybe Text)
-- | The description for this deployment.
dcDescription :: Lens' DeploymentConfig (Maybe Text)
-- | Who has permission to run the web app.
data GoogleAppsScriptTypeWebAppConfigAccess
-- | UNKNOWN_ACCESS Default value, should not be used.
GASTWACAUnknownAccess :: GoogleAppsScriptTypeWebAppConfigAccess
-- | MYSELF Only the user who deployed the web app or executable
-- can access it. Note that this is not necessarily the owner of the
-- script project.
GASTWACAMyself :: GoogleAppsScriptTypeWebAppConfigAccess
-- | DOMAIN Only users in the same domain as the user who deployed
-- the web app or executable can access it.
GASTWACADomain :: GoogleAppsScriptTypeWebAppConfigAccess
-- | ANYONE Any logged in user can access the web app or
-- executable.
GASTWACAAnyone :: GoogleAppsScriptTypeWebAppConfigAccess
-- | ANYONE_ANONYMOUS Any user, logged in or not, can access the
-- web app or executable.
GASTWACAAnyoneAnonymous :: GoogleAppsScriptTypeWebAppConfigAccess
-- | Response with the list of deployments for the specified Apps Script
-- project.
--
-- See: listDeploymentsResponse smart constructor.
data ListDeploymentsResponse
-- | Creates a value of ListDeploymentsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listDeploymentsResponse :: ListDeploymentsResponse
-- | The token that can be used in the next call to get the next page of
-- results.
ldrNextPageToken :: Lens' ListDeploymentsResponse (Maybe Text)
-- | The list of deployments.
ldrDeployments :: Lens' ListDeploymentsResponse [Deployment]
-- | Represents a function in a script project.
--
-- See: googleAppsScriptTypeFunction smart constructor.
data GoogleAppsScriptTypeFunction
-- | Creates a value of GoogleAppsScriptTypeFunction with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeFunction :: GoogleAppsScriptTypeFunction
-- | The function name in the script project.
gastfName :: Lens' GoogleAppsScriptTypeFunction (Maybe Text)
-- | An individual file within a script project. A file is a third-party
-- source code created by one or more developers. It can be a server-side
-- JS code, HTML, or a configuration file. Each script project can
-- contain multiple files.
--
-- See: file smart constructor.
data File
-- | Creates a value of File with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
file :: File
-- | The defined set of functions in the script file, if any.
fFunctionSet :: Lens' File (Maybe GoogleAppsScriptTypeFunctionSet)
-- | The user who modified the file most recently. This read-only field is
-- only visible to users who have WRITER permission for the script
-- project.
fLastModifyUser :: Lens' File (Maybe GoogleAppsScriptTypeUser)
-- | Last modified date timestamp. This read-only field is only visible to
-- users who have WRITER permission for the script project.
fUpdateTime :: Lens' File (Maybe UTCTime)
-- | The name of the file. The file extension is not part of the file name,
-- which can be identified from the type field.
fName :: Lens' File (Maybe Text)
-- | The file content.
fSource :: Lens' File (Maybe Text)
-- | The type of the file.
fType :: Lens' File (Maybe FileType)
-- | Creation date timestamp. This read-only field is only visible to users
-- who have WRITER permission for the script project.
fCreateTime :: Lens' File (Maybe UTCTime)
-- | An API executable entry point.
--
-- See: googleAppsScriptTypeExecutionAPIEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeExecutionAPIEntryPoint
-- | Creates a value of GoogleAppsScriptTypeExecutionAPIEntryPoint
-- with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeExecutionAPIEntryPoint :: GoogleAppsScriptTypeExecutionAPIEntryPoint
-- | The entry point's configuration.
gasteaepEntryPointConfig :: Lens' GoogleAppsScriptTypeExecutionAPIEntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIConfig)
-- | If the script function returns successfully, this field contains an
-- ExecutionResponse object with the function's return value.
--
-- See: operationResponse smart constructor.
data 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:
--
--
operationResponse :: HashMap Text JSONValue -> OperationResponse
-- | Properties of the object. Contains field 'type with type URL.
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
-- | An object that provides the return value of a function executed using
-- the Apps Script API. If the script function returns successfully, the
-- response body's response field contains this `ExecutionResponse`
-- object.
--
-- See: executionResponse smart constructor.
data 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:
--
--
executionResponse :: ExecutionResponse
-- | The return value of the script function. The type matches the object
-- type returned in Apps Script. Functions called using the Apps Script
-- API cannot return Apps Script-specific objects (such as a `Document`
-- or a `Calendar`); they can only return primitive types such as a
-- `string`, `number`, `array`, `object`, or `boolean`.
erResult :: Lens' ExecutionResponse (Maybe JSONValue)
-- | Representation of a single script deployment.
--
-- See: deployment smart constructor.
data Deployment
-- | Creates a value of Deployment with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deployment :: Deployment
-- | The deployment ID for this deployment.
dDeploymentId :: Lens' Deployment (Maybe Text)
-- | Last modified date time stamp.
dUpdateTime :: Lens' Deployment (Maybe UTCTime)
-- | The deployment's entry points.
dEntryPoints :: Lens' Deployment [EntryPoint]
-- | The deployment configuration.
dDeploymentConfig :: Lens' Deployment (Maybe DeploymentConfig)
-- | Request with deployment information to update an existing deployment.
--
-- See: updateDeploymentRequest smart constructor.
data UpdateDeploymentRequest
-- | Creates a value of UpdateDeploymentRequest with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateDeploymentRequest :: UpdateDeploymentRequest
-- | The deployment configuration.
udrDeploymentConfig :: Lens' UpdateDeploymentRequest (Maybe DeploymentConfig)
-- | Runs a function in an Apps Script project. The script project must be
-- deployed for use with the Apps Script API and the calling application
-- must share the same Cloud Platform project. This method requires
-- authorization with an OAuth 2.0 token that includes at least one of
-- the scopes listed in the Authorization section; script projects
-- that do not require authorization cannot be executed through this API.
-- To find the correct scopes to include in the authentication token,
-- open the project in the script editor, then select **File > Project
-- properties** and click the **Scopes** tab. The error `403,
-- PERMISSION_DENIED: The caller does not have permission` indicates that
-- the Cloud Platform project used to authorize the request is not the
-- same as the one used by the script.
--
-- See: Apps Script API Reference for
-- script.scripts.run.
module Network.Google.Resource.Script.Scripts.Run
-- | A resource alias for script.scripts.run method which the
-- ScriptsRun request conforms to.
type ScriptsRunResource = "v1" :> "scripts" :> CaptureMode "scriptId" "run" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] ExecutionRequest :> Post '[JSON] Operation
-- | Creates a value of ScriptsRun with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
scriptsRun :: ExecutionRequest -> Text -> ScriptsRun
-- | Runs a function in an Apps Script project. The script project must be
-- deployed for use with the Apps Script API and the calling application
-- must share the same Cloud Platform project. This method requires
-- authorization with an OAuth 2.0 token that includes at least one of
-- the scopes listed in the Authorization section; script projects
-- that do not require authorization cannot be executed through this API.
-- To find the correct scopes to include in the authentication token,
-- open the project in the script editor, then select **File > Project
-- properties** and click the **Scopes** tab. The error `403,
-- PERMISSION_DENIED: The caller does not have permission` indicates that
-- the Cloud Platform project used to authorize the request is not the
-- same as the one used by the script.
--
-- See: scriptsRun smart constructor.
data ScriptsRun
-- | V1 error format.
srXgafv :: Lens' ScriptsRun (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
srUploadProtocol :: Lens' ScriptsRun (Maybe Text)
-- | OAuth access token.
srAccessToken :: Lens' ScriptsRun (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
srUploadType :: Lens' ScriptsRun (Maybe Text)
-- | Multipart request metadata.
srPayload :: Lens' ScriptsRun ExecutionRequest
-- | The script ID of the script to be executed. To find the script ID,
-- open the project in the script editor and select **File > Project
-- properties**.
srScriptId :: Lens' ScriptsRun Text
-- | JSONP
srCallback :: Lens' ScriptsRun (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Scripts.Run.ScriptsRun
instance Data.Data.Data Network.Google.Resource.Script.Scripts.Run.ScriptsRun
instance GHC.Show.Show Network.Google.Resource.Script.Scripts.Run.ScriptsRun
instance GHC.Classes.Eq Network.Google.Resource.Script.Scripts.Run.ScriptsRun
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Scripts.Run.ScriptsRun
-- | List the versions of a script project.
--
-- See: Apps Script API Reference for
-- script.projects.versions.list.
module Network.Google.Resource.Script.Projects.Versions.List
-- | A resource alias for script.projects.versions.list method
-- which the ProjectsVersionsList request conforms to.
type ProjectsVersionsListResource = "v1" :> "projects" :> Capture "scriptId" Text :> "versions" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "pageToken" Text :> QueryParam "pageSize" (Textual Int32) :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] ListVersionsResponse
-- | Creates a value of ProjectsVersionsList with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsVersionsList :: Text -> ProjectsVersionsList
-- | List the versions of a script project.
--
-- See: projectsVersionsList smart constructor.
data ProjectsVersionsList
-- | V1 error format.
pvlXgafv :: Lens' ProjectsVersionsList (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pvlUploadProtocol :: Lens' ProjectsVersionsList (Maybe Text)
-- | OAuth access token.
pvlAccessToken :: Lens' ProjectsVersionsList (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pvlUploadType :: Lens' ProjectsVersionsList (Maybe Text)
-- | The script project's Drive ID.
pvlScriptId :: Lens' ProjectsVersionsList Text
-- | The token for continuing a previous list request on the next page.
-- This should be set to the value of `nextPageToken` from a previous
-- response.
pvlPageToken :: Lens' ProjectsVersionsList (Maybe Text)
-- | The maximum number of versions on each returned page. Defaults to 50.
pvlPageSize :: Lens' ProjectsVersionsList (Maybe Int32)
-- | JSONP
pvlCallback :: Lens' ProjectsVersionsList (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Versions.List.ProjectsVersionsList
instance Data.Data.Data Network.Google.Resource.Script.Projects.Versions.List.ProjectsVersionsList
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Versions.List.ProjectsVersionsList
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Versions.List.ProjectsVersionsList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Versions.List.ProjectsVersionsList
-- | Gets a version of a script project.
--
-- See: Apps Script API Reference for
-- script.projects.versions.get.
module Network.Google.Resource.Script.Projects.Versions.Get
-- | A resource alias for script.projects.versions.get method
-- which the ProjectsVersionsGet request conforms to.
type ProjectsVersionsGetResource = "v1" :> "projects" :> Capture "scriptId" Text :> "versions" :> Capture "versionNumber" (Textual Int32) :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Version
-- | Creates a value of ProjectsVersionsGet with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsVersionsGet :: Int32 -> Text -> ProjectsVersionsGet
-- | Gets a version of a script project.
--
-- See: projectsVersionsGet smart constructor.
data ProjectsVersionsGet
-- | V1 error format.
pvgXgafv :: Lens' ProjectsVersionsGet (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pvgUploadProtocol :: Lens' ProjectsVersionsGet (Maybe Text)
-- | OAuth access token.
pvgAccessToken :: Lens' ProjectsVersionsGet (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pvgUploadType :: Lens' ProjectsVersionsGet (Maybe Text)
-- | The version number.
pvgVersionNumber :: Lens' ProjectsVersionsGet Int32
-- | The script project's Drive ID.
pvgScriptId :: Lens' ProjectsVersionsGet Text
-- | JSONP
pvgCallback :: Lens' ProjectsVersionsGet (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Versions.Get.ProjectsVersionsGet
instance Data.Data.Data Network.Google.Resource.Script.Projects.Versions.Get.ProjectsVersionsGet
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Versions.Get.ProjectsVersionsGet
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Versions.Get.ProjectsVersionsGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Versions.Get.ProjectsVersionsGet
-- | Creates a new immutable version using the current code, with a unique
-- version number.
--
-- See: Apps Script API Reference for
-- script.projects.versions.create.
module Network.Google.Resource.Script.Projects.Versions.Create
-- | A resource alias for script.projects.versions.create method
-- which the ProjectsVersionsCreate request conforms to.
type ProjectsVersionsCreateResource = "v1" :> "projects" :> Capture "scriptId" Text :> "versions" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] Version :> Post '[JSON] Version
-- | Creates a value of ProjectsVersionsCreate with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsVersionsCreate :: Version -> Text -> ProjectsVersionsCreate
-- | Creates a new immutable version using the current code, with a unique
-- version number.
--
-- See: projectsVersionsCreate smart constructor.
data ProjectsVersionsCreate
-- | V1 error format.
pvcXgafv :: Lens' ProjectsVersionsCreate (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pvcUploadProtocol :: Lens' ProjectsVersionsCreate (Maybe Text)
-- | OAuth access token.
pvcAccessToken :: Lens' ProjectsVersionsCreate (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pvcUploadType :: Lens' ProjectsVersionsCreate (Maybe Text)
-- | Multipart request metadata.
pvcPayload :: Lens' ProjectsVersionsCreate Version
-- | The script project's Drive ID.
pvcScriptId :: Lens' ProjectsVersionsCreate Text
-- | JSONP
pvcCallback :: Lens' ProjectsVersionsCreate (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Versions.Create.ProjectsVersionsCreate
instance Data.Data.Data Network.Google.Resource.Script.Projects.Versions.Create.ProjectsVersionsCreate
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Versions.Create.ProjectsVersionsCreate
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Versions.Create.ProjectsVersionsCreate
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Versions.Create.ProjectsVersionsCreate
-- | Updates the content of the specified script project. This content is
-- stored as the HEAD version, and is used when the script is executed as
-- a trigger, in the script editor, in add-on preview mode, or as a web
-- app or Apps Script API in development mode. This clears all the
-- existing files in the project.
--
-- See: Apps Script API Reference for
-- script.projects.updateContent.
module Network.Google.Resource.Script.Projects.UpdateContent
-- | A resource alias for script.projects.updateContent method
-- which the ProjectsUpdateContent request conforms to.
type ProjectsUpdateContentResource = "v1" :> "projects" :> Capture "scriptId" Text :> "content" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] Content :> Put '[JSON] Content
-- | Creates a value of ProjectsUpdateContent with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsUpdateContent :: Content -> Text -> ProjectsUpdateContent
-- | Updates the content of the specified script project. This content is
-- stored as the HEAD version, and is used when the script is executed as
-- a trigger, in the script editor, in add-on preview mode, or as a web
-- app or Apps Script API in development mode. This clears all the
-- existing files in the project.
--
-- See: projectsUpdateContent smart constructor.
data ProjectsUpdateContent
-- | V1 error format.
pucXgafv :: Lens' ProjectsUpdateContent (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pucUploadProtocol :: Lens' ProjectsUpdateContent (Maybe Text)
-- | OAuth access token.
pucAccessToken :: Lens' ProjectsUpdateContent (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pucUploadType :: Lens' ProjectsUpdateContent (Maybe Text)
-- | Multipart request metadata.
pucPayload :: Lens' ProjectsUpdateContent Content
-- | The script project's Drive ID.
pucScriptId :: Lens' ProjectsUpdateContent Text
-- | JSONP
pucCallback :: Lens' ProjectsUpdateContent (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.UpdateContent.ProjectsUpdateContent
instance Data.Data.Data Network.Google.Resource.Script.Projects.UpdateContent.ProjectsUpdateContent
instance GHC.Show.Show Network.Google.Resource.Script.Projects.UpdateContent.ProjectsUpdateContent
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.UpdateContent.ProjectsUpdateContent
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.UpdateContent.ProjectsUpdateContent
-- | Get metrics data for scripts, such as number of executions and active
-- users.
--
-- See: Apps Script API Reference for
-- script.projects.getMetrics.
module Network.Google.Resource.Script.Projects.GetMetrics
-- | A resource alias for script.projects.getMetrics method which
-- the ProjectsGetMetrics request conforms to.
type ProjectsGetMetricsResource = "v1" :> "projects" :> Capture "scriptId" Text :> "metrics" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "metricsGranularity" Text :> QueryParam "metricsFilter.deploymentId" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Metrics
-- | Creates a value of ProjectsGetMetrics with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsGetMetrics :: Text -> ProjectsGetMetrics
-- | Get metrics data for scripts, such as number of executions and active
-- users.
--
-- See: projectsGetMetrics smart constructor.
data ProjectsGetMetrics
-- | V1 error format.
pgmXgafv :: Lens' ProjectsGetMetrics (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pgmUploadProtocol :: Lens' ProjectsGetMetrics (Maybe Text)
-- | OAuth access token.
pgmAccessToken :: Lens' ProjectsGetMetrics (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pgmUploadType :: Lens' ProjectsGetMetrics (Maybe Text)
-- | Required field indicating what granularity of metrics are returned.
pgmMetricsGranularity :: Lens' ProjectsGetMetrics (Maybe Text)
-- | Required field indicating the script to get metrics for.
pgmScriptId :: Lens' ProjectsGetMetrics Text
-- | Optional field indicating a specific deployment to retrieve metrics
-- from.
pgmMetricsFilterDeploymentId :: Lens' ProjectsGetMetrics (Maybe Text)
-- | JSONP
pgmCallback :: Lens' ProjectsGetMetrics (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.GetMetrics.ProjectsGetMetrics
instance Data.Data.Data Network.Google.Resource.Script.Projects.GetMetrics.ProjectsGetMetrics
instance GHC.Show.Show Network.Google.Resource.Script.Projects.GetMetrics.ProjectsGetMetrics
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.GetMetrics.ProjectsGetMetrics
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.GetMetrics.ProjectsGetMetrics
-- | Gets the content of the script project, including the code source and
-- metadata for each script file.
--
-- See: Apps Script API Reference for
-- script.projects.getContent.
module Network.Google.Resource.Script.Projects.GetContent
-- | A resource alias for script.projects.getContent method which
-- the ProjectsGetContent request conforms to.
type ProjectsGetContentResource = "v1" :> "projects" :> Capture "scriptId" Text :> "content" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "versionNumber" (Textual Int32) :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Content
-- | Creates a value of ProjectsGetContent with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsGetContent :: Text -> ProjectsGetContent
-- | Gets the content of the script project, including the code source and
-- metadata for each script file.
--
-- See: projectsGetContent smart constructor.
data ProjectsGetContent
-- | V1 error format.
pgcXgafv :: Lens' ProjectsGetContent (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pgcUploadProtocol :: Lens' ProjectsGetContent (Maybe Text)
-- | OAuth access token.
pgcAccessToken :: Lens' ProjectsGetContent (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pgcUploadType :: Lens' ProjectsGetContent (Maybe Text)
-- | The version number of the project to retrieve. If not provided, the
-- project's HEAD version is returned.
pgcVersionNumber :: Lens' ProjectsGetContent (Maybe Int32)
-- | The script project's Drive ID.
pgcScriptId :: Lens' ProjectsGetContent Text
-- | JSONP
pgcCallback :: Lens' ProjectsGetContent (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.GetContent.ProjectsGetContent
instance Data.Data.Data Network.Google.Resource.Script.Projects.GetContent.ProjectsGetContent
instance GHC.Show.Show Network.Google.Resource.Script.Projects.GetContent.ProjectsGetContent
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.GetContent.ProjectsGetContent
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.GetContent.ProjectsGetContent
-- | Gets a script project's metadata.
--
-- See: Apps Script API Reference for
-- script.projects.get.
module Network.Google.Resource.Script.Projects.Get
-- | A resource alias for script.projects.get method which the
-- ProjectsGet request conforms to.
type ProjectsGetResource = "v1" :> "projects" :> Capture "scriptId" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Project
-- | Creates a value of ProjectsGet with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsGet :: Text -> ProjectsGet
-- | Gets a script project's metadata.
--
-- See: projectsGet smart constructor.
data ProjectsGet
-- | V1 error format.
pgXgafv :: Lens' ProjectsGet (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pgUploadProtocol :: Lens' ProjectsGet (Maybe Text)
-- | OAuth access token.
pgAccessToken :: Lens' ProjectsGet (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pgUploadType :: Lens' ProjectsGet (Maybe Text)
-- | The script project's Drive ID.
pgScriptId :: Lens' ProjectsGet Text
-- | JSONP
pgCallback :: Lens' ProjectsGet (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Get.ProjectsGet
instance Data.Data.Data Network.Google.Resource.Script.Projects.Get.ProjectsGet
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Get.ProjectsGet
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Get.ProjectsGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Get.ProjectsGet
-- | Updates a deployment of an Apps Script project.
--
-- See: Apps Script API Reference for
-- script.projects.deployments.update.
module Network.Google.Resource.Script.Projects.Deployments.Update
-- | A resource alias for script.projects.deployments.update
-- method which the ProjectsDeploymentsUpdate request conforms to.
type ProjectsDeploymentsUpdateResource = "v1" :> "projects" :> Capture "scriptId" Text :> "deployments" :> Capture "deploymentId" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] UpdateDeploymentRequest :> Put '[JSON] Deployment
-- | Creates a value of ProjectsDeploymentsUpdate with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsDeploymentsUpdate :: Text -> UpdateDeploymentRequest -> Text -> ProjectsDeploymentsUpdate
-- | Updates a deployment of an Apps Script project.
--
-- See: projectsDeploymentsUpdate smart constructor.
data ProjectsDeploymentsUpdate
-- | The deployment ID for this deployment.
pduDeploymentId :: Lens' ProjectsDeploymentsUpdate Text
-- | V1 error format.
pduXgafv :: Lens' ProjectsDeploymentsUpdate (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pduUploadProtocol :: Lens' ProjectsDeploymentsUpdate (Maybe Text)
-- | OAuth access token.
pduAccessToken :: Lens' ProjectsDeploymentsUpdate (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pduUploadType :: Lens' ProjectsDeploymentsUpdate (Maybe Text)
-- | Multipart request metadata.
pduPayload :: Lens' ProjectsDeploymentsUpdate UpdateDeploymentRequest
-- | The script project's Drive ID.
pduScriptId :: Lens' ProjectsDeploymentsUpdate Text
-- | JSONP
pduCallback :: Lens' ProjectsDeploymentsUpdate (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Deployments.Update.ProjectsDeploymentsUpdate
instance Data.Data.Data Network.Google.Resource.Script.Projects.Deployments.Update.ProjectsDeploymentsUpdate
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Deployments.Update.ProjectsDeploymentsUpdate
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Deployments.Update.ProjectsDeploymentsUpdate
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Deployments.Update.ProjectsDeploymentsUpdate
-- | Lists the deployments of an Apps Script project.
--
-- See: Apps Script API Reference for
-- script.projects.deployments.list.
module Network.Google.Resource.Script.Projects.Deployments.List
-- | A resource alias for script.projects.deployments.list method
-- which the ProjectsDeploymentsList request conforms to.
type ProjectsDeploymentsListResource = "v1" :> "projects" :> Capture "scriptId" Text :> "deployments" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "pageToken" Text :> QueryParam "pageSize" (Textual Int32) :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] ListDeploymentsResponse
-- | Creates a value of ProjectsDeploymentsList with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsDeploymentsList :: Text -> ProjectsDeploymentsList
-- | Lists the deployments of an Apps Script project.
--
-- See: projectsDeploymentsList smart constructor.
data ProjectsDeploymentsList
-- | V1 error format.
pdlXgafv :: Lens' ProjectsDeploymentsList (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pdlUploadProtocol :: Lens' ProjectsDeploymentsList (Maybe Text)
-- | OAuth access token.
pdlAccessToken :: Lens' ProjectsDeploymentsList (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pdlUploadType :: Lens' ProjectsDeploymentsList (Maybe Text)
-- | The script project's Drive ID.
pdlScriptId :: Lens' ProjectsDeploymentsList Text
-- | The token for continuing a previous list request on the next page.
-- This should be set to the value of `nextPageToken` from a previous
-- response.
pdlPageToken :: Lens' ProjectsDeploymentsList (Maybe Text)
-- | The maximum number of deployments on each returned page. Defaults to
-- 50.
pdlPageSize :: Lens' ProjectsDeploymentsList (Maybe Int32)
-- | JSONP
pdlCallback :: Lens' ProjectsDeploymentsList (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Deployments.List.ProjectsDeploymentsList
instance Data.Data.Data Network.Google.Resource.Script.Projects.Deployments.List.ProjectsDeploymentsList
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Deployments.List.ProjectsDeploymentsList
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Deployments.List.ProjectsDeploymentsList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Deployments.List.ProjectsDeploymentsList
-- | Gets a deployment of an Apps Script project.
--
-- See: Apps Script API Reference for
-- script.projects.deployments.get.
module Network.Google.Resource.Script.Projects.Deployments.Get
-- | A resource alias for script.projects.deployments.get method
-- which the ProjectsDeploymentsGet request conforms to.
type ProjectsDeploymentsGetResource = "v1" :> "projects" :> Capture "scriptId" Text :> "deployments" :> Capture "deploymentId" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Deployment
-- | Creates a value of ProjectsDeploymentsGet with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsDeploymentsGet :: Text -> Text -> ProjectsDeploymentsGet
-- | Gets a deployment of an Apps Script project.
--
-- See: projectsDeploymentsGet smart constructor.
data ProjectsDeploymentsGet
-- | The deployment ID.
pdgDeploymentId :: Lens' ProjectsDeploymentsGet Text
-- | V1 error format.
pdgXgafv :: Lens' ProjectsDeploymentsGet (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pdgUploadProtocol :: Lens' ProjectsDeploymentsGet (Maybe Text)
-- | OAuth access token.
pdgAccessToken :: Lens' ProjectsDeploymentsGet (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pdgUploadType :: Lens' ProjectsDeploymentsGet (Maybe Text)
-- | The script project's Drive ID.
pdgScriptId :: Lens' ProjectsDeploymentsGet Text
-- | JSONP
pdgCallback :: Lens' ProjectsDeploymentsGet (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Deployments.Get.ProjectsDeploymentsGet
instance Data.Data.Data Network.Google.Resource.Script.Projects.Deployments.Get.ProjectsDeploymentsGet
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Deployments.Get.ProjectsDeploymentsGet
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Deployments.Get.ProjectsDeploymentsGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Deployments.Get.ProjectsDeploymentsGet
-- | Deletes a deployment of an Apps Script project.
--
-- See: Apps Script API Reference for
-- script.projects.deployments.delete.
module Network.Google.Resource.Script.Projects.Deployments.Delete
-- | A resource alias for script.projects.deployments.delete
-- method which the ProjectsDeploymentsDelete request conforms to.
type ProjectsDeploymentsDeleteResource = "v1" :> "projects" :> Capture "scriptId" Text :> "deployments" :> Capture "deploymentId" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Delete '[JSON] Empty
-- | Creates a value of ProjectsDeploymentsDelete with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsDeploymentsDelete :: Text -> Text -> ProjectsDeploymentsDelete
-- | Deletes a deployment of an Apps Script project.
--
-- See: projectsDeploymentsDelete smart constructor.
data ProjectsDeploymentsDelete
-- | The deployment ID to be undeployed.
pddDeploymentId :: Lens' ProjectsDeploymentsDelete Text
-- | V1 error format.
pddXgafv :: Lens' ProjectsDeploymentsDelete (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pddUploadProtocol :: Lens' ProjectsDeploymentsDelete (Maybe Text)
-- | OAuth access token.
pddAccessToken :: Lens' ProjectsDeploymentsDelete (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pddUploadType :: Lens' ProjectsDeploymentsDelete (Maybe Text)
-- | The script project's Drive ID.
pddScriptId :: Lens' ProjectsDeploymentsDelete Text
-- | JSONP
pddCallback :: Lens' ProjectsDeploymentsDelete (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Deployments.Delete.ProjectsDeploymentsDelete
instance Data.Data.Data Network.Google.Resource.Script.Projects.Deployments.Delete.ProjectsDeploymentsDelete
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Deployments.Delete.ProjectsDeploymentsDelete
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Deployments.Delete.ProjectsDeploymentsDelete
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Deployments.Delete.ProjectsDeploymentsDelete
-- | Creates a deployment of an Apps Script project.
--
-- See: Apps Script API Reference for
-- script.projects.deployments.create.
module Network.Google.Resource.Script.Projects.Deployments.Create
-- | A resource alias for script.projects.deployments.create
-- method which the ProjectsDeploymentsCreate request conforms to.
type ProjectsDeploymentsCreateResource = "v1" :> "projects" :> Capture "scriptId" Text :> "deployments" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] DeploymentConfig :> Post '[JSON] Deployment
-- | Creates a value of ProjectsDeploymentsCreate with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsDeploymentsCreate :: DeploymentConfig -> Text -> ProjectsDeploymentsCreate
-- | Creates a deployment of an Apps Script project.
--
-- See: projectsDeploymentsCreate smart constructor.
data ProjectsDeploymentsCreate
-- | V1 error format.
pdcXgafv :: Lens' ProjectsDeploymentsCreate (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pdcUploadProtocol :: Lens' ProjectsDeploymentsCreate (Maybe Text)
-- | OAuth access token.
pdcAccessToken :: Lens' ProjectsDeploymentsCreate (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pdcUploadType :: Lens' ProjectsDeploymentsCreate (Maybe Text)
-- | Multipart request metadata.
pdcPayload :: Lens' ProjectsDeploymentsCreate DeploymentConfig
-- | The script project's Drive ID.
pdcScriptId :: Lens' ProjectsDeploymentsCreate Text
-- | JSONP
pdcCallback :: Lens' ProjectsDeploymentsCreate (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Deployments.Create.ProjectsDeploymentsCreate
instance Data.Data.Data Network.Google.Resource.Script.Projects.Deployments.Create.ProjectsDeploymentsCreate
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Deployments.Create.ProjectsDeploymentsCreate
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Deployments.Create.ProjectsDeploymentsCreate
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Deployments.Create.ProjectsDeploymentsCreate
-- | Creates a new, empty script project with no script files and a base
-- manifest file.
--
-- See: Apps Script API Reference for
-- script.projects.create.
module Network.Google.Resource.Script.Projects.Create
-- | A resource alias for script.projects.create method which the
-- ProjectsCreate request conforms to.
type ProjectsCreateResource = "v1" :> "projects" :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] CreateProjectRequest :> Post '[JSON] Project
-- | Creates a value of ProjectsCreate with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
projectsCreate :: CreateProjectRequest -> ProjectsCreate
-- | Creates a new, empty script project with no script files and a base
-- manifest file.
--
-- See: projectsCreate smart constructor.
data ProjectsCreate
-- | V1 error format.
pcXgafv :: Lens' ProjectsCreate (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
pcUploadProtocol :: Lens' ProjectsCreate (Maybe Text)
-- | OAuth access token.
pcAccessToken :: Lens' ProjectsCreate (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
pcUploadType :: Lens' ProjectsCreate (Maybe Text)
-- | Multipart request metadata.
pcPayload :: Lens' ProjectsCreate CreateProjectRequest
-- | JSONP
pcCallback :: Lens' ProjectsCreate (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Projects.Create.ProjectsCreate
instance Data.Data.Data Network.Google.Resource.Script.Projects.Create.ProjectsCreate
instance GHC.Show.Show Network.Google.Resource.Script.Projects.Create.ProjectsCreate
instance GHC.Classes.Eq Network.Google.Resource.Script.Projects.Create.ProjectsCreate
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Projects.Create.ProjectsCreate
-- | List information about a script's executed processes, such as process
-- type and current status.
--
-- See: Apps Script API Reference for
-- script.processes.listScriptProcesses.
module Network.Google.Resource.Script.Processes.ListScriptProcesses
-- | A resource alias for script.processes.listScriptProcesses
-- method which the ProcessesListScriptProcesses request conforms
-- to.
type ProcessesListScriptProcessesResource = "v1" :> "processes:listScriptProcesses" :> QueryParam "$.xgafv" Xgafv :> QueryParam "scriptProcessFilter.functionName" Text :> QueryParam "upload_protocol" Text :> QueryParams "scriptProcessFilter.userAccessLevels" Text :> QueryParams "scriptProcessFilter.statuses" Text :> QueryParam "scriptProcessFilter.endTime" DateTime' :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "scriptProcessFilter.deploymentId" Text :> QueryParam "scriptProcessFilter.startTime" DateTime' :> QueryParam "scriptId" Text :> QueryParam "pageToken" Text :> QueryParam "pageSize" (Textual Int32) :> QueryParams "scriptProcessFilter.types" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] ListScriptProcessesResponse
-- | Creates a value of ProcessesListScriptProcesses with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
processesListScriptProcesses :: ProcessesListScriptProcesses
-- | List information about a script's executed processes, such as process
-- type and current status.
--
-- See: processesListScriptProcesses smart constructor.
data ProcessesListScriptProcesses
-- | V1 error format.
plspXgafv :: Lens' ProcessesListScriptProcesses (Maybe Xgafv)
-- | Optional field used to limit returned processes to those originating
-- from a script function with the given function name.
plspScriptProcessFilterFunctionName :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | Upload protocol for media (e.g. "raw", "multipart").
plspUploadProtocol :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | Optional field used to limit returned processes to those having one of
-- the specified user access levels.
plspScriptProcessFilterUserAccessLevels :: Lens' ProcessesListScriptProcesses [Text]
-- | Optional field used to limit returned processes to those having one of
-- the specified process statuses.
plspScriptProcessFilterStatuses :: Lens' ProcessesListScriptProcesses [Text]
-- | Optional field used to limit returned processes to those that
-- completed on or before the given timestamp.
plspScriptProcessFilterEndTime :: Lens' ProcessesListScriptProcesses (Maybe UTCTime)
-- | OAuth access token.
plspAccessToken :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
plspUploadType :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | Optional field used to limit returned processes to those originating
-- from projects with a specific deployment ID.
plspScriptProcessFilterDeploymentId :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | Optional field used to limit returned processes to those that were
-- started on or after the given timestamp.
plspScriptProcessFilterStartTime :: Lens' ProcessesListScriptProcesses (Maybe UTCTime)
-- | The script ID of the project whose processes are listed.
plspScriptId :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | The token for continuing a previous list request on the next page.
-- This should be set to the value of `nextPageToken` from a previous
-- response.
plspPageToken :: Lens' ProcessesListScriptProcesses (Maybe Text)
-- | The maximum number of returned processes per page of results. Defaults
-- to 50.
plspPageSize :: Lens' ProcessesListScriptProcesses (Maybe Int32)
-- | Optional field used to limit returned processes to those having one of
-- the specified process types.
plspScriptProcessFilterTypes :: Lens' ProcessesListScriptProcesses [Text]
-- | JSONP
plspCallback :: Lens' ProcessesListScriptProcesses (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Processes.ListScriptProcesses.ProcessesListScriptProcesses
instance Data.Data.Data Network.Google.Resource.Script.Processes.ListScriptProcesses.ProcessesListScriptProcesses
instance GHC.Show.Show Network.Google.Resource.Script.Processes.ListScriptProcesses.ProcessesListScriptProcesses
instance GHC.Classes.Eq Network.Google.Resource.Script.Processes.ListScriptProcesses.ProcessesListScriptProcesses
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Processes.ListScriptProcesses.ProcessesListScriptProcesses
-- | List information about processes made by or on behalf of a user, such
-- as process type and current status.
--
-- See: Apps Script API Reference for
-- script.processes.list.
module Network.Google.Resource.Script.Processes.List
-- | A resource alias for script.processes.list method which the
-- ProcessesList request conforms to.
type ProcessesListResource = "v1" :> "processes" :> QueryParams "userProcessFilter.userAccessLevels" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "userProcessFilter.functionName" Text :> QueryParams "userProcessFilter.types" Text :> QueryParam "userProcessFilter.deploymentId" Text :> QueryParam "pageToken" Text :> QueryParam "pageSize" (Textual Int32) :> QueryParam "userProcessFilter.projectName" Text :> QueryParams "userProcessFilter.statuses" Text :> QueryParam "userProcessFilter.scriptId" Text :> QueryParam "userProcessFilter.endTime" DateTime' :> QueryParam "userProcessFilter.startTime" DateTime' :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] ListUserProcessesResponse
-- | Creates a value of ProcessesList with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
processesList :: ProcessesList
-- | List information about processes made by or on behalf of a user, such
-- as process type and current status.
--
-- See: processesList smart constructor.
data ProcessesList
-- | Optional field used to limit returned processes to those having one of
-- the specified user access levels.
plUserProcessFilterUserAccessLevels :: Lens' ProcessesList [Text]
-- | V1 error format.
plXgafv :: Lens' ProcessesList (Maybe Xgafv)
-- | Upload protocol for media (e.g. "raw", "multipart").
plUploadProtocol :: Lens' ProcessesList (Maybe Text)
-- | OAuth access token.
plAccessToken :: Lens' ProcessesList (Maybe Text)
-- | Legacy upload protocol for media (e.g. "media", "multipart").
plUploadType :: Lens' ProcessesList (Maybe Text)
-- | Optional field used to limit returned processes to those originating
-- from a script function with the given function name.
plUserProcessFilterFunctionName :: Lens' ProcessesList (Maybe Text)
-- | Optional field used to limit returned processes to those having one of
-- the specified process types.
plUserProcessFilterTypes :: Lens' ProcessesList [Text]
-- | Optional field used to limit returned processes to those originating
-- from projects with a specific deployment ID.
plUserProcessFilterDeploymentId :: Lens' ProcessesList (Maybe Text)
-- | The token for continuing a previous list request on the next page.
-- This should be set to the value of `nextPageToken` from a previous
-- response.
plPageToken :: Lens' ProcessesList (Maybe Text)
-- | The maximum number of returned processes per page of results. Defaults
-- to 50.
plPageSize :: Lens' ProcessesList (Maybe Int32)
-- | Optional field used to limit returned processes to those originating
-- from projects with project names containing a specific string.
plUserProcessFilterProjectName :: Lens' ProcessesList (Maybe Text)
-- | Optional field used to limit returned processes to those having one of
-- the specified process statuses.
plUserProcessFilterStatuses :: Lens' ProcessesList [Text]
-- | Optional field used to limit returned processes to those originating
-- from projects with a specific script ID.
plUserProcessFilterScriptId :: Lens' ProcessesList (Maybe Text)
-- | Optional field used to limit returned processes to those that
-- completed on or before the given timestamp.
plUserProcessFilterEndTime :: Lens' ProcessesList (Maybe UTCTime)
-- | Optional field used to limit returned processes to those that were
-- started on or after the given timestamp.
plUserProcessFilterStartTime :: Lens' ProcessesList (Maybe UTCTime)
-- | JSONP
plCallback :: Lens' ProcessesList (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Script.Processes.List.ProcessesList
instance Data.Data.Data Network.Google.Resource.Script.Processes.List.ProcessesList
instance GHC.Show.Show Network.Google.Resource.Script.Processes.List.ProcessesList
instance GHC.Classes.Eq Network.Google.Resource.Script.Processes.List.ProcessesList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Script.Processes.List.ProcessesList
-- | Manages and executes Google Apps Script projects.
--
-- See: Apps Script API Reference
module Network.Google.Script
-- | Default request referring to version v1 of the Apps Script
-- API. This contains the host and root path used as a starting point for
-- constructing service requests.
scriptService :: ServiceConfig
-- | Read, compose, send, and permanently delete all your email from Gmail
mailGoogleComScope :: Proxy '["https://mail.google.com/"]
-- | See, edit, download, and permanently delete your contacts
m8FeedsScope :: Proxy '["https://www.google.com/m8/feeds"]
-- | View and manage the provisioning of users on your domain
adminDirectoryUserScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.user"]
-- | Create and update Google Apps Script projects
scriptProjectsScope :: Proxy '["https://www.googleapis.com/auth/script.projects"]
-- | View your email address
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
-- | View Google Apps Script project's metrics
scriptMetricsScope :: Proxy '["https://www.googleapis.com/auth/script.metrics"]
-- | View and manage forms that this application has been installed in
formsCurrentOnlyScope :: Proxy '["https://www.googleapis.com/auth/forms.currentonly"]
-- | Create and update Google Apps Script deployments
scriptDeploymentsScope :: Proxy '["https://www.googleapis.com/auth/script.deployments"]
-- | See, edit, create, and delete all of your Google Drive files
driveScope :: Proxy '["https://www.googleapis.com/auth/drive"]
-- | View and manage the provisioning of groups on your domain
adminDirectoryGroupScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.group"]
-- | View Google Apps Script projects
scriptProjectsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.projects.readonly"]
-- | See, edit, share, and permanently delete all the calendars you can
-- access using Google Calendar
calendarFeedsScope :: Proxy '["https://www.google.com/calendar/feeds"]
-- | View and manage your forms in Google Drive
formsScope :: Proxy '["https://www.googleapis.com/auth/forms"]
-- | See, edit, create, and delete your spreadsheets in Google Drive
spreadsheetsScope :: Proxy '["https://www.googleapis.com/auth/spreadsheets"]
-- | View Google Apps Script deployments
scriptDeploymentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.deployments.readonly"]
-- | View and manage your Google Groups
groupsScope :: Proxy '["https://www.googleapis.com/auth/groups"]
-- | View Google Apps Script processes
scriptProcessesScope :: Proxy '["https://www.googleapis.com/auth/script.processes"]
-- | View and manage your Google Docs documents
documentsScope :: Proxy '["https://www.googleapis.com/auth/documents"]
-- | Represents the entirety of the methods and resources available for the
-- Apps Script API service.
type ScriptAPI = ScriptsRunResource :<|> ProcessesListResource :<|> ProcessesListScriptProcessesResource :<|> ProjectsVersionsListResource :<|> ProjectsVersionsGetResource :<|> ProjectsVersionsCreateResource :<|> ProjectsDeploymentsListResource :<|> ProjectsDeploymentsGetResource :<|> ProjectsDeploymentsCreateResource :<|> ProjectsDeploymentsDeleteResource :<|> ProjectsDeploymentsUpdateResource :<|> ProjectsUpdateContentResource :<|> ProjectsGetResource :<|> ProjectsCreateResource :<|> ProjectsGetContentResource :<|> ProjectsGetMetricsResource
-- | A set of functions. No duplicates are permitted.
--
-- See: googleAppsScriptTypeFunctionSet smart constructor.
data GoogleAppsScriptTypeFunctionSet
-- | Creates a value of GoogleAppsScriptTypeFunctionSet with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeFunctionSet :: GoogleAppsScriptTypeFunctionSet
-- | A list of functions composing the set.
gastfsValues :: Lens' GoogleAppsScriptTypeFunctionSet [GoogleAppsScriptTypeFunction]
-- | API executable entry point configuration.
--
-- See: googleAppsScriptTypeExecutionAPIConfig smart
-- constructor.
data GoogleAppsScriptTypeExecutionAPIConfig
-- | Creates a value of GoogleAppsScriptTypeExecutionAPIConfig with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeExecutionAPIConfig :: GoogleAppsScriptTypeExecutionAPIConfig
-- | Who has permission to run the API executable.
gasteacAccess :: Lens' GoogleAppsScriptTypeExecutionAPIConfig (Maybe GoogleAppsScriptTypeExecutionAPIConfigAccess)
-- | The executions type.
data GoogleAppsScriptTypeProcessProcessType
-- | PROCESS_TYPE_UNSPECIFIED Unspecified type.
ProcessTypeUnspecified :: GoogleAppsScriptTypeProcessProcessType
-- | ADD_ON The process was started from an add-on entry point.
AddOn :: GoogleAppsScriptTypeProcessProcessType
-- | EXECUTION_API The process was started using the Apps Script
-- API.
ExecutionAPI :: GoogleAppsScriptTypeProcessProcessType
-- | TIME_DRIVEN The process was started from a time-based
-- trigger.
TimeDriven :: GoogleAppsScriptTypeProcessProcessType
-- | TRIGGER The process was started from an event-based trigger.
Trigger :: GoogleAppsScriptTypeProcessProcessType
-- | WEBAPP The process was started from a web app entry point.
WebApp :: GoogleAppsScriptTypeProcessProcessType
-- | EDITOR The process was started using the Apps Script IDE.
Editor :: GoogleAppsScriptTypeProcessProcessType
-- | SIMPLE_TRIGGER The process was started from a G Suite simple
-- trigger.
SimpleTrigger :: GoogleAppsScriptTypeProcessProcessType
-- | MENU The process was started from a G Suite menu item.
Menu :: GoogleAppsScriptTypeProcessProcessType
-- | BATCH_TASK The process was started as a task in a batch job.
BatchTask :: GoogleAppsScriptTypeProcessProcessType
-- | If a `run` call succeeds but the script function (or Apps Script
-- itself) throws an exception, the response body's error field contains
-- this `Status` object.
--
-- See: status smart constructor.
data 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:
--
--
status :: Status
-- | An array that contains a single ExecutionError object that provides
-- information about the nature of the error.
sDetails :: Lens' Status [StatusDetailsItem]
-- | The status code. For this API, this value either:
--
--
-- - 10, indicating a `SCRIPT_TIMEOUT` error,
-- - 3, indicating an `INVALID_ARGUMENT` error, or
-- - 1, indicating a `CANCELLED` execution.
--
sCode :: Lens' Status (Maybe Int32)
-- | A developer-facing error message, which is in English. Any user-facing
-- error message is localized and sent in the details field, or localized
-- by the client.
sMessage :: Lens' Status (Maybe Text)
-- | The executing users access level to the script.
data GoogleAppsScriptTypeProcessUserAccessLevel
-- | USER_ACCESS_LEVEL_UNSPECIFIED User access level unspecified
UserAccessLevelUnspecified :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | NONE The user has no access.
None :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | READ The user has read-only access.
Read' :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | WRITE The user has write access.
Write :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | OWNER The user is an owner.
Owner :: GoogleAppsScriptTypeProcessUserAccessLevel
-- | Resource containing usage stats for a given script, based on the
-- supplied filter and mask present in the request.
--
-- See: metrics smart constructor.
data Metrics
-- | Creates a value of Metrics with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
metrics :: Metrics
-- | Number of active users.
mActiveUsers :: Lens' Metrics [MetricsValue]
-- | Number of failed executions.
mFailedExecutions :: Lens' Metrics [MetricsValue]
-- | Number of total executions.
mTotalExecutions :: Lens' Metrics [MetricsValue]
-- | Representation of a single script process execution that was started
-- from the script editor, a trigger, an application, or using the Apps
-- Script API. This is distinct from the `Operation` resource, which only
-- represents executions started via the Apps Script API.
--
-- See: googleAppsScriptTypeProcess smart constructor.
data GoogleAppsScriptTypeProcess
-- | Creates a value of GoogleAppsScriptTypeProcess with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeProcess :: GoogleAppsScriptTypeProcess
-- | The executions status.
gastpProcessStatus :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessStatus)
-- | Time the execution started.
gastpStartTime :: Lens' GoogleAppsScriptTypeProcess (Maybe UTCTime)
-- | Name of the script being executed.
gastpProjectName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
-- | Name of the function the started the execution.
gastpFunctionName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
-- | The executing users access level to the script.
gastpUserAccessLevel :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessUserAccessLevel)
-- | The executions type.
gastpProcessType :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessType)
-- | Duration the execution spent executing.
gastpDuration :: Lens' GoogleAppsScriptTypeProcess (Maybe Scientific)
-- | Who to execute the web app as.
data GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | UNKNOWN_EXECUTE_AS Default value, should not be used.
UnknownExecuteAs :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | USER_ACCESSING The script runs as the user accessing the web
-- app.
UserAccessing :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | USER_DEPLOYING The script runs as the user who deployed the
-- web app. Note that this is not necessarily the owner of the script
-- project.
UserDeploying :: GoogleAppsScriptTypeWebAppConfigExecuteAs
-- | The script project resource.
--
-- See: project smart constructor.
data Project
-- | Creates a value of Project with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
project :: Project
-- | User who originally created the script.
pCreator :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
-- | User who last modified the script.
pLastModifyUser :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
-- | When the script was last updated.
pUpdateTime :: Lens' Project (Maybe UTCTime)
-- | The script project's Drive ID.
pScriptId :: Lens' Project (Maybe Text)
-- | The title for the project.
pTitle :: Lens' Project (Maybe Text)
-- | The parent's Drive ID that the script will be attached to. This is
-- usually the ID of a Google Document or Google Sheet. This filed is
-- optional, and if not set, a stand-alone script will be created.
pParentId :: Lens' Project (Maybe Text)
-- | When the script was created.
pCreateTime :: Lens' Project (Maybe UTCTime)
-- | A representation of an execution of an Apps Script function started
-- with run. The execution response does not arrive until the function
-- finishes executing. The maximum execution runtime is listed in the
-- Apps Script quotas guide.
--
-- After execution has started, it can have one of four outcomes:
--
--
-- - If the script function returns successfully, the response field
-- contains 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 contains a Status object. The `Status`
-- object's `details` field contains an array with a single
-- ExecutionError object that provides information about the nature of
-- the error.
-- - If the execution has not yet completed, the done field is `false`
-- and the neither the `response` nor `error` fields are present.
-- - If the `run` call itself fails (for example, because of a
-- malformed request or an authorization error), the method returns an
-- HTTP response code in the 4XX range with a different format for the
-- response body. Client libraries automatically convert a 4XX response
-- into an exception class.
--
--
-- See: operation smart constructor.
data 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:
--
--
operation :: Operation
-- | This field indicates whether the script execution has completed. A
-- completed execution has a populated `response` field containing the
-- ExecutionResponse from function that was executed.
oDone :: Lens' Operation (Maybe Bool)
-- | If a `run` call succeeds but the script function (or Apps Script
-- itself) throws an exception, this field contains a Status object. The
-- `Status` object's `details` field contains an array with a single
-- ExecutionError object that provides information about the nature of
-- the error.
oError :: Lens' Operation (Maybe Status)
-- | If the script function returns successfully, this field contains an
-- ExecutionResponse object with the function's return value.
oResponse :: Lens' Operation (Maybe OperationResponse)
-- | Response with the list of Process resources.
--
-- See: listUserProcessesResponse smart constructor.
data ListUserProcessesResponse
-- | Creates a value of ListUserProcessesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listUserProcessesResponse :: ListUserProcessesResponse
-- | Token for the next page of results. If empty, there are no more pages
-- remaining.
luprNextPageToken :: Lens' ListUserProcessesResponse (Maybe Text)
-- | List of processes matching request parameters.
luprProcesses :: Lens' ListUserProcessesResponse [GoogleAppsScriptTypeProcess]
-- | A generic empty message that you can re-use to avoid defining
-- duplicated empty messages in your APIs. A typical example is to use it
-- as the request or the response type of an API method. For instance:
-- service Foo { rpc Bar(google.protobuf.Empty) returns
-- (google.protobuf.Empty); } The JSON representation for `Empty` is
-- empty JSON object `{}`.
--
-- See: empty smart constructor.
data Empty
-- | Creates a value of Empty with the minimum fields required to
-- make a request.
empty :: Empty
-- | A simple user profile resource.
--
-- See: googleAppsScriptTypeUser smart constructor.
data GoogleAppsScriptTypeUser
-- | Creates a value of GoogleAppsScriptTypeUser with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeUser :: GoogleAppsScriptTypeUser
-- | The user's identifying email address.
gastuEmail :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's photo.
gastuPhotoURL :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's domain.
gastuDomain :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | The user's display name.
gastuName :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
-- | A configuration that defines how a deployment is accessed externally.
--
-- See: entryPoint smart constructor.
data EntryPoint
-- | Creates a value of EntryPoint with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
entryPoint :: EntryPoint
-- | An entry point specification for Apps Script API execution calls.
epExecutionAPI :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIEntryPoint)
-- | Add-on properties.
epAddOn :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPoint)
-- | The type of the entry point.
epEntryPointType :: Lens' EntryPoint (Maybe EntryPointEntryPointType)
-- | An entry point specification for web apps.
epWebApp :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeWebAppEntryPoint)
-- | Response with the list of the versions for the specified script
-- project.
--
-- See: listVersionsResponse smart constructor.
data ListVersionsResponse
-- | Creates a value of ListVersionsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listVersionsResponse :: ListVersionsResponse
-- | The token use to fetch the next page of records. if not exist in the
-- response, that means no more versions to list.
lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text)
-- | The list of versions.
lvrVersions :: Lens' ListVersionsResponse [Version]
-- | Who has permission to run the API executable.
data GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | UNKNOWN_ACCESS Default value, should not be used.
UnknownAccess :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | MYSELF Only the user who deployed the web app or executable
-- can access it. Note that this is not necessarily the owner of the
-- script project.
Myself :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | DOMAIN Only users in the same domain as the user who deployed
-- the web app or executable can access it.
Domain :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | ANYONE Any logged in user can access the web app or
-- executable.
Anyone :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | ANYONE_ANONYMOUS Any user, logged in or not, can access the
-- web app or executable.
AnyoneAnonymous :: GoogleAppsScriptTypeExecutionAPIConfigAccess
-- | A request to run the function in a script. The script is identified by
-- the specified `script_id`. Executing a function on a script returns
-- results based on the implementation of the script.
--
-- See: executionRequest smart constructor.
data 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:
--
--
executionRequest :: ExecutionRequest
-- | The name of the function to execute in the given script. The name does
-- not include parentheses or parameters. It can reference a function in
-- an included library such as `Library.libFunction1`.
erFunction :: Lens' ExecutionRequest (Maybe Text)
-- | Deprecated. For use with Android add-ons only. An ID that
-- represents the user's current session in the Android app for Google
-- Docs or Sheets, included as extra data in the Intent that
-- launches the add-on. When an Android add-on is run with a session
-- state, it gains the privileges of a bound script—that is, it
-- can access information like the user's current cursor position (in
-- Docs) or selected cell (in Sheets). To retrieve the state, call
-- `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
-- Optional.
erSessionState :: Lens' ExecutionRequest (Maybe Text)
-- | 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 Apps Script API. Optional; default is `false`.
erDevMode :: Lens' ExecutionRequest (Maybe Bool)
-- | The parameters to be passed to the function being executed. The object
-- type for each parameter should match the expected type in Apps Script.
-- Parameters cannot be Apps Script-specific object types (such as a
-- `Document` or a `Calendar`); they can only be primitive types such as
-- `string`, `number`, `array`, `object`, or `boolean`. Optional.
erParameters :: Lens' ExecutionRequest [JSONValue]
-- | Response with the list of Process resources.
--
-- See: listScriptProcessesResponse smart constructor.
data ListScriptProcessesResponse
-- | Creates a value of ListScriptProcessesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listScriptProcessesResponse :: ListScriptProcessesResponse
-- | Token for the next page of results. If empty, there are no more pages
-- remaining.
lsprNextPageToken :: Lens' ListScriptProcessesResponse (Maybe Text)
-- | List of processes matching request parameters.
lsprProcesses :: Lens' ListScriptProcessesResponse [GoogleAppsScriptTypeProcess]
data 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:
--
--
statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
-- | Properties of the object. Contains field 'type with type URL.
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
-- | The type of the file.
data FileType
-- | ENUM_TYPE_UNSPECIFIED Undetermined file type; never actually
-- used.
EnumTypeUnspecified :: FileType
-- | SERVER_JS An Apps Script server-side code file.
ServerJs :: FileType
-- | HTML A file containing client-side HTML.
HTML :: FileType
-- | JSON A file in JSON format. This type is only used for the
-- script project's manifest. The manifest file content must match the
-- structure of a valid ScriptManifest
JSON :: FileType
-- | A stack trace through the script that shows where the execution
-- failed.
--
-- See: scriptStackTraceElement smart constructor.
data 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:
--
--
scriptStackTraceElement :: ScriptStackTraceElement
-- | The name of the function that failed.
ssteFunction :: Lens' ScriptStackTraceElement (Maybe Text)
-- | The line number where the script failed.
ssteLineNumber :: Lens' ScriptStackTraceElement (Maybe Int32)
-- | The Content resource.
--
-- See: content smart constructor.
data Content
-- | Creates a value of Content with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
content :: Content
-- | The script project's Drive ID.
cScriptId :: Lens' Content (Maybe Text)
-- | The list of script project files. One of the files is a script
-- manifest; it must be named "appsscript", must have type of JSON, and
-- include the manifest configurations for the project.
cFiles :: Lens' Content [File]
-- | The add-on's required list of supported container types.
data GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | UNKNOWN_ADDON_TYPE Default value, unknown add-on type.
UnknownAddonType :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | GMAIL Add-on type for Gmail.
Gmail :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | DATA_STUDIO Add-on type for Data Studio.
DataStudio :: GoogleAppsScriptTypeAddOnEntryPointAddOnType
-- | Metrics value that holds number of executions counted.
--
-- See: metricsValue smart constructor.
data MetricsValue
-- | Creates a value of MetricsValue with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
metricsValue :: MetricsValue
-- | Required field indicating the start time of the interval.
mvStartTime :: Lens' MetricsValue (Maybe UTCTime)
-- | Indicates the number of executions counted.
mvValue :: Lens' MetricsValue (Maybe Word64)
-- | Required field indicating the end time of the interval.
mvEndTime :: Lens' MetricsValue (Maybe UTCTime)
-- | An add-on entry point.
--
-- See: googleAppsScriptTypeAddOnEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeAddOnEntryPoint
-- | Creates a value of GoogleAppsScriptTypeAddOnEntryPoint with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeAddOnEntryPoint :: GoogleAppsScriptTypeAddOnEntryPoint
-- | The add-on's required post install tip URL.
gastaoepPostInstallTipURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's required list of supported container types.
gastaoepAddOnType :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPointAddOnType)
-- | The add-on's optional report issue URL.
gastaoepReportIssueURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's optional help URL.
gastaoepHelpURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's required title.
gastaoepTitle :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | The add-on's optional description.
gastaoepDescription :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
-- | Web app entry point configuration.
--
-- See: googleAppsScriptTypeWebAppConfig smart constructor.
data GoogleAppsScriptTypeWebAppConfig
-- | Creates a value of GoogleAppsScriptTypeWebAppConfig with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeWebAppConfig :: GoogleAppsScriptTypeWebAppConfig
-- | Who has permission to run the web app.
gastwacAccess :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigAccess)
-- | Who to execute the web app as.
gastwacExecuteAs :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigExecuteAs)
-- | A resource representing a script project version. A version is a
-- "snapshot" of a script project and is similar to a read-only branched
-- release. When creating deployments, the version to use must be
-- specified.
--
-- See: version smart constructor.
data Version
-- | Creates a value of Version with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
version :: Version
-- | The incremental ID that is created by Apps Script when a version is
-- created. This is system assigned number and is immutable once created.
vVersionNumber :: Lens' Version (Maybe Int32)
-- | The script project's Drive ID.
vScriptId :: Lens' Version (Maybe Text)
-- | The description for this version.
vDescription :: Lens' Version (Maybe Text)
-- | When the version was created.
vCreateTime :: Lens' Version (Maybe UTCTime)
-- | V1 error format.
data Xgafv
-- | 1 v1 error format
X1 :: Xgafv
-- | 2 v2 error format
X2 :: Xgafv
-- | An object that provides information about the nature of an error
-- resulting from an attempted execution of a script function using the
-- Apps Script API. If a run call succeeds but the script function (or
-- Apps Script itself) throws an exception, the response body's error
-- field contains a Status object. The `Status` object's `details` field
-- contains an array with a single one of these `ExecutionError` objects.
--
-- See: executionError smart constructor.
data 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:
--
--
executionError :: ExecutionError
-- | An array of objects that provide a stack trace through the script to
-- show where the execution failed, with the deepest call first.
eeScriptStackTraceElements :: Lens' ExecutionError [ScriptStackTraceElement]
-- | The error type, for example `TypeError` or `ReferenceError`. If the
-- error type is unavailable, this field is not included.
eeErrorType :: Lens' ExecutionError (Maybe Text)
-- | The error message thrown by Apps Script, usually localized into the
-- user's language.
eeErrorMessage :: Lens' ExecutionError (Maybe Text)
-- | A web application entry point.
--
-- See: googleAppsScriptTypeWebAppEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeWebAppEntryPoint
-- | Creates a value of GoogleAppsScriptTypeWebAppEntryPoint with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeWebAppEntryPoint :: GoogleAppsScriptTypeWebAppEntryPoint
-- | The entry point's configuration.
gastwaepEntryPointConfig :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe GoogleAppsScriptTypeWebAppConfig)
-- | The URL for the web application.
gastwaepURL :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe Text)
-- | The type of the entry point.
data EntryPointEntryPointType
-- | ENTRY_POINT_TYPE_UNSPECIFIED An unspecified entry point.
EPEPTEntryPointTypeUnspecified :: EntryPointEntryPointType
-- | WEB_APP A web application entry point.
EPEPTWebApp :: EntryPointEntryPointType
-- | EXECUTION_API An API executable entry point.
EPEPTExecutionAPI :: EntryPointEntryPointType
-- | ADD_ON An Add-On entry point.
EPEPTAddOn :: EntryPointEntryPointType
-- | Request to create a script project.
--
-- See: createProjectRequest smart constructor.
data CreateProjectRequest
-- | Creates a value of CreateProjectRequest with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createProjectRequest :: CreateProjectRequest
-- | The title for the project.
cprTitle :: Lens' CreateProjectRequest (Maybe Text)
-- | The Drive ID of a parent file that the created script project is bound
-- to. This is usually the ID of a Google Doc, Google Sheet, Google Form,
-- or Google Slides file. If not set, a standalone script project is
-- created.
cprParentId :: Lens' CreateProjectRequest (Maybe Text)
-- | The executions status.
data GoogleAppsScriptTypeProcessProcessStatus
-- | PROCESS_STATUS_UNSPECIFIED Unspecified status.
ProcessStatusUnspecified :: GoogleAppsScriptTypeProcessProcessStatus
-- | RUNNING The process is currently running.
Running :: GoogleAppsScriptTypeProcessProcessStatus
-- | PAUSED The process has paused.
Paused :: GoogleAppsScriptTypeProcessProcessStatus
-- | COMPLETED The process has completed.
Completed :: GoogleAppsScriptTypeProcessProcessStatus
-- | CANCELED The process was cancelled.
Canceled :: GoogleAppsScriptTypeProcessProcessStatus
-- | FAILED The process failed.
Failed :: GoogleAppsScriptTypeProcessProcessStatus
-- | TIMED_OUT The process timed out.
TimedOut :: GoogleAppsScriptTypeProcessProcessStatus
-- | UNKNOWN Process status unknown.
Unknown :: GoogleAppsScriptTypeProcessProcessStatus
-- | DELAYED The process is delayed, waiting for quota.
Delayed :: GoogleAppsScriptTypeProcessProcessStatus
-- | Metadata the defines how a deployment is configured.
--
-- See: deploymentConfig smart constructor.
data DeploymentConfig
-- | Creates a value of DeploymentConfig with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deploymentConfig :: DeploymentConfig
-- | The version number on which this deployment is based.
dcVersionNumber :: Lens' DeploymentConfig (Maybe Int32)
-- | The script project's Drive ID.
dcScriptId :: Lens' DeploymentConfig (Maybe Text)
-- | The manifest file name for this deployment.
dcManifestFileName :: Lens' DeploymentConfig (Maybe Text)
-- | The description for this deployment.
dcDescription :: Lens' DeploymentConfig (Maybe Text)
-- | Who has permission to run the web app.
data GoogleAppsScriptTypeWebAppConfigAccess
-- | UNKNOWN_ACCESS Default value, should not be used.
GASTWACAUnknownAccess :: GoogleAppsScriptTypeWebAppConfigAccess
-- | MYSELF Only the user who deployed the web app or executable
-- can access it. Note that this is not necessarily the owner of the
-- script project.
GASTWACAMyself :: GoogleAppsScriptTypeWebAppConfigAccess
-- | DOMAIN Only users in the same domain as the user who deployed
-- the web app or executable can access it.
GASTWACADomain :: GoogleAppsScriptTypeWebAppConfigAccess
-- | ANYONE Any logged in user can access the web app or
-- executable.
GASTWACAAnyone :: GoogleAppsScriptTypeWebAppConfigAccess
-- | ANYONE_ANONYMOUS Any user, logged in or not, can access the
-- web app or executable.
GASTWACAAnyoneAnonymous :: GoogleAppsScriptTypeWebAppConfigAccess
-- | Response with the list of deployments for the specified Apps Script
-- project.
--
-- See: listDeploymentsResponse smart constructor.
data ListDeploymentsResponse
-- | Creates a value of ListDeploymentsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listDeploymentsResponse :: ListDeploymentsResponse
-- | The token that can be used in the next call to get the next page of
-- results.
ldrNextPageToken :: Lens' ListDeploymentsResponse (Maybe Text)
-- | The list of deployments.
ldrDeployments :: Lens' ListDeploymentsResponse [Deployment]
-- | Represents a function in a script project.
--
-- See: googleAppsScriptTypeFunction smart constructor.
data GoogleAppsScriptTypeFunction
-- | Creates a value of GoogleAppsScriptTypeFunction with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeFunction :: GoogleAppsScriptTypeFunction
-- | The function name in the script project.
gastfName :: Lens' GoogleAppsScriptTypeFunction (Maybe Text)
-- | An individual file within a script project. A file is a third-party
-- source code created by one or more developers. It can be a server-side
-- JS code, HTML, or a configuration file. Each script project can
-- contain multiple files.
--
-- See: file smart constructor.
data File
-- | Creates a value of File with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
file :: File
-- | The defined set of functions in the script file, if any.
fFunctionSet :: Lens' File (Maybe GoogleAppsScriptTypeFunctionSet)
-- | The user who modified the file most recently. This read-only field is
-- only visible to users who have WRITER permission for the script
-- project.
fLastModifyUser :: Lens' File (Maybe GoogleAppsScriptTypeUser)
-- | Last modified date timestamp. This read-only field is only visible to
-- users who have WRITER permission for the script project.
fUpdateTime :: Lens' File (Maybe UTCTime)
-- | The name of the file. The file extension is not part of the file name,
-- which can be identified from the type field.
fName :: Lens' File (Maybe Text)
-- | The file content.
fSource :: Lens' File (Maybe Text)
-- | The type of the file.
fType :: Lens' File (Maybe FileType)
-- | Creation date timestamp. This read-only field is only visible to users
-- who have WRITER permission for the script project.
fCreateTime :: Lens' File (Maybe UTCTime)
-- | An API executable entry point.
--
-- See: googleAppsScriptTypeExecutionAPIEntryPoint smart
-- constructor.
data GoogleAppsScriptTypeExecutionAPIEntryPoint
-- | Creates a value of GoogleAppsScriptTypeExecutionAPIEntryPoint
-- with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
googleAppsScriptTypeExecutionAPIEntryPoint :: GoogleAppsScriptTypeExecutionAPIEntryPoint
-- | The entry point's configuration.
gasteaepEntryPointConfig :: Lens' GoogleAppsScriptTypeExecutionAPIEntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIConfig)
-- | If the script function returns successfully, this field contains an
-- ExecutionResponse object with the function's return value.
--
-- See: operationResponse smart constructor.
data 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:
--
--
operationResponse :: HashMap Text JSONValue -> OperationResponse
-- | Properties of the object. Contains field 'type with type URL.
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
-- | An object that provides the return value of a function executed using
-- the Apps Script API. If the script function returns successfully, the
-- response body's response field contains this `ExecutionResponse`
-- object.
--
-- See: executionResponse smart constructor.
data 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:
--
--
executionResponse :: ExecutionResponse
-- | The return value of the script function. The type matches the object
-- type returned in Apps Script. Functions called using the Apps Script
-- API cannot return Apps Script-specific objects (such as a `Document`
-- or a `Calendar`); they can only return primitive types such as a
-- `string`, `number`, `array`, `object`, or `boolean`.
erResult :: Lens' ExecutionResponse (Maybe JSONValue)
-- | Representation of a single script deployment.
--
-- See: deployment smart constructor.
data Deployment
-- | Creates a value of Deployment with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deployment :: Deployment
-- | The deployment ID for this deployment.
dDeploymentId :: Lens' Deployment (Maybe Text)
-- | Last modified date time stamp.
dUpdateTime :: Lens' Deployment (Maybe UTCTime)
-- | The deployment's entry points.
dEntryPoints :: Lens' Deployment [EntryPoint]
-- | The deployment configuration.
dDeploymentConfig :: Lens' Deployment (Maybe DeploymentConfig)
-- | Request with deployment information to update an existing deployment.
--
-- See: updateDeploymentRequest smart constructor.
data UpdateDeploymentRequest
-- | Creates a value of UpdateDeploymentRequest with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateDeploymentRequest :: UpdateDeploymentRequest
-- | The deployment configuration.
udrDeploymentConfig :: Lens' UpdateDeploymentRequest (Maybe DeploymentConfig)