Class: TinyErpApi::Client

Inherits:
Ac::Base
  • Object
show all
Defined in:
lib/tiny_erp_api/client.rb

Constant Summary collapse

BASE_URL = 
"https://api.tiny.com.br/public-api/v3"
SAVE_RESPONSES = 
true

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, client_secret:, refresh: nil, access_token: nil, token_expires_at: nil) ⇒ Client

Returns a new instance of Client.



6
7
8
9
10
11
12
 
# File 'lib/tiny_erp_api/client.rb', line 6

def initialize(client_id:, client_secret:, refresh: nil, access_token: nil, token_expires_at: nil)
  @client_id = client_id
  @client_secret = client_secret
  @refresh = refresh
  @access_token = access_token
  @token_expires_at = token_expires_at
end

Instance Method Details

#authorize(code:, redirect_url:) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/tiny_erp_api/client.rb', line 31

def authorize(code:, redirect_url:)
  body = {
    grant_type: 'authorization_code',
    client_id: @client_id,
    client_secret: @client_secret,
    redirect_uri: redirect_url,
    code: code
  }
  headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/x-www-form-urlencoded"
  }
  response = post("https://accounts.tiny.com.br/realms/tiny/protocol/openid-connect/token", body:, headers:, skip_authentication: true)
  @access_token = response.access_token
  @refresh = response.refresh_token
  @token_expires_at = Time.now + response.expires_in
end

#contact_types_to_integer(types) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/tiny_erp_api/client.rb', line 283

def contact_types_to_integer(types)
  contact_types = get_contact_types.itens.index_by(&:id)
  tipos = types.map do |type| 
    contact_types[type.id].perfilContato.to_i
  end
  tipos
end

#create_contact(nome:, tipo_pessoa:, codigo: nil, fantasia: nil, cpf_cnpj: nil, inscricao_estadual: nil, rg: nil, telefone: nil, celular: nil, email: nil, endereco: nil, endereco_numero: nil, endereco_complemento: nil, endereco_bairro: nil, endereco_municipio: nil, endereco_cep: nil, endereco_uf: nil, endereco_pais: nil, endereco_cobranca: nil, endereco_cobranca_numero: nil, endereco_cobranca_complemento: nil, endereco_cobranca_bairro: nil, endereco_cobranca_municipio: nil, endereco_cobranca_cep: nil, endereco_cobranca_uf: nil, endereco_cobranca_pais: nil, inscricao_municipal: nil, telefone_adicional: nil, email_nfe: nil, site: nil, regime_tributario: nil, estado_civil: nil, profissao: nil, sexo: nil, data_nascimento: nil, naturalidade: nil, nome_pai: nil, nome_mae: nil, cpf_pai: nil, cpf_mae: nil, limite_credito: nil, situacao: nil, observacoes: nil, vendedor_id: nil, tipos: nil, contatos: nil) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/tiny_erp_api/client.rb', line 71

def create_contact(
  nome:,
  tipo_pessoa:,
  codigo: nil,
  fantasia: nil,
  cpf_cnpj: nil,
  inscricao_estadual: nil,
  rg: nil,
  telefone: nil,
  celular: nil,
  email: nil,
  endereco: nil,
  endereco_numero: nil,
  endereco_complemento: nil,
  endereco_bairro: nil,
  endereco_municipio: nil,
  endereco_cep: nil,
  endereco_uf: nil,
  endereco_pais: nil,
  endereco_cobranca: nil,
  endereco_cobranca_numero: nil,
  endereco_cobranca_complemento: nil,
  endereco_cobranca_bairro: nil,
  endereco_cobranca_municipio: nil,
  endereco_cobranca_cep: nil,
  endereco_cobranca_uf: nil,
  endereco_cobranca_pais: nil,
  inscricao_municipal: nil,
  telefone_adicional: nil,
  email_nfe: nil,
  site: nil,
  regime_tributario: nil,
  estado_civil: nil,
  profissao: nil,
  sexo: nil,
  data_nascimento: nil,
  naturalidade: nil,
  nome_pai: nil,
  nome_mae: nil,
  cpf_pai: nil,
  cpf_mae: nil,
  limite_credito: nil,
  situacao: nil,
  observacoes: nil,
  vendedor_id: nil,
  tipos: nil,
  contatos: nil
)
  body = {
    nome: nome,
    codigo: codigo,
    fantasia: fantasia,
    tipoPessoa: tipo_pessoa,
    cpfCnpj: cpf_cnpj,
    inscricaoEstadual: inscricao_estadual,
    rg: rg,
    telefone: telefone,
    celular: celular,
    email: email,
    endereco: {
      endereco: endereco,
      numero: endereco_numero,
      complemento: endereco_complemento,
      bairro: endereco_bairro,
      municipio: endereco_municipio,
      cep: endereco_cep,
      uf: endereco_uf,
      pais: endereco_pais
    },
    enderecoCobranca: {
      endereco: endereco_cobranca,
      numero: endereco_cobranca_numero,
      complemento: endereco_cobranca_complemento,
      bairro: endereco_cobranca_bairro,
      municipio: endereco_cobranca_municipio,
      cep: endereco_cobranca_cep,
      uf: endereco_cobranca_uf,
      pais: endereco_cobranca_pais
    },
    inscricaoMunicipal: inscricao_municipal,
    telefoneAdicional: telefone_adicional,
    emailNfe: email_nfe,
    site: site,
    regimeTributario: regime_tributario,
    estadoCivil: estado_civil,
    profissao: profissao,
    sexo: sexo,
    dataNascimento: data_nascimento,
    naturalidade: naturalidade,
    nomePai: nome_pai,
    nomeMae: nome_mae,
    cpfPai: cpf_pai,
    cpfMae: cpf_mae,
    limiteCredito: limite_credito,
    situacao: situacao,
    observacoes: observacoes,
    vendedor: vendedor_id.present? ? { id: vendedor_id } : nil,
    tipos: tipos,
    contatos: contatos
  }.compact
  post("/contatos", body:)
end

#create_order(data:, id_contato:, itens:, data_prevista: nil, data_envio: nil, observacoes: nil, observacoes_internas: nil, situacao: nil, data_entrega: nil, numero_ordem_compra: nil, valor_desconto: nil, valor_frete: nil, valor_outras_despesas: nil, id_lista_preco: nil, id_natureza_operacao: nil, id_vendedor: nil, endereco_entrega: nil, cpfCnpj_consumidor_final: nil, cliente_consumidor_final: nil, id_ecommerce: nil, numero_pedido_ecommerce: nil, transportador: nil, id_intermediador: nil, id_deposito: nil, pagamento_forma_recebimento: nil, pagamento_meio_pagamento: nil, parcelas: [], pagamentos_integrados: []) ⇒ Object

Parameters:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/tiny_erp_api/client.rb', line 319

def create_order(
  data:,
  id_contato:,
  itens:,
  data_prevista: nil,
  data_envio: nil,
  observacoes: nil,
  observacoes_internas: nil,
  situacao: nil,
  data_entrega: nil,
  numero_ordem_compra: nil,
  valor_desconto: nil,
  valor_frete: nil,
  valor_outras_despesas: nil,
  id_lista_preco: nil,
  id_natureza_operacao: nil,
  id_vendedor: nil,
  endereco_entrega: nil,
  cpfCnpj_consumidor_final: nil,
  cliente_consumidor_final: nil,
  id_ecommerce: nil,
  numero_pedido_ecommerce: nil,
  transportador: nil,
  id_intermediador: nil,
  id_deposito: nil,
  pagamento_forma_recebimento: nil,
  pagamento_meio_pagamento: nil,
  parcelas: [],
  pagamentos_integrados: []
)
  body = {
    data: data,
    idContato: id_contato,
    itens: itens.map(&:to_api_hash),
    dataPrevista: data_prevista,
    dataEnvio: data_envio,
    observacoes: observacoes,
    observacoesInternas: observacoes_internas,
    situacao: situacao,
    dataEntrega: data_entrega,
    numeroOrdemCompra: numero_ordem_compra,
    valorDesconto: valor_desconto,
    valorFrete: valor_frete,
    valorOutrasDespesas: valor_outras_despesas,
    listaPreco: {
      id: id_lista_preco
    },
    naturezaOperacao: {
      id: id_natureza_operacao
    },
    vendedor: {
      id: id_vendedor
    },
    enderecoEntrega: endereco_entrega&.to_api_hash,
    consumidorFinal: {
      cpfCnpj: cpfCnpj_consumidor_final,
      clienteConsumidorFinal: cliente_consumidor_final
    },
    ecommerce: {
      id: id_ecommerce,
      numeroPedidoEcommerce: numero_pedido_ecommerce
    },
    transportador: transportador&.to_api_hash,
    intermediador: {
      id: id_intermediador
    },
    deposito: {
      id: id_deposito
    },
    pagamento: {
      formaRecebimento: {
        id: pagamento_forma_recebimento
      },
      meioPagamento: {
        id: pagamento_meio_pagamento
      },
      parcelas: parcelas.map(&:to_api_hash)
    },
    pagamentosIntegrados: pagamentos_integrados.map(&:to_api_hash),
  }
  post("/pedidos", body: deep_compact(body))
end

#deep_compact(hash) ⇒ Object

A API não aceita campos nulos, então precisamos remover recursivamente os campos que são nil ou hashes vazias



403
404
405
406
407
408
409
 
# File 'lib/tiny_erp_api/client.rb', line 403

def deep_compact(hash)
  hash.each_with_object({}) do |(k, v), new_hash|
    v = deep_compact(v) if v.is_a?(Hash)

    new_hash[k] = v unless v.nil? || (v.is_a?(Hash) && v.empty?)
  end
end

#default_options ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/tiny_erp_api/client.rb', line 49

def default_options
  {
    headers: {
      "Accept" => "application/json",
      "Content-Type" => "application/json"
    }
  }
end

#find_contact_by_document(document_number) ⇒ Object

Contacts



63
64
65
 
# File 'lib/tiny_erp_api/client.rb', line 63

def find_contact_by_document(document_number)
  get("/contatos?cpfCnpj=#{document_number}")
end

#get_contact(id) ⇒ Object 



67
68
69
 
# File 'lib/tiny_erp_api/client.rb', line 67

def get_contact(id)
  get("/contatos/#{id}") { _1.id }
end

#get_contact_types ⇒ Object 



279
280
281
 
# File 'lib/tiny_erp_api/client.rb', line 279

def get_contact_types
  get("/contatos/tipos")
end

#get_order_by_id(order_id) ⇒ Object

Orders



310
311
312
 
# File 'lib/tiny_erp_api/client.rb', line 310

def get_order_by_id(order_id)
  get("/pedidos/#{order_id}")
end

#get_product_by_id(product_id) ⇒ Object 



305
306
307
 
# File 'lib/tiny_erp_api/client.rb', line 305

def get_product_by_id(product_id)
  get("/produtos/#{product_id}")
end

#get_product_by_sku(sku) ⇒ Object

Products



301
302
303
 
# File 'lib/tiny_erp_api/client.rb', line 301

def get_product_by_sku(sku)
  get("/produtos?codigo=#{URI.encode_www_form_component(sku)}")
end

#get_refresh_token ⇒ Object 



58
59
60
 
# File 'lib/tiny_erp_api/client.rb', line 58

def get_refresh_token
  @refresh
end

#get_seller_by_name(seller_name) ⇒ Object 



296
297
298
 
# File 'lib/tiny_erp_api/client.rb', line 296

def get_seller_by_name(seller_name)
  get("/vendedores?nome=#{URI.encode_www_form_component(seller_name)}")
end

#get_sellers(limit = 100, offset = 0) ⇒ Object

Sellers



292
293
294
 
# File 'lib/tiny_erp_api/client.rb', line 292

def get_sellers(limit = 100, offset = 0)
  get("/vendedores?limit=#{limit}&offset=#{offset}")
end

#refresh_token ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/tiny_erp_api/client.rb', line 14

def refresh_token
  body = {
    grant_type: "refresh_token",
    client_id: @client_id,
    client_secret: @client_secret,
    refresh_token: @refresh
  }
  headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/x-www-form-urlencoded"
  }
  response = post("https://accounts.tiny.com.br/realms/tiny/protocol/openid-connect/token", body:, headers:, skip_authentication: true)
  @access_token = response.access_token
  @refresh = response.refresh_token
  @token_expires_at = Time.now + response.expires_in
end

#update_contact(id:, nome: nil, codigo: nil, fantasia: nil, tipo_pessoa: nil, cpf_cnpj: nil, inscricao_estadual: nil, rg: nil, telefone: nil, celular: nil, email: nil, endereco: nil, endereco_numero: nil, endereco_complemento: nil, endereco_bairro: nil, endereco_municipio: nil, endereco_cep: nil, endereco_uf: nil, endereco_pais: nil, endereco_cobranca: nil, endereco_cobranca_numero: nil, endereco_cobranca_complemento: nil, endereco_cobranca_bairro: nil, endereco_cobranca_municipio: nil, endereco_cobranca_cep: nil, endereco_cobranca_uf: nil, endereco_cobranca_pais: nil, inscricao_municipal: nil, telefone_adicional: nil, email_nfe: nil, site: nil, regime_tributario: nil, estado_civil: nil, profissao: nil, sexo: nil, data_nascimento: nil, naturalidade: nil, nome_pai: nil, nome_mae: nil, cpf_pai: nil, cpf_mae: nil, limite_credito: nil, situacao: nil, observacoes: nil, vendedor_id: nil, tipos: nil, contatos: nil) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/tiny_erp_api/client.rb', line 174

def update_contact(
  id:,
  nome: nil,
  codigo: nil,
  fantasia: nil,
  tipo_pessoa: nil,
  cpf_cnpj: nil,
  inscricao_estadual: nil,
  rg: nil,
  telefone: nil,
  celular: nil,
  email: nil,
  endereco: nil,
  endereco_numero: nil,
  endereco_complemento: nil,
  endereco_bairro: nil,
  endereco_municipio: nil,
  endereco_cep: nil,
  endereco_uf: nil,
  endereco_pais: nil,
  endereco_cobranca: nil,
  endereco_cobranca_numero: nil,
  endereco_cobranca_complemento: nil,
  endereco_cobranca_bairro: nil,
  endereco_cobranca_municipio: nil,
  endereco_cobranca_cep: nil,
  endereco_cobranca_uf: nil,
  endereco_cobranca_pais: nil,
  inscricao_municipal: nil,
  telefone_adicional: nil,
  email_nfe: nil,
  site: nil,
  regime_tributario: nil,
  estado_civil: nil,
  profissao: nil,
  sexo: nil,
  data_nascimento: nil,
  naturalidade: nil,
  nome_pai: nil,
  nome_mae: nil,
  cpf_pai: nil,
  cpf_mae: nil,
  limite_credito: nil,
  situacao: nil,
  observacoes: nil,
  vendedor_id: nil,
  tipos: nil,
  contatos: nil
  )
  contact = get_contact(id)
  body = {
    nome: nome || contact.nome,
    codigo: codigo || contact.codigo,
    fantasia: fantasia || contact.fantasia,
    tipoPessoa: tipo_pessoa || contact.tipoPessoa,
    cpfCnpj: cpf_cnpj || contact.cpfCnpj,
    inscricaoEstadual: inscricao_estadual || contact.inscricaoEstadual,
    rg: rg || contact.rg,
    telefone: telefone || contact.telefone,
    celular: celular || contact.celular,
    email: email || contact.email,
    endereco: {
      endereco: endereco || contact.endereco&.endereco,
      numero: endereco_numero || contact.endereco&.numero,
      complemento: endereco_complemento || contact.endereco&.complemento,
      bairro: endereco_bairro || contact.endereco&.bairro,
      municipio: endereco_municipio || contact.endereco&.municipio,
      cep: endereco_cep || contact.endereco&.cep,
      uf: endereco_uf || contact.endereco&.uf,
      pais: endereco_pais || contact.endereco&.pais
    },
    enderecoCobranca: {
      endereco: endereco_cobranca || contact.enderecoCobranca&.endereco,
      numero: endereco_cobranca_numero || contact.enderecoCobranca&.numero,
      complemento: endereco_cobranca_complemento || contact.enderecoCobranca&.complemento,
      bairro: endereco_cobranca_bairro || contact.enderecoCobranca&.bairro,
      municipio: endereco_cobranca_municipio || contact.enderecoCobranca&.municipio,
      cep: endereco_cobranca_cep || contact.enderecoCobranca&.cep,
      uf: endereco_cobranca_uf || contact.enderecoCobranca&.uf,
      pais: endereco_cobranca_pais || contact.enderecoCobranca&.pais
    },
    inscricaoMunicipal: inscricao_municipal || contact.inscricaoMunicipal,
    telefoneAdicional: telefone_adicional || contact.telefoneAdicional,
    emailNfe: email_nfe || contact.emailNfe,
    site: site || contact.site,
    regimeTributario: regime_tributario || contact.regimeTributario.zero? ? nil : contact.regimeTributario,
    estadoCivil: estado_civil || contact.estadoCivil,
    profissao: profissao || contact.profissao,
    sexo: sexo || contact.sexo.empty? ? nil : contact.sexo,
    dataNascimento: data_nascimento || contact.dataNascimento,
    naturalidade: naturalidade || contact.naturalidade,
    nomePai: nome_pai || contact.nomePai,
    nomeMae: nome_mae || contact.nomeMae,
    cpfPai: cpf_pai || contact.cpfPai,
    cpfMae: cpf_mae || contact.cpfMae,
    limiteCredito: limite_credito || contact.limiteCredito.zero? ? nil : contact.limiteCredito,
    situacao: situacao || contact.situacao,
    observacoes: observacoes || contact.observacoes,
    vendedor: (vendedor_id.present? ? { id: vendedor_id } : nil) || contact.vendedor,
    tipos: tipos || contact.tipos.map(&:id),
    contatos: contatos || contact.contatos
  }
  put("/contatos/#{id}", body:)
end