6.7.0 - Boleto no request e response de Subscription (#13)

Co-authored-by: Unknown <[email protected]>
pagarme · Dec 21, 2022 · 8d5539c · 8d5539c
1 parent 3a70445
commit 8d5539c
Show file tree

Hide file tree

Showing 19 changed files with 550 additions and 76 deletions.
diff --git a/doc/models/create-subscription-boleto-request.md b/doc/models/create-subscription-boleto-request.md
@@ -0,0 +1,27 @@
+
+# Create Subscription Boleto Request
+
+Information about fines and interest on the "boleto" used from payment
+
+## Structure
+
+`CreateSubscriptionBoletoRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `interest` | [`?CreateInterestRequest`](../../doc/models/create-interest-request.md) | Optional | - | getInterest(): ?CreateInterestRequest | setInterest(?CreateInterestRequest interest): void |
+| `fine` | [`?CreateFineRequest`](../../doc/models/create-fine-request.md) | Optional | - | getFine(): ?CreateFineRequest | setFine(?CreateFineRequest fine): void |
+| `maxDaysToPayPastDue` | `?int` | Optional | - | getMaxDaysToPayPastDue(): ?int | setMaxDaysToPayPastDue(?int maxDaysToPayPastDue): void |
+
+## Example (as JSON)
+
+```json
+{
+  "interest": null,
+  "fine": null,
+  "max_days_to_pay_past_due": null
+}
+```
+
diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md
@@ -43,6 +43,7 @@ Request for creating a subcription
 | `period` | [`?CreatePeriodRequest`](../../doc/models/create-period-request.md) | Optional | - | getPeriod(): ?CreatePeriodRequest | setPeriod(?CreatePeriodRequest period): void |
 | `submerchant` | [`?CreateSubMerchantRequest`](../../doc/models/create-sub-merchant-request.md) | Optional | SubMerchant | getSubmerchant(): ?CreateSubMerchantRequest | setSubmerchant(?CreateSubMerchantRequest submerchant): void |
 | `split` | [`?CreateSubscriptionSplitRequest`](../../doc/models/create-subscription-split-request.md) | Optional | Subscription's split | getSplit(): ?CreateSubscriptionSplitRequest | setSplit(?CreateSubscriptionSplitRequest split): void |
+| `boleto` | [`?CreateSubscriptionBoletoRequest`](../../doc/models/create-subscription-boleto-request.md) | Optional | Information about fines and interest on the "boleto" used from payment | getBoleto(): ?CreateSubscriptionBoletoRequest | setBoleto(?CreateSubscriptionBoletoRequest boleto): void |
 
 ## Example (as JSON)
 

diff --git a/doc/models/get-invoice-response.md b/doc/models/get-invoice-response.md
@@ -526,7 +526,8 @@ Response object for getting an invoice
                       "id": "id1"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name4",
               "quantity": null,
@@ -704,7 +705,8 @@ Response object for getting an invoice
                       "id": "id9"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name5",
               "quantity": null,
@@ -765,7 +767,8 @@ Response object for getting an invoice
                 "id": "id8"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name1",
         "quantity": null,
@@ -1052,7 +1055,8 @@ Response object for getting an invoice
                       "id": "id9"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name5",
               "quantity": null,
@@ -1276,7 +1280,8 @@ Response object for getting an invoice
                       "id": "id0"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name6",
               "quantity": null,
@@ -1468,7 +1473,8 @@ Response object for getting an invoice
                       "id": "id8"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name7",
               "quantity": null,
@@ -1560,7 +1566,8 @@ Response object for getting an invoice
                 "id": "id0"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name2",
         "quantity": null,
@@ -1621,7 +1628,8 @@ Response object for getting an invoice
           "id": "id5"
         }
       ]
-    }
+    },
+    "boleto": null
   },
   "cycle": null,
   "shipping": {

diff --git a/doc/models/get-period-response.md b/doc/models/get-period-response.md
@@ -396,7 +396,8 @@ Response object for getting a period
                       "id": "id1"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name4",
               "quantity": null,
@@ -574,7 +575,8 @@ Response object for getting a period
                       "id": "id9"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name5",
               "quantity": null,
@@ -635,7 +637,8 @@ Response object for getting a period
                 "id": "id8"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name1",
         "quantity": null,
@@ -922,7 +925,8 @@ Response object for getting a period
                       "id": "id9"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name5",
               "quantity": null,
@@ -1146,7 +1150,8 @@ Response object for getting a period
                       "id": "id0"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name6",
               "quantity": null,
@@ -1338,7 +1343,8 @@ Response object for getting a period
                       "id": "id8"
                     }
                   ]
-                }
+                },
+                "boleto": null
               },
               "name": "name7",
               "quantity": null,
@@ -1430,7 +1436,8 @@ Response object for getting a period
                 "id": "id0"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name2",
         "quantity": null,
@@ -1491,7 +1498,8 @@ Response object for getting a period
           "id": "id5"
         }
       ]
-    }
+    },
+    "boleto": null
   },
   "status": "status8",
   "duration": 112,

diff --git a/doc/models/get-subscription-boleto-response.md b/doc/models/get-subscription-boleto-response.md
@@ -0,0 +1,35 @@
+
+# Get Subscription Boleto Response
+
+Response object for getting a boleto
+
+## Structure
+
+`GetSubscriptionBoletoResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `interest` | [`?GetInterestResponse`](../../doc/models/get-interest-response.md) | Optional | Interest | getInterest(): ?GetInterestResponse | setInterest(?GetInterestResponse interest): void |
+| `fine` | [`?GetFineResponse`](../../doc/models/get-fine-response.md) | Optional | Fine | getFine(): ?GetFineResponse | setFine(?GetFineResponse fine): void |
+| `maxDaysToPayPastDue` | `?int` | Optional | - | getMaxDaysToPayPastDue(): ?int | setMaxDaysToPayPastDue(?int maxDaysToPayPastDue): void |
+
+## Example (as JSON)
+
+```json
+{
+  "interest": {
+    "days": 2,
+    "type": "percentage",
+    "amount": 20
+  },
+  "fine": {
+    "days": 2,
+    "type": "flat",
+    "amount": 10
+  },
+  "max_days_to_pay_past_due": 2
+}
+```
+
diff --git a/doc/models/get-subscription-item-response.md b/doc/models/get-subscription-item-response.md
@@ -507,7 +507,8 @@
                 "id": "id8"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name1",
         "quantity": null,
@@ -960,7 +961,8 @@
                 "id": "id0"
               }
             ]
-          }
+          },
+          "boleto": null
         },
         "name": "name2",
         "quantity": null,
@@ -1021,7 +1023,8 @@
           "id": "id5"
         }
       ]
-    }
+    },
+    "boleto": null
   },
   "name": "name0",
   "quantity": null,

diff --git a/doc/models/get-subscription-response.md b/doc/models/get-subscription-response.md
@@ -37,6 +37,7 @@
 | `increments` | [`GetIncrementResponse[]`](../../doc/models/get-increment-response.md) | Required | Subscription increments | getIncrements(): array | setIncrements(array increments): void |
 | `boletoDueDays` | `?int` | Optional | Days until boleto expires | getBoletoDueDays(): ?int | setBoletoDueDays(?int boletoDueDays): void |
 | `split` | [`GetSubscriptionSplitResponse`](../../doc/models/get-subscription-split-response.md) | Required | Subscription's split response | getSplit(): GetSubscriptionSplitResponse | setSplit(GetSubscriptionSplitResponse split): void |
+| `boleto` | [`?GetSubscriptionBoletoResponse`](../../doc/models/get-subscription-boleto-response.md) | Optional | - | getBoleto(): ?GetSubscriptionBoletoResponse | setBoleto(?GetSubscriptionBoletoResponse boleto): void |
 
 ## Example (as JSON)
 
@@ -407,7 +408,8 @@
                     "id": "id7"
                   }
                 ]
-              }
+              },
+              "boleto": null
             },
             "name": "name4",
             "quantity": null,
@@ -607,7 +609,8 @@
                     "id": "id9"
                   }
                 ]
-              }
+              },
+              "boleto": null
             },
             "name": "name5",
             "quantity": null,
@@ -668,7 +671,8 @@
               "id": "id8"
             }
           ]
-        }
+        },
+        "boleto": null
       },
       "name": "name7",
       "quantity": null,
@@ -1026,7 +1030,8 @@
                     "id": "id9"
                   }
                 ]
-              }
+              },
+              "boleto": null
             },
             "name": "name3",
             "quantity": null,
@@ -1101,7 +1106,8 @@
               "id": "id6"
             }
           ]
-        }
+        },
+        "boleto": null
       },
       "name": "name8",
       "quantity": null,
@@ -1162,7 +1168,8 @@
         "id": "id7"
       }
     ]
-  }
+  },
+  "boleto": null
 }
 ```
 
diff --git a/doc/models/get-usage-response.md b/doc/models/get-usage-response.md
@@ -600,7 +600,8 @@ Response object for getting a usage
                   "id": "id3"
                 }
               ]
-            }
+            },
+            "boleto": null
           },
           "name": "name5",
           "quantity": null,
@@ -893,7 +894,8 @@ Response object for getting a usage
                   "id": "id2"
                 }
               ]
-            }
+            },
+            "boleto": null
           },
           "name": "name6",
           "quantity": null,
@@ -1248,7 +1250,8 @@ Response object for getting a usage
                   "id": "id4"
                 }
               ]
-            }
+            },
+            "boleto": null
           },
           "name": "name7",
           "quantity": null,
@@ -1328,7 +1331,8 @@ Response object for getting a usage
             "id": "id0"
           }
         ]
-      }
+      },
+      "boleto": null
     },
     "name": "name6",
     "quantity": null,