Ferramentas · Empresas residentes

As Empresas residentes pelo assistente: cadastrar a empresa com o contrato, editar, encerrar, ver a sua empresa, a equipe, convidar por e-mail, acompanhar, aceitar e recusar convites, marcar o admin da empresa e remover. São 14 ferramentas.

Cada ferramenta traz um selo: Só consulta não muda nada, Altera cria ou muda algo na hora, e Pede confirmação só age depois do seu sim a um resumo. Ver Dinheiro e confirmação.

#Em resumo

Os papéis são os das rotas: o assistente nunca faz mais do que a pessoa conectada faria na tela. O proprietário e o administrador veem as 14; o moderador e o financeiro, 10 (as duas de leitura da equipe da comunidade e as oito abertas a qualquer papel); o membro, 8 (get_my_resident_company, list_resident_company_members, invite_resident_company_member, remove_resident_company_member, list_resident_company_invitations, list_my_company_invitations, accept_company_invitation e decline_company_invitation).

Oito ferramentas aparecem para qualquer papel porque o admin de uma empresa costuma ser um membro comum, e qualquer pessoa pode receber um convite. A API decide pelo vínculo: a equipe só é lida por quem é da equipe da comunidade ou da própria empresa, e só convida e remove o proprietário, o administrador ou o admin daquela empresa, este enquanto ela está ativa. Os outros recebem "sem permissão".

O convite do admin da empresa depende do aceite. Ele nunca vincula na hora, nem quem já é da comunidade: a pessoa recebe o convite por e-mail e entra na equipe só quando aceitar (accept_company_invitation). O proprietário e o administrador da comunidade continuam vinculando direto.

O contrato fica com a gestão. O valor mensal e as datas vêm para o proprietário, o administrador e o financeiro; o moderador lê as empresas sem essas chaves, e get_my_resident_company nunca as traz. O valor mensal é um registro, sem cobrança.

Sair da equipe suspende a cobrança. Ao remover alguém ou encerrar a empresa com a equipe, o resumo avisa que a cobrança da pessoa removida é suspensa; a assinatura fica registrada até o cancelamento, que se faz em Assinaturas.

#list_resident_companies

Só consulta

As empresas residentes, em ordem de nome, com o tipo de residência, a situação (active, ou ended quando encerrada ou com a saída no passado) e quantas pessoas há na equipe. As empresas não são membros e nunca aparecem nas listas de membros. O proprietário, o administrador e o financeiro recebem também o contrato (valor mensal, início, saída e data de encerramento); o moderador, não. Papel mínimo: moderador (ou financeiro).

Peça assim: "Quais empresas estão residentes hoje?"

#get_resident_company

Só consulta

Uma empresa. Com o contrato para o proprietário, o administrador e o financeiro. Empresa de outra comunidade: "não encontrada". O admin de uma empresa usa get_my_resident_company. Papel mínimo: moderador (ou financeiro).

Peça assim: "Até quando vai o contrato da Acme?"

#get_my_resident_company

Só consulta

A sua empresa. A empresa em que a pessoa conectada está (sem o contrato), se ela é admin da empresa, a equipe e canManageTeam, verdadeiro para o admin de uma empresa ativa (falso depois de encerrada). Sem empresa, devolve company: null; os convites pendentes estão em list_my_company_invitations. Papel mínimo: qualquer.

Sem parâmetros.

Peça assim: "Quem está na minha empresa?"

#create_resident_company

Altera

Cadastrar uma empresa com o contrato. A empresa não ganha login; as pessoas entram com invite_resident_company_member. Papel mínimo: administrador (proprietário ou administrador).

Peça assim: "Cadastre a Acme Tecnologia, sala privativa, R$ 4.800 por mês, desde 1/11."

#update_resident_company

Altera

Editar. Só o que você mandar: nome, tipo, valor, início ou saída (ends_at: null apaga a saída). Para encerrar agora, use close_resident_company. Papel mínimo: administrador (proprietário ou administrador).

Peça assim: "A Acme sai em 31/12. Atualize o contrato."

#close_resident_company

Pede confirmação

Encerrar a residência agora. A empresa deixa de aceitar convites; o cadastro e o contrato continuam registrados. Não há reabertura. Com remove_members (padrão: verdadeiro), todos saem da equipe, e quem entrou na comunidade pela empresa e ainda é membro sai também da comunidade. O resumo lista quem sai e avisa que a cobrança dessas pessoas é suspensa e a assinatura fica registrada até o cancelamento. Empresa já encerrada: recusado. Na primeira chamada devolve o resumo e o código de confirmação. Papel mínimo: administrador (proprietário ou administrador).

Peça assim: "Encerre a Acme e tire a equipe dela."

#list_resident_company_members

Só consulta

A equipe de uma empresa, com os admins primeiro: nome, cargo, se é admin da empresa, se entrou pela empresa e, para a equipe da comunidade e o admin da empresa, o e-mail. Lê quem é da equipe da comunidade ou da própria empresa. Papel mínimo: qualquer (a API confere o vínculo).

Peça assim: "Mostre a equipe da Acme."

#invite_resident_company_member

Altera

Incluir na equipe pelo e-mail. Pelo proprietário ou administrador, vincula na hora: quem já é da comunidade só ganha o vínculo, sem e-mail (linked); quem não é entra na comunidade como membro e recebe o convite por e-mail (invited): o assistente avisa antes. Pelo admin da empresa, nunca vincula: a resposta é sempre invited com pending: true e o invitation_id, seja quem for a pessoa, e o assistente diz "Convite enviado. A pessoa entra na equipe quando aceitar.", sem afirmar se ela já era da comunidade. Recusado se a comunidade não está aceitando novos membros, se a pessoa pediu para não participar, se ela já está nesta equipe ou se a empresa está encerrada; para o proprietário e o administrador, também se ela já está noutra empresa. Convidam o proprietário, o administrador e o admin daquela empresa enquanto ela está ativa; is_admin só o proprietário e o administrador. O admin da empresa manda até 30 convites por hora (acima disso, 429 com Retry-After); o proprietário e o administrador não têm esse limite. Papel mínimo: qualquer (a API confere o vínculo).

Peça assim: "Convide [email protected] para a equipe da minha empresa."

#update_resident_company_member

Altera

Marcar ou tirar o admin da empresa. O admin da empresa convida e remove a própria equipe. Papel mínimo: administrador (proprietário ou administrador).

Peça assim: "Deixe a Maria como admin da Acme."

#remove_resident_company_member

Pede confirmação

Tirar alguém da equipe. Se a pessoa entrou na comunidade pela empresa e ainda é membro, sai também da comunidade e perde o acesso; se já era da comunidade, só perde o vínculo. O resumo diz qual dos dois e avisa que a cobrança da pessoa removida é suspensa e a assinatura fica registrada até o cancelamento. Removem o proprietário, o administrador e o admin daquela empresa enquanto ela está ativa. Na primeira chamada devolve o resumo e o código de confirmação. Papel mínimo: qualquer (a API confere o vínculo).

Peça assim: "Tire o João da equipe da Acme; ele saiu da empresa."

#list_resident_company_invitations

Só consulta

Os convites pendentes da empresa: os que o admin da empresa enviou e ninguém respondeu, do mais novo ao mais antigo, com o e-mail digitado e a data. Nunca diz quem é a pessoa nem se ela já era da comunidade. Os convites do proprietário e do administrador vinculam na hora e não aparecem aqui. Leem a equipe da comunidade e o admin daquela empresa enquanto ela está ativa. Papel mínimo: qualquer (a API confere o vínculo).

Peça assim: "Quem eu convidei para a minha empresa e ainda não aceitou?"

#list_my_company_invitations

Só consulta

Os seus convites. Os convites pendentes da pessoa conectada para entrar numa equipe ("você foi convidado para a empresa X"), do mais novo ao mais antigo, com a empresa, quem convidou e a data. Só empresas ativas desta comunidade; sem convites, lista vazia. Papel mínimo: qualquer.

Sem parâmetros.

Peça assim: "Tenho algum convite de empresa?"

#accept_company_invitation

Altera

Aceitar o seu convite. A pessoa entra na equipe (sem ser admin da empresa). Não pede confirmação. Convite de outra pessoa, já respondido ou de outra comunidade: "não encontrado". Empresa encerrada depois do convite, ou pessoa já na equipe de outra empresa: recusado, com a mensagem da API. Papel mínimo: qualquer (o seu convite).

Peça assim: "Aceite o convite da Acme."

#decline_company_invitation

Pede confirmação

Recusar o seu convite. Nenhum vínculo é criado e o convite some de vez: para entrar depois, só com um convite novo. Na primeira chamada devolve o resumo e o código de confirmação. Papel mínimo: qualquer (o seu convite).

Peça assim: "Recuse o convite da Acme."

#Receitas sugeridas

• Cadastrar uma empresa: cadastrar a empresa (create_resident_company), convidar quem vai cuidar dela (invite_resident_company_member) e marcá-la como admin da empresa (update_resident_company_member, ou is_admin já no convite). Passo a passo em Receitas.
• O admin convida e a pessoa aceita: o admin da empresa convida o colega (invite_resident_company_member) e acompanha em list_resident_company_invitations; o colega vê o convite (list_my_company_invitations) e aceita (accept_company_invitation). Passo a passo em Receitas.

#Relacionados

• Empresas residentes
• Ferramentas
• Ferramentas · Membros
• Dinheiro e confirmação
• Receitas