google_api_script

# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule GoogleApi.Script.V1.Model.ExecutionRequest do
  @moduledoc """
  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.

  ## Attributes

  - parameters (List[ErrorUnknown]): 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. Defaults to: `null`.
  - devMode (Boolean): If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Execution API. Optional; default is `false`. Defaults to: `null`.
  - function (String): The name of the function to execute in the given script. The name does not include parentheses or parameters. Defaults to: `null`.
  - sessionState (String): For 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`](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/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. Defaults to: `null`.
  """

  defstruct [
    :"parameters",
    :"devMode",
    :"function",
    :"sessionState"
  ]
end

defimpl Poison.Decoder, for: GoogleApi.Script.V1.Model.ExecutionRequest do
  import GoogleApi.Script.V1.Deserializer
  def decode(value, options) do
    value
    |> deserialize(:"parameters", :list, nil, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Script.V1.Model.ExecutionRequest do
  def encode(value, options) do
    GoogleApi.Script.V1.Deserializer.serialize_non_nil(value, options)
  end
end