Recurso REST: accounts.customers.entitlements

Recurso: Entitlement

Um direito representa uma entidade que fornece a um revendedor uma maneira de começar a usar um serviço. Os direitos são somente leitura e são atualizados como parte das execuções de pedidos.

Representação JSON 

{
  "name": string,
  "orderId": string,
  "state": enum(State),
  "stateReason": string,
  "createTime": string,
  "updateTime": string,
  "channelPartnerId": string
}
Campos
name

string

Nome do recurso de um direito no formato: accounts/{account_id}/customers/{customer_id}/entitlements/{id}

orderId

string

Um código de pedido que resultou na criação desse direito.

state

enum(State)

Estado do direito.

stateReason

string

Uma explicação do estado do direito.

createTime

string (Timestamp format)

Somente leitura. A hora em que o direito é criado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

A hora em que o direito é atualizado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
channelPartnerId

string

Código do Cloud Identity de um parceiro de canal que será o revendedor direto para o pedido do cliente. Geralmente, esse campo é usado em pedidos de duas camadas, em que o pedido é feito por um distribuidor de nível superior em nome do parceiro de canal ou revendedor.

Estado

Indica o estado atual do direito.

Enumerações
STATE_UNSPECIFIED Valor padrão. Esse valor nunca pode ser retornado.
ERROR Ocorreu um erro ao criar ou ativar o direito.
ACTIVE O direito está ativo no momento.
COMPLETE O direito expirou e não foi renovado ou foi cancelado. Quando um direito estiver COMPLETE, o status dele não será alterado.
CANCELED O direito não foi cumprido. Quando um direito estiver CANCELED, o status dele não será alterado.
PENDING O direito foi criado, mas não provisionado. O direito pode estar nesse estado se a aceitação dos Termos de serviço (TOS, na sigla em inglês) estiver pendente.
SUSPENDED O direito está suspenso no momento.

Métodos

assignChannelPartner

 Atribui um parceiro de canal a um recurso Entitlement.

get

 Retorna um recurso Entitlement solicitado.

list

 Lista Entitlements que pertencem a um cliente.