Adicionado campo 'installments' no SubscriptionPlanModel

ipagdevs · Mar 29, 2024 · 0cbda2f · 0cbda2f
1 parent 2b724af
commit 0cbda2f
Show file tree

Hide file tree

Showing 5 changed files with 141 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -21,95 +21,109 @@
 **Índice**
 
 - [iPag PHP client SDK](#ipag-php-client-sdk)
-  - [Dependências](#dependências)
-  - [Instalação](#instalação)
+  - [Status](#status)
+- [Dependências](#dependências)
+- [Instalação](#instalação)
 - [IpagClient](#ipagclient)
-  - [Autenticação](#autenticação)
+    - [Autenticação](#autenticação)
 - [Pagamento (Payment)](#pagamento-payment)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Criar Pagamento](#criar-pagamento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Consultar Pagamento](#consultar-pagamento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Capturar Pagamento](#capturar-pagamento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Cancelar Pagamento](#cancelar-pagamento)
-
+    - [Criar Pagamento](#criar-pagamento)
+    - [Consultar Pagamento](#consultar-pagamento)
+    - [Capturar Pagamento](#capturar-pagamento)
+    - [Cancelar Pagamento](#cancelar-pagamento)
 - [Cliente (Customer)](#cliente-customer)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Cliente](#novo-cliente)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Cliente](#alterar-cliente)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Cliente](#obter-cliente)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Clientes](#listar-clientes)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/DEL-e27a7a.svg?style=for-the-badge" /> [Deletar Cliente](#deletar-cliente)
+    - [Novo Cliente](#novo-cliente)
+    - [Alterar Cliente](#alterar-cliente)
+    - [Obter Cliente](#obter-cliente)
+    - [Listar Clientes](#listar-clientes)
+    - [Deletar Cliente](#deletar-cliente)
 - [Plano de Assinatura (Subscription Plan)](#plano-de-assinatura-subscription-plan)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Plano](#novo-plano-de-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Plano](#alterar-plano-de-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Plano](#obter-plano-de-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Planos](#listar-planos-de-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/DEL-e27a7a.svg?style=for-the-badge" /> [Deletar Plano](#deletar-plano-de-assinatura)
+    - [Novo Plano de Assinatura](#novo-plano-de-assinatura)
+    - [Alterar Plano de Assinatura](#alterar-plano-de-assinatura)
+    - [Obter Plano de Assinatura](#obter-plano-de-assinatura)
+    - [Listar Planos de Assinatura](#listar-planos-de-assinatura)
+    - [Deletar Plano de Assinatura](#deletar-plano-de-assinatura)
 - [Assinatura (Subscription)](#assinatura-subscription)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Nova Assinatura](#nova-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Assinatura](#alterar-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Assinatura](#obter-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Assinaturas](#listar-assinaturas)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/DEL-e27a7a.svg?style=for-the-badge" /> [Desvincular Token da assinatura](#desvincular-token-da-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Quitar Parcela da Assinatura](#quitar-parcela-da-assinatura)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Agendar Parcelamento da Assinatura](#agendar-parcelamento-da-assinatura)
+    - [Nova Assinatura](#nova-assinatura)
+    - [Alterar Assinatura](#alterar-assinatura)
+    - [Obter Assinatura](#obter-assinatura)
+    - [Listar Assinaturas](#listar-assinaturas)
+    - [Desvincular Token da Assinatura](#desvincular-token-da-assinatura)
+    - [Quitar Parcela da Assinatura](#quitar-parcela-da-assinatura)
+    - [Agendar Parcelamento da Assinatura](#agendar-parcelamento-da-assinatura)
 - [Transação (Transaction)](#transação-transaction)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Transação](#obter-transação)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Transações](#listar-transações)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Liberar Recebíveis da Transação](#liberar-recebíveis-da-transação)
+    - [Obter Transação](#obter-transação)
+    - [Listar Transações](#listar-transações)
+    - [Liberar Recebíveis da Transação](#liberar-recebíveis-da-transação)
 - [Token (Card Token)](#token-card-token)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Token](#novo-token)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Token](#obter-token)
+    - [Novo Token](#novo-token)
+    - [Obter Token](#obter-token)
 - [Cobrança (Charge)](#cobrança-charge)
-  -  <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Nova Cobrança](#nova-cobrança)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Cobrança](#alterar-cobrança)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Cobrança](#obter-cobrança)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Cobranças](#listar-cobranças)
+    - [Nova Cobrança](#nova-cobrança)
+    - [Alterar Cobrança](#alterar-cobrança)
+    - [Obter Cobrança](#obter-cobrança)
+    - [Listar Cobranças](#listar-cobranças)
 - [Estabelecimento (Establishment)](#estabelecimento-establishment)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Estabelecimento](#novo-estabelecimento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Estabelecimento](#alterar-estabelecimento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Estabelecimento](#obter-estabelecimento)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Estabelecimentos](#listar-estabelecimentos)
-  + [Transações (Transactions)](#transações-transactions)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar todas Transações dos Estabelecimentos](#listar-todas-transações-dos-estabelecimentos)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Transações dos Estabelecimentos](#listar-transações-dos-estabelecimentos)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Transação de um Estabelecimento](#obter-transação-de-um-estabelecimento)
-  + [Métodos de Pagamento (Payment Methods)](#métodos-de-pagamento-payment-methods)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Configurar Métodos de Pagamento](#configurar-métodos-de-pagamento)
-  + [Antifraudes (Antifraud)](#antifraudes-antifraud)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Configurar Antifraudes](#configurar-antifraudes)
+    - [Novo Estabelecimento](#novo-estabelecimento)
+    - [Alterar Estabelecimento](#alterar-estabelecimento)
+    - [Obter Estabelecimento](#obter-estabelecimento)
+    - [Listar Estabelecimentos](#listar-estabelecimentos)
+  - [Transações (Transactions)](#transações-transactions)
+    - [Listar todas Transações dos Estabelecimentos](#listar-todas-transações-dos-estabelecimentos)
+    - [Listar Transações dos Estabelecimentos](#listar-transações-dos-estabelecimentos)
+    - [Obter Transação de um Estabelecimento](#obter-transação-de-um-estabelecimento)
+  - [Métodos de Pagamento (Payment Methods)](#métodos-de-pagamento-payment-methods)
+    - [Configurar Métodos de Pagamento](#configurar-métodos-de-pagamento)
+  - [Antifraudes (Antifraud)](#antifraudes-antifraud)
+    - [Configurar Antifraudes](#configurar-antifraudes)
 - [Regra de Split (Split Rules)](#regra-de-split-split-rules)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Nova Regra de Split](#nova-regra-de-split)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Regra de Split](#obter-regra-de-split)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Regras de Split](#listar-regras-de-split)
-    - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/DEL-e27a7a.svg?style=for-the-badge" /> [Deletar Regra de Split](#deletar-regra-de-split)
+    - [Nova Regra de Split](#nova-regra-de-split)
+    - [Obter Regra de Split](#obter-regra-de-split)
+    - [Listar Regras de Split](#listar-regras-de-split)
+    - [Deletar Regra de Split](#deletar-regra-de-split)
 - [Vendedor (Seller)](#vendedor-seller)
-   - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Vendedor](#novo-vendedor)
-   - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/PUT-9b708b.svg?style=for-the-badge" /> [Alterar Vendedor](#alterar-vendedor)
-   - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Vendedor](#obter-vendedor)
-   - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Vendedores](#listar-Vendedores)
+    - [Novo Vendedor](#novo-vendedor)
+    - [Alterar Vendedor](#alterar-vendedor)
+    - [Obter Vendedor](#obter-vendedor)
+    - [Listar Vendedores](#listar-vendedores)
 - [Transferência (Transfer)](#transferência-transfer)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Transferências](#listar-transferências)
-  - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Transferência](#obter-transferência)
-  +  [Transferência dos Vendedores (Sellers Transfers)](#transferência-dos-vendedores-sellers-transfers)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Transferências dos Vendedores](#listar-transferências-dos-vendedores)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Transferência de Vendedor](#obter-transferência-de-vendedor)
-  +  [Lançamentos Futuros (Future Transfers)](#lançamentos-futuros-future-transfers)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Lançamentos Futuros](#listar-lançamentos-futuros)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Lançamentos Futuros de Vendedor (Por Id)](#listar-lançamentos-futuros-de-vendedor-por-id)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Lançamentos Futuros de Vendedor (Por CPF/CNPJ)](#listar-lançamentos-futuros-de-vendedor-por-cpf-cnpj)
+    - [Listar Transferências](#listar-transferências)
+    - [Obter Transferência](#obter-transferência)
+  - [Transferência dos Vendedores (Sellers Transfers)](#transferência-dos-vendedores-sellers-transfers)
+    - [Listar Transferências dos Vendedores](#listar-transferências-dos-vendedores)
+    - [Obter Transferência de Vendedor](#obter-transferência-de-vendedor)
+  - [Lançamentos Futuros (Future Transfers)](#lançamentos-futuros-future-transfers)
+    - [Listar Lançamentos Futuros](#listar-lançamentos-futuros)
+    - [Listar Lançamentos Futuros de Vendedor (Por Id)](#listar-lançamentos-futuros-de-vendedor-por-id)
+    - [Listar Lançamentos Futuros de Vendedor (Por CPF/CNPJ)](#listar-lançamentos-futuros-de-vendedor-por-cpfcnpj)
 - [Link de Pagamento (Payment Links)](#link-de-pagamento-payment-links)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Link de Pagamento](#novo-link-de-pagamento)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Link de Pagamento (Por Id)](#obter-link-de-pagamento-por-id)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Link de Pagamento (Por External Code)](#obter-link-de-pagamento-por-external-code)
+    - [Novo Link de Pagamento](#novo-link-de-pagamento)
+    - [Obter Link de Pagamento (Por Id)](#obter-link-de-pagamento-por-id)
+    - [Obter Link de Pagamento (Por External Code)](#obter-link-de-pagamento-por-external-code)
 - [Webhook](#webhook)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Webhook](#novo-webhook)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Obter Webhook](#obter-webhook)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/GET-6bbd5b.svg?style=for-the-badge" /> [Listar Webhooks](#listar-webhooks)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/DEL-e27a7a.svg?style=for-the-badge" /> [Deletar Webhook](#deletar-webhook)
+    - [Novo Webhook](#novo-webhook)
+    - [Obter Webhook](#obter-webhook)
+    - [Listar Webhooks](#listar-webhooks)
+    - [Deletar Webhook](#deletar-webhook)
 - [Checkout](#checkout)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Checkout](#novo-checkout)
+    - [Novo Checkout](#novo-checkout)
 - [Voucher](#voucher)
-     - <img style="max-width: 100%;vertical-align: middle;" width="30" src="https://img.shields.io/badge/POST-248fb2.svg?style=for-the-badge" /> [Novo Voucher](#novo-voucher)
+    - [Novo Voucher](#novo-voucher)
 - [Helpers](#helpers)
+  - [Credenciais dos Provedores de Antifraudes](#credenciais-dos-provedores-de-antifraudes)
+    - [Clear Sale](#clear-sale)
+    - [Konduto](#konduto)
+    - [Red Shield](#red-shield)
+  - [Credenciais dos Provedores de Meios de Pagamentos](#credenciais-dos-provedores-de-meios-de-pagamentos)
+    - [Adiq](#adiq)
+    - [Bin](#bin)
+    - [Cielo](#cielo)
+    - [Getnet](#getnet)
+    - [Global Payments](#global-payments)
+    - [Rede](#rede)
+    - [Sipag](#sipag)
+    - [Stone](#stone)
+    - [Zoop](#zoop)
 - [Testes](#testes)
 - [Licença](#licença)
 - [Documentação](#documentação)
@@ -412,6 +426,7 @@ $subscriptionPlan = new \Ipag\Sdk\Model\SubscriptionPlan([
     'pro_rated_charge' => true,
     'grace_period' => 0,
     'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
+    'installments' => 1,
     'trial' => [
         'amount' => 0,
         'cycles' => 0
@@ -433,6 +448,7 @@ $subscriptionPlan = new \Ipag\Sdk\Model\SubscriptionPlan()
     ->setProRatedCharge(true)
     ->setGracePeriod(0)
     ->setCallbackUrl("https://ipag-sdk.requestcatcher.com/callback")
+    ->setInstallments(1)
     ->setTrial(
         new \Ipag\Sdk\Model\Trial()
             ->setAmount(0)

diff --git a/examples/subscription_plan/00-subscription-plan-create.php b/examples/subscription_plan/00-subscription-plan-create.php
@@ -14,6 +14,7 @@
         'pro_rated_charge' => true,
         'grace_period' => 0,
         'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
+        'installments' => 1,
         'trial' => [
             'amount' => 0,
             'cycles' => 0
@@ -29,20 +30,17 @@
     echo "<pre>" . PHP_EOL;
     print_r($data);
     echo "</pre>" . PHP_EOL;
-
 } catch (Ipag\Sdk\Exception\HttpException $e) {
     $code = $e->getResponse()->getStatusCode();
     $errors = $e->getErrors();
 
     echo "<pre>" . PHP_EOL;
     var_dump($code, $errors);
     echo "</pre>" . PHP_EOL;
-
 } catch (Exception $e) {
     $error = $e->getMessage();
 
     echo "<pre>" . PHP_EOL;
     var_dump($error);
     echo "</pre>" . PHP_EOL;
-
-}
+}
diff --git a/examples/subscription_plan/01-subscription-plan-update.php b/examples/subscription_plan/01-subscription-plan-update.php
@@ -14,6 +14,7 @@
         'pro_rated_charge' => true,
         'grace_period' => 0,
         'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
+        'installments' => 1,
         'trial' => [
             'amount' => 0,
             'cycles' => 0
@@ -31,20 +32,17 @@
     echo "<pre>" . PHP_EOL;
     print_r($data);
     echo "</pre>" . PHP_EOL;
-
 } catch (Ipag\Sdk\Exception\HttpException $e) {
     $code = $e->getResponse()->getStatusCode();
     $errors = $e->getErrors();
 
     echo "<pre>" . PHP_EOL;
     var_dump($code, $errors);
     echo "</pre>" . PHP_EOL;
-
 } catch (Exception $e) {
     $error = $e->getMessage();
 
     echo "<pre>" . PHP_EOL;
     var_dump($error);
     echo "</pre>" . PHP_EOL;
-
-}
+}