rogerfelipensk-dynamo-v3 v1.0.2

Wiipo Client Payment Documents

Wiipo Client Tenant é uma biblioteca JavaScript para manipular os dados na tabela.

Como instalar

yarn add @wiipolabs/wiipo-client-tenant

Como executar local

Faça uma cópia do arquivo .env.example e salve ele com o nome .env.local na raiz do projeto.

Depois execute na raiz do projeto:

yarn install
yarn dev

Schema

Colunas:

• tenant_id - (String) Valor da chave do registro.
• title - (String) (Índice secundário) Nome.
• responsible_name - (String) Nome do responsável pelo ambiente do cliente. (criptografado)
• responsible_phone - (String) Telefone do responsável pelo ambiente do cliente. (criptografado)
• responsible_email - (String) E-mail do responsável pelo ambiente do cliente. (criptografado)
• active - (Boolean) Situação.
• s3_path - (String) Diretório no S3.

Permissões

Para leitura do índice Title, é necessário no serverless.yml adicionar uma permissão, conforme a seguir.

- Effect: "Allow"
                  Action:
                    - dynamodb:Scan
                    - dynamodb:Query
                  Resource: "arn:aws:dynamodb:${self:provider.region}:*:table/Tenants/index/*"

Funções

getTenantById

Função para retornar um regitro da tabela tenant.

import { getTenantById } from '@wiipolabs/wiipo-client-tenant';
const response = await getTenantById({ tenantId: '123', columns: ['title'] }); // ⇨ { title: 'Joao' }

Parâmetros:

• tenantId - (String) Valor da chave do registro.
• columns - (ArrayString) Lista de colunas que devem ser retornadas.

updateTenantById

Função para atualizar um regitro da tabela tenant.

import { updateTenantById } from '@wiipolabs/wiipo-client-tenant';
const response = await updateTenantById({ tenantId: '123', columns: ['title'], content: { title: 'Lucas' } }); // ⇨ {}

Parâmetros:

• tenantId - (String) Valor da chave do registro.
• columns - (ArrayString) Lista de colunas que devem ser atualizadas.
• content - (Objeto) Objeto contendo o valor das colunas que devem ser atualizadas.

deleteTenantById

Função para apagar um regitro da tabela.

import { deleteTenantById } from '@wiipolabs/wiipo-client-tenant';
const response = await deleteTenantById({ tenantId: '123' }); // ⇨ {}

Parâmetros:

• tenantId - (String) Valor da chave do registro.

Licença

MIT.