Wax API . items

Instance Methods

delete(sessionId, itemId)

Deletes an item.

get(sessionId, itemId)

Gets one item by ID.

insert(sessionId, body)

Inserts a new item into this session.

list(sessionId)

Retrieves a list of items in a session.

patch(sessionId, itemId, body)

Updates an existing item. This method supports patch semantics.

update(sessionId, itemId, body)

Updates an existing item.

watch(sessionId, body)

Subscribe to changes to any item in a session.

watchToOneItem(sessionId, itemId, body)

Subscribe to changes to one item in a session.

Method Details

delete(sessionId, itemId)
Deletes an item.

Args:
  sessionId: string, The session ID. (required)
  itemId: string, The item ID. (required)
get(sessionId, itemId)
Gets one item by ID.

Args:
  sessionId: string, The session ID. (required)
  itemId: string, The item ID. (required)

Returns:
  An object of the form:

    {
      "blobOfData": "A String", # A blob of data stored in the item.
      "sizeInBytes": 42, # The size (in bytes) of the blob of data.
      "kind": "wax#waxDataItem", # The kind of object this is.
      "id": "A String", # The item ID.
      "name": "A String", # The name of the item.
    }
insert(sessionId, body)
Inserts a new item into this session.

Args:
  sessionId: string, The session ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "blobOfData": "A String", # A blob of data stored in the item.
    "sizeInBytes": 42, # The size (in bytes) of the blob of data.
    "kind": "wax#waxDataItem", # The kind of object this is.
    "id": "A String", # The item ID.
    "name": "A String", # The name of the item.
  }


Returns:
  An object of the form:

    {
      "blobOfData": "A String", # A blob of data stored in the item.
      "sizeInBytes": 42, # The size (in bytes) of the blob of data.
      "kind": "wax#waxDataItem", # The kind of object this is.
      "id": "A String", # The item ID.
      "name": "A String", # The name of the item.
    }
list(sessionId)
Retrieves a list of items in a session.

Args:
  sessionId: string, The session ID. (required)

Returns:
  An object of the form:

    {
    "items": [ # The list of Wax items.
      {
          "blobOfData": "A String", # A blob of data stored in the item.
          "sizeInBytes": 42, # The size (in bytes) of the blob of data.
          "kind": "wax#waxDataItem", # The kind of object this is.
          "id": "A String", # The item ID.
          "name": "A String", # The name of the item.
        },
    ],
    "kind": "wax#waxList", # The kind of object this is.
  }
patch(sessionId, itemId, body)
Updates an existing item. This method supports patch semantics.

Args:
  sessionId: string, The session ID. (required)
  itemId: string, The item ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "blobOfData": "A String", # A blob of data stored in the item.
    "sizeInBytes": 42, # The size (in bytes) of the blob of data.
    "kind": "wax#waxDataItem", # The kind of object this is.
    "id": "A String", # The item ID.
    "name": "A String", # The name of the item.
  }


Returns:
  An object of the form:

    {
      "blobOfData": "A String", # A blob of data stored in the item.
      "sizeInBytes": 42, # The size (in bytes) of the blob of data.
      "kind": "wax#waxDataItem", # The kind of object this is.
      "id": "A String", # The item ID.
      "name": "A String", # The name of the item.
    }
update(sessionId, itemId, body)
Updates an existing item.

Args:
  sessionId: string, The session ID. (required)
  itemId: string, The item ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "blobOfData": "A String", # A blob of data stored in the item.
    "sizeInBytes": 42, # The size (in bytes) of the blob of data.
    "kind": "wax#waxDataItem", # The kind of object this is.
    "id": "A String", # The item ID.
    "name": "A String", # The name of the item.
  }


Returns:
  An object of the form:

    {
      "blobOfData": "A String", # A blob of data stored in the item.
      "sizeInBytes": 42, # The size (in bytes) of the blob of data.
      "kind": "wax#waxDataItem", # The kind of object this is.
      "id": "A String", # The item ID.
      "name": "A String", # The name of the item.
    }
watch(sessionId, body)
Subscribe to changes to any item in a session.

Args:
  sessionId: string, The session ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # The canonicalized ID of the watched resource.
    "kind": "api#channel", # A channel watching an API resource
    "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
    "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
    "params": { # Additional parameters controlling delivery channel behavior
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # The expiration instant for this channel if it is defined.
    "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
    "type": "A String", # The type of delivery mechanism used by this channel
    "id": "A String", # A UUID for the channel
  }


Returns:
  An object of the form:

    {
      "resourceUri": "A String", # The canonicalized ID of the watched resource.
      "kind": "api#channel", # A channel watching an API resource
      "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
      "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
      "params": { # Additional parameters controlling delivery channel behavior
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # The expiration instant for this channel if it is defined.
      "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
      "type": "A String", # The type of delivery mechanism used by this channel
      "id": "A String", # A UUID for the channel
    }
watchToOneItem(sessionId, itemId, body)
Subscribe to changes to one item in a session.

Args:
  sessionId: string, The session ID. (required)
  itemId: string, The item ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "resourceUri": "A String", # The canonicalized ID of the watched resource.
    "kind": "api#channel", # A channel watching an API resource
    "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
    "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
    "params": { # Additional parameters controlling delivery channel behavior
      "a_key": "A String", # Declares a new parameter by name.
    },
    "expiration": "A String", # The expiration instant for this channel if it is defined.
    "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
    "type": "A String", # The type of delivery mechanism used by this channel
    "id": "A String", # A UUID for the channel
  }


Returns:
  An object of the form:

    {
      "resourceUri": "A String", # The canonicalized ID of the watched resource.
      "kind": "api#channel", # A channel watching an API resource
      "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
      "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
      "params": { # Additional parameters controlling delivery channel behavior
        "a_key": "A String", # Declares a new parameter by name.
      },
      "expiration": "A String", # The expiration instant for this channel if it is defined.
      "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
      "type": "A String", # The type of delivery mechanism used by this channel
      "id": "A String", # A UUID for the channel
    }