bf_ruby2 1.2016.229

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (886) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +201 -0
  3. data/README.md +824 -0
  4. data/bf_ruby2-1.0.0.gem +0 -0
  5. data/bf_ruby2.gemspec +55 -0
  6. data/docs/APIConfigurationPagedMetadata.md +14 -0
  7. data/docs/APIQuote.md +36 -0
  8. data/docs/APIQuotePagedMetadata.md +14 -0
  9. data/docs/APIQuoteResponseQuantity.md +25 -0
  10. data/docs/Account.md +21 -0
  11. data/docs/AccountLTVResultPagedMetadata.md +14 -0
  12. data/docs/AccountPagedMetadata.md +14 -0
  13. data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
  14. data/docs/AccountsApi.md +1021 -0
  15. data/docs/AddChargeRequest.md +23 -0
  16. data/docs/AddCouponCodeRequest.md +11 -0
  17. data/docs/AddPaymentMethodRequest.md +8 -0
  18. data/docs/AddTaxationStrategyRequest.md +11 -0
  19. data/docs/Address.md +23 -0
  20. data/docs/AddressPagedMetadata.md +14 -0
  21. data/docs/AddressesApi.md +104 -0
  22. data/docs/AggregatingComponent.md +17 -0
  23. data/docs/Amendment.md +19 -0
  24. data/docs/AmendmentDiscardAmendment.md +20 -0
  25. data/docs/AmendmentPagedMetadata.md +14 -0
  26. data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
  27. data/docs/AmendmentsApi.md +639 -0
  28. data/docs/AnalyticsApi.md +641 -0
  29. data/docs/AuditEntry.md +17 -0
  30. data/docs/AuditEntryPagedMetadata.md +14 -0
  31. data/docs/AuditlogsApi.md +308 -0
  32. data/docs/AuthCaptureRequest.md +17 -0
  33. data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
  34. data/docs/BFError.md +11 -0
  35. data/docs/BFPermission.md +17 -0
  36. data/docs/BFPermissionPagedMetadata.md +14 -0
  37. data/docs/BankAccountVerificationPagedMetadata.md +14 -0
  38. data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
  39. data/docs/BillingEntityBase.md +8 -0
  40. data/docs/BraintreeAuthCaptureRequest.md +19 -0
  41. data/docs/BraintreeCaptureRequest.md +20 -0
  42. data/docs/BraintreeTokenPagedMetadata.md +14 -0
  43. data/docs/CancelSubscriptionRequest.md +14 -0
  44. data/docs/CancellationAmendment.md +24 -0
  45. data/docs/CassChurnResultPagedMetadata.md +14 -0
  46. data/docs/CassPaymentResultPagedMetadata.md +14 -0
  47. data/docs/CassUpgradeResultPagedMetadata.md +14 -0
  48. data/docs/ChargesApi.md +408 -0
  49. data/docs/Client.md +21 -0
  50. data/docs/ClientPagedMetadata.md +14 -0
  51. data/docs/ClientsApi.md +215 -0
  52. data/docs/ComponentChange.md +20 -0
  53. data/docs/ComponentCost.md +9 -0
  54. data/docs/CompoundUsage.md +11 -0
  55. data/docs/CompoundUsageSession.md +11 -0
  56. data/docs/ConfigurationsApi.md +221 -0
  57. data/docs/Coupon.md +32 -0
  58. data/docs/CouponBook.md +21 -0
  59. data/docs/CouponBookDefinition.md +24 -0
  60. data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
  61. data/docs/CouponBookPagedMetadata.md +14 -0
  62. data/docs/CouponDefinition.md +26 -0
  63. data/docs/CouponDefinitionPagedMetadata.md +14 -0
  64. data/docs/CouponDiscount.md +18 -0
  65. data/docs/CouponDiscountEstimate.md +13 -0
  66. data/docs/CouponInstance.md +26 -0
  67. data/docs/CouponInstanceExistingValue.md +15 -0
  68. data/docs/CouponInstancePagedMetadata.md +14 -0
  69. data/docs/CouponModifierBase.md +22 -0
  70. data/docs/CouponModifierBasePagedMetadata.md +14 -0
  71. data/docs/CouponPagedMetadata.md +14 -0
  72. data/docs/CouponRule.md +24 -0
  73. data/docs/CouponRulePagedMetadata.md +14 -0
  74. data/docs/CouponUniqueCodesRequest.md +11 -0
  75. data/docs/CouponUniqueCodesResponse.md +10 -0
  76. data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
  77. data/docs/CouponWrapperResponse.md +13 -0
  78. data/docs/CouponbookApi.md +496 -0
  79. data/docs/CouponbookdefinitionApi.md +329 -0
  80. data/docs/CoupondefinitionApi.md +267 -0
  81. data/docs/CouponinstanceApi.md +578 -0
  82. data/docs/CouponmodifierApi.md +369 -0
  83. data/docs/CouponruleApi.md +269 -0
  84. data/docs/CouponsApi.md +456 -0
  85. data/docs/CreateAccountProfileRequest.md +20 -0
  86. data/docs/CreateAccountRequest.md +13 -0
  87. data/docs/CreateAddressRequest.md +17 -0
  88. data/docs/CreateAggregatingComponentRequest.md +10 -0
  89. data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
  90. data/docs/CreateProfileAddressRequest.md +16 -0
  91. data/docs/CreateSubscriptionBatchRequest.md +10 -0
  92. data/docs/CreateSubscriptionChargeAmendment.md +29 -0
  93. data/docs/CreateSubscriptionRequest.md +26 -0
  94. data/docs/CreditAccountRequest.md +13 -0
  95. data/docs/CreditNote.md +21 -0
  96. data/docs/CreditNotePagedMetadata.md +14 -0
  97. data/docs/CreditSubscriptionRequest.md +12 -0
  98. data/docs/CreditnotesApi.md +339 -0
  99. data/docs/CybersourceTokenPagedMetadata.md +14 -0
  100. data/docs/CybersourcetokensApi.md +259 -0
  101. data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
  102. data/docs/DataSynchronisationConfiguration.md +20 -0
  103. data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
  104. data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
  105. data/docs/DebtsResultPagedMetadata.md +14 -0
  106. data/docs/DunningLine.md +18 -0
  107. data/docs/DunningLinePagedMetadata.md +14 -0
  108. data/docs/DunninglinesApi.md +328 -0
  109. data/docs/DynamicMetadata.md +7 -0
  110. data/docs/Email.md +35 -0
  111. data/docs/EmailPagedMetadata.md +14 -0
  112. data/docs/EmailProvider.md +18 -0
  113. data/docs/EmailProviderPagedMetadata.md +14 -0
  114. data/docs/EmailSubscription.md +20 -0
  115. data/docs/EmailSubscriptionPagedMetadata.md +14 -0
  116. data/docs/EmailprovidersApi.md +221 -0
  117. data/docs/EmailsApi.md +164 -0
  118. data/docs/EmailsubscriptionsApi.md +273 -0
  119. data/docs/EndTrialAmendment.md +19 -0
  120. data/docs/Event.md +15 -0
  121. data/docs/EventData.md +9 -0
  122. data/docs/FileSham.md +7 -0
  123. data/docs/FixedTerm.md +24 -0
  124. data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
  125. data/docs/FixedTermExpiryAmendment.md +20 -0
  126. data/docs/FixedTermPagedMetadata.md +14 -0
  127. data/docs/FixedtermdefinitionsApi.md +104 -0
  128. data/docs/FixedtermsApi.md +56 -0
  129. data/docs/FlatPricingComponent.md +32 -0
  130. data/docs/ImportInvoiceLine.md +16 -0
  131. data/docs/InsertableBillingEntity.md +21 -0
  132. data/docs/Invoice.md +54 -0
  133. data/docs/InvoiceChargeRequest.md +11 -0
  134. data/docs/InvoiceLine.md +38 -0
  135. data/docs/InvoiceLinePayment.md +36 -0
  136. data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
  137. data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
  138. data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
  139. data/docs/InvoicePagedMetadata.md +14 -0
  140. data/docs/InvoicePayment.md +22 -0
  141. data/docs/InvoiceRecalculationAmendment.md +23 -0
  142. data/docs/InvoiceRecalculationRequest.md +12 -0
  143. data/docs/InvoicesApi.md +2474 -0
  144. data/docs/IssueInvoiceAmendment.md +20 -0
  145. data/docs/MetadataApi.md +210 -0
  146. data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
  147. data/docs/MigrationRequest.md +16 -0
  148. data/docs/ModelAlias.md +14 -0
  149. data/docs/MutableBillingEntity.md +27 -0
  150. data/docs/Notification.md +27 -0
  151. data/docs/NotificationPagedMetadata.md +14 -0
  152. data/docs/NotificationsApi.md +370 -0
  153. data/docs/Organization.md +21 -0
  154. data/docs/OrganizationPagedMetadata.md +14 -0
  155. data/docs/OrganizationsApi.md +378 -0
  156. data/docs/Password.md +14 -0
  157. data/docs/PasswordPagedMetadata.md +14 -0
  158. data/docs/PasswordResetRequest.md +8 -0
  159. data/docs/PasswordsApi.md +56 -0
  160. data/docs/PauseRequest.md +9 -0
  161. data/docs/Payment.md +24 -0
  162. data/docs/PaymentMethod.md +32 -0
  163. data/docs/PaymentMethodPagedMetadata.md +14 -0
  164. data/docs/PaymentMethodSubscriptionLink.md +17 -0
  165. data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
  166. data/docs/PaymentPagedMetadata.md +14 -0
  167. data/docs/PaymentRetryRequest.md +9 -0
  168. data/docs/PaymentmethodsApi.md +445 -0
  169. data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
  170. data/docs/PaymentsApi.md +464 -0
  171. data/docs/PendingComponentValueChange.md +11 -0
  172. data/docs/Period.md +16 -0
  173. data/docs/PeriodPagedMetadata.md +14 -0
  174. data/docs/PeriodsApi.md +125 -0
  175. data/docs/PermissionActionEntityPagedMetadata.md +14 -0
  176. data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
  177. data/docs/PermissionsApi.md +322 -0
  178. data/docs/PriceCalculationPagedMetadata.md +14 -0
  179. data/docs/PricingComponent.md +32 -0
  180. data/docs/PricingComponentCouponModifier.md +22 -0
  181. data/docs/PricingComponentMigrationValue.md +12 -0
  182. data/docs/PricingComponentPagedMetadata.md +14 -0
  183. data/docs/PricingComponentQuantityRequest.md +10 -0
  184. data/docs/PricingComponentTier.md +19 -0
  185. data/docs/PricingComponentTierPagedMetadata.md +14 -0
  186. data/docs/PricingComponentValue.md +20 -0
  187. data/docs/PricingComponentValueChangeAmendment.md +22 -0
  188. data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
  189. data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
  190. data/docs/PricingComponentValuePagedMetadata.md +14 -0
  191. data/docs/PricingComponentValueRequest.md +12 -0
  192. data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
  193. data/docs/PricingcalculatorApi.md +152 -0
  194. data/docs/PricingcomponentsApi.md +339 -0
  195. data/docs/PricingcomponenttiersApi.md +281 -0
  196. data/docs/PricingcomponentvaluechangesApi.md +345 -0
  197. data/docs/PricingcomponentvaluesApi.md +287 -0
  198. data/docs/Product.md +25 -0
  199. data/docs/ProductCouponModifier.md +22 -0
  200. data/docs/ProductPagedMetadata.md +14 -0
  201. data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
  202. data/docs/ProductRatePlan.md +39 -0
  203. data/docs/ProductRatePlanMigrationAmendment.md +27 -0
  204. data/docs/ProductRatePlanPagedMetadata.md +14 -0
  205. data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
  206. data/docs/ProductrateplansApi.md +786 -0
  207. data/docs/ProductsApi.md +493 -0
  208. data/docs/Profile.md +25 -0
  209. data/docs/ProfilePagedMetadata.md +14 -0
  210. data/docs/ProfilesApi.md +287 -0
  211. data/docs/QuoteRequest.md +24 -0
  212. data/docs/QuoteRequestValue.md +11 -0
  213. data/docs/QuotesApi.md +56 -0
  214. data/docs/RecalculateChargeRequest.md +15 -0
  215. data/docs/Receipt.md +36 -0
  216. data/docs/ReceiptPagedMetadata.md +14 -0
  217. data/docs/ReceiptsApi.md +421 -0
  218. data/docs/Refund.md +35 -0
  219. data/docs/RefundPagedMetadata.md +14 -0
  220. data/docs/RefundsApi.md +432 -0
  221. data/docs/ResumeRequest.md +10 -0
  222. data/docs/ResumeSubscriptionAmendment.md +19 -0
  223. data/docs/RevenueAttribution.md +31 -0
  224. data/docs/RevenueAttributionPagedMetadata.md +14 -0
  225. data/docs/ReviveSubscriptionRequest.md +8 -0
  226. data/docs/Role.md +19 -0
  227. data/docs/RolePagedMetadata.md +14 -0
  228. data/docs/RolesApi.md +327 -0
  229. data/docs/RuleSatisfaction.md +11 -0
  230. data/docs/SearchApi.md +70 -0
  231. data/docs/SearchResultPagedMetadata.md +14 -0
  232. data/docs/ServiceEndAmendment.md +19 -0
  233. data/docs/StripeACHTokenPagedMetadata.md +14 -0
  234. data/docs/StripeAuthCaptureRequest.md +20 -0
  235. data/docs/StripeObject.md +7 -0
  236. data/docs/StripeTokenPagedMetadata.md +14 -0
  237. data/docs/Subscription.md +47 -0
  238. data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
  239. data/docs/SubscriptionCharge.md +32 -0
  240. data/docs/SubscriptionChargePagedMetadata.md +14 -0
  241. data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
  242. data/docs/SubscriptionPagedMetadata.md +14 -0
  243. data/docs/SubscriptionsApi.md +2841 -0
  244. data/docs/SwaggerTypeList.md +9 -0
  245. data/docs/SwaggerTypeListInv.md +8 -0
  246. data/docs/SwaggerTypeListSubs.md +9 -0
  247. data/docs/SynchAppConfigsApi.md +208 -0
  248. data/docs/SynchConfigsApi.md +317 -0
  249. data/docs/SynchJobsApi.md +421 -0
  250. data/docs/TaxationLinkPagedMetadata.md +14 -0
  251. data/docs/TaxationStrategyPagedMetadata.md +14 -0
  252. data/docs/TaxationlinksApi.md +339 -0
  253. data/docs/TaxationstrategiesApi.md +514 -0
  254. data/docs/TieredPricingComponent.md +32 -0
  255. data/docs/TieredVolumePricingComponent.md +32 -0
  256. data/docs/TimeApi.md +56 -0
  257. data/docs/TimeRequest.md +16 -0
  258. data/docs/TimeResponse.md +18 -0
  259. data/docs/TimeResponsePagedMetadata.md +14 -0
  260. data/docs/TimeZone.md +11 -0
  261. data/docs/TimerAmendment.md +26 -0
  262. data/docs/TokenizationApi.md +340 -0
  263. data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
  264. data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
  265. data/docs/UnitDiscount.md +11 -0
  266. data/docs/UnitOfMeasure.md +16 -0
  267. data/docs/UnitOfMeasureCouponModifier.md +22 -0
  268. data/docs/UnitOfMeasurePagedMetadata.md +14 -0
  269. data/docs/UnitofmeasureApi.md +215 -0
  270. data/docs/UpdateAddressRequest.md +18 -0
  271. data/docs/UpdateComponentValueAmendment.md +23 -0
  272. data/docs/UpdateProfileRequest.md +22 -0
  273. data/docs/UpdateRoleRequest.md +13 -0
  274. data/docs/UpdateSubscriptionRequest.md +16 -0
  275. data/docs/Usage.md +26 -0
  276. data/docs/UsageApi.md +296 -0
  277. data/docs/UsagePagedMetadata.md +14 -0
  278. data/docs/UsagePeriodPagedMetadata.md +14 -0
  279. data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
  280. data/docs/UsageSession.md +21 -0
  281. data/docs/UsageSessionPagedMetadata.md +14 -0
  282. data/docs/UsageperiodsApi.md +194 -0
  283. data/docs/UsageroundingstrategiesApi.md +228 -0
  284. data/docs/UsagesessionsApi.md +224 -0
  285. data/docs/User.md +21 -0
  286. data/docs/UserCreationRequest.md +17 -0
  287. data/docs/UserCreationResponsePagedMetadata.md +14 -0
  288. data/docs/UserPagedMetadata.md +14 -0
  289. data/docs/Username.md +13 -0
  290. data/docs/UsernamePagedMetadata.md +14 -0
  291. data/docs/UsernamesApi.md +56 -0
  292. data/docs/UsersApi.md +564 -0
  293. data/docs/VaultedgatewaysApi.md +648 -0
  294. data/docs/WebhookPagedMetadata.md +14 -0
  295. data/docs/WebhooksApi.md +366 -0
  296. data/git_push.sh +67 -0
  297. data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
  298. data/lib/bf_ruby2/api/addresses_api.rb +148 -0
  299. data/lib/bf_ruby2/api/amendments_api.rb +819 -0
  300. data/lib/bf_ruby2/api/analytics_api.rb +815 -0
  301. data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
  302. data/lib/bf_ruby2/api/charges_api.rb +527 -0
  303. data/lib/bf_ruby2/api/clients_api.rb +282 -0
  304. data/lib/bf_ruby2/api/configurations_api.rb +298 -0
  305. data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
  306. data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
  307. data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
  308. data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
  309. data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
  310. data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
  311. data/lib/bf_ruby2/api/coupons_api.rb +580 -0
  312. data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
  313. data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
  314. data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
  315. data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
  316. data/lib/bf_ruby2/api/emails_api.rb +214 -0
  317. data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
  318. data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
  319. data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
  320. data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
  321. data/lib/bf_ruby2/api/metadata_api.rb +266 -0
  322. data/lib/bf_ruby2/api/notifications_api.rb +480 -0
  323. data/lib/bf_ruby2/api/organizations_api.rb +476 -0
  324. data/lib/bf_ruby2/api/passwords_api.rb +91 -0
  325. data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
  326. data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
  327. data/lib/bf_ruby2/api/payments_api.rb +601 -0
  328. data/lib/bf_ruby2/api/periods_api.rb +180 -0
  329. data/lib/bf_ruby2/api/permissions_api.rb +408 -0
  330. data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
  331. data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
  332. data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
  333. data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
  334. data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
  335. data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
  336. data/lib/bf_ruby2/api/products_api.rb +611 -0
  337. data/lib/bf_ruby2/api/profiles_api.rb +375 -0
  338. data/lib/bf_ruby2/api/quotes_api.rb +91 -0
  339. data/lib/bf_ruby2/api/receipts_api.rb +559 -0
  340. data/lib/bf_ruby2/api/refunds_api.rb +540 -0
  341. data/lib/bf_ruby2/api/roles_api.rb +421 -0
  342. data/lib/bf_ruby2/api/search_api.rb +109 -0
  343. data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
  344. data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
  345. data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
  346. data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
  347. data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
  348. data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
  349. data/lib/bf_ruby2/api/time_api.rb +91 -0
  350. data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
  351. data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
  352. data/lib/bf_ruby2/api/usage_api.rb +389 -0
  353. data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
  354. data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
  355. data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
  356. data/lib/bf_ruby2/api/usernames_api.rb +91 -0
  357. data/lib/bf_ruby2/api/users_api.rb +692 -0
  358. data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
  359. data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
  360. data/lib/bf_ruby2/api_client.rb +378 -0
  361. data/lib/bf_ruby2/api_error.rb +47 -0
  362. data/lib/bf_ruby2/configuration.rb +207 -0
  363. data/lib/bf_ruby2/models/account.rb +335 -0
  364. data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
  365. data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
  366. data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
  367. data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
  368. data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
  369. data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
  370. data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
  371. data/lib/bf_ruby2/models/address.rb +359 -0
  372. data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
  373. data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
  374. data/lib/bf_ruby2/models/amendment.rb +374 -0
  375. data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
  376. data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
  377. data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
  378. data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
  379. data/lib/bf_ruby2/models/api_quote.rb +525 -0
  380. data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
  381. data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
  382. data/lib/bf_ruby2/models/audit_entry.rb +359 -0
  383. data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
  384. data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
  385. data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
  386. data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
  387. data/lib/bf_ruby2/models/bf_error.rb +265 -0
  388. data/lib/bf_ruby2/models/bf_permission.rb +337 -0
  389. data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
  390. data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
  391. data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
  392. data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
  393. data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
  394. data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
  395. data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
  396. data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
  397. data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
  398. data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
  399. data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
  400. data/lib/bf_ruby2/models/client.rb +342 -0
  401. data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
  402. data/lib/bf_ruby2/models/component_change.rb +373 -0
  403. data/lib/bf_ruby2/models/component_cost.rb +208 -0
  404. data/lib/bf_ruby2/models/compound_usage.rb +234 -0
  405. data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
  406. data/lib/bf_ruby2/models/coupon.rb +484 -0
  407. data/lib/bf_ruby2/models/coupon_book.rb +342 -0
  408. data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
  409. data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
  410. data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
  411. data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
  412. data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
  413. data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
  414. data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
  415. data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
  416. data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
  417. data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
  418. data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
  419. data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
  420. data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
  421. data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
  422. data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
  423. data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
  424. data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
  425. data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
  426. data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
  427. data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
  428. data/lib/bf_ruby2/models/create_account_request.rb +248 -0
  429. data/lib/bf_ruby2/models/create_address_request.rb +298 -0
  430. data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
  431. data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
  432. data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
  433. data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
  434. data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
  435. data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
  436. data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
  437. data/lib/bf_ruby2/models/credit_note.rb +368 -0
  438. data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
  439. data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
  440. data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
  441. data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
  442. data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
  443. data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
  444. data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
  445. data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
  446. data/lib/bf_ruby2/models/dunning_line.rb +354 -0
  447. data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
  448. data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
  449. data/lib/bf_ruby2/models/email.rb +518 -0
  450. data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
  451. data/lib/bf_ruby2/models/email_provider.rb +302 -0
  452. data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
  453. data/lib/bf_ruby2/models/email_subscription.rb +364 -0
  454. data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
  455. data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
  456. data/lib/bf_ruby2/models/event.rb +272 -0
  457. data/lib/bf_ruby2/models/event_data.rb +212 -0
  458. data/lib/bf_ruby2/models/file_sham.rb +190 -0
  459. data/lib/bf_ruby2/models/fixed_term.rb +419 -0
  460. data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
  461. data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
  462. data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
  463. data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
  464. data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
  465. data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
  466. data/lib/bf_ruby2/models/invoice.rb +746 -0
  467. data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
  468. data/lib/bf_ruby2/models/invoice_line.rb +575 -0
  469. data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
  470. data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
  471. data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
  472. data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
  473. data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
  474. data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
  475. data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
  476. data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
  477. data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
  478. data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
  479. data/lib/bf_ruby2/models/migration_request.rb +332 -0
  480. data/lib/bf_ruby2/models/model_alias.rb +266 -0
  481. data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
  482. data/lib/bf_ruby2/models/notification.rb +472 -0
  483. data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
  484. data/lib/bf_ruby2/models/organization.rb +349 -0
  485. data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
  486. data/lib/bf_ruby2/models/password.rb +266 -0
  487. data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
  488. data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
  489. data/lib/bf_ruby2/models/pause_request.rb +210 -0
  490. data/lib/bf_ruby2/models/payment.rb +417 -0
  491. data/lib/bf_ruby2/models/payment_method.rb +487 -0
  492. data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
  493. data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
  494. data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
  495. data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
  496. data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
  497. data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
  498. data/lib/bf_ruby2/models/period.rb +330 -0
  499. data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
  500. data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
  501. data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
  502. data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
  503. data/lib/bf_ruby2/models/pricing_component.rb +546 -0
  504. data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
  505. data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
  506. data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
  507. data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
  508. data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
  509. data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
  510. data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
  511. data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
  512. data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
  513. data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
  514. data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
  515. data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
  516. data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
  517. data/lib/bf_ruby2/models/product.rb +435 -0
  518. data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
  519. data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
  520. data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
  521. data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
  522. data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
  523. data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
  524. data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
  525. data/lib/bf_ruby2/models/profile.rb +378 -0
  526. data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
  527. data/lib/bf_ruby2/models/quote_request.rb +431 -0
  528. data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
  529. data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
  530. data/lib/bf_ruby2/models/receipt.rb +535 -0
  531. data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
  532. data/lib/bf_ruby2/models/refund.rb +535 -0
  533. data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
  534. data/lib/bf_ruby2/models/resume_request.rb +222 -0
  535. data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
  536. data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
  537. data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
  538. data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
  539. data/lib/bf_ruby2/models/role.rb +318 -0
  540. data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
  541. data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
  542. data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
  543. data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
  544. data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
  545. data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
  546. data/lib/bf_ruby2/models/stripe_object.rb +190 -0
  547. data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
  548. data/lib/bf_ruby2/models/subscription.rb +681 -0
  549. data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
  550. data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
  551. data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
  552. data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
  553. data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
  554. data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
  555. data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
  556. data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
  557. data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
  558. data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
  559. data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
  560. data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
  561. data/lib/bf_ruby2/models/time_request.rb +323 -0
  562. data/lib/bf_ruby2/models/time_response.rb +345 -0
  563. data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
  564. data/lib/bf_ruby2/models/time_zone.rb +226 -0
  565. data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
  566. data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
  567. data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
  568. data/lib/bf_ruby2/models/unit_discount.rb +226 -0
  569. data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
  570. data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
  571. data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
  572. data/lib/bf_ruby2/models/update_address_request.rb +303 -0
  573. data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
  574. data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
  575. data/lib/bf_ruby2/models/update_role_request.rb +253 -0
  576. data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
  577. data/lib/bf_ruby2/models/usage.rb +423 -0
  578. data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
  579. data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
  580. data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
  581. data/lib/bf_ruby2/models/usage_session.rb +368 -0
  582. data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
  583. data/lib/bf_ruby2/models/user.rb +352 -0
  584. data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
  585. data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
  586. data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
  587. data/lib/bf_ruby2/models/username.rb +253 -0
  588. data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
  589. data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
  590. data/lib/bf_ruby2/version.rb +26 -0
  591. data/lib/bf_ruby2.rb +340 -0
  592. data/setup.scratch.rb +33 -0
  593. data/spec/api/accounts_api_spec.rb +318 -0
  594. data/spec/api/addresses_api_spec.rb +70 -0
  595. data/spec/api/amendments_api_spec.rb +220 -0
  596. data/spec/api/analytics_api_spec.rb +220 -0
  597. data/spec/api/auditlogs_api_spec.rb +131 -0
  598. data/spec/api/charges_api_spec.rb +156 -0
  599. data/spec/api/clients_api_spec.rb +100 -0
  600. data/spec/api/configurations_api_spec.rb +103 -0
  601. data/spec/api/couponbook_api_spec.rb +175 -0
  602. data/spec/api/couponbookdefinition_api_spec.rb +131 -0
  603. data/spec/api/coupondefinition_api_spec.rb +113 -0
  604. data/spec/api/couponinstance_api_spec.rb +203 -0
  605. data/spec/api/couponmodifier_api_spec.rb +138 -0
  606. data/spec/api/couponrule_api_spec.rb +113 -0
  607. data/spec/api/coupons_api_spec.rb +168 -0
  608. data/spec/api/creditnotes_api_spec.rb +135 -0
  609. data/spec/api/cybersourcetokens_api_spec.rb +109 -0
  610. data/spec/api/dunninglines_api_spec.rb +131 -0
  611. data/spec/api/emailproviders_api_spec.rb +102 -0
  612. data/spec/api/emails_api_spec.rb +85 -0
  613. data/spec/api/emailsubscriptions_api_spec.rb +115 -0
  614. data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
  615. data/spec/api/fixedterms_api_spec.rb +58 -0
  616. data/spec/api/invoices_api_spec.rb +727 -0
  617. data/spec/api/metadata_api_spec.rb +96 -0
  618. data/spec/api/notifications_api_spec.rb +148 -0
  619. data/spec/api/organizations_api_spec.rb +143 -0
  620. data/spec/api/passwords_api_spec.rb +58 -0
  621. data/spec/api/paymentmethods_api_spec.rb +163 -0
  622. data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
  623. data/spec/api/payments_api_spec.rb +172 -0
  624. data/spec/api/periods_api_spec.rb +79 -0
  625. data/spec/api/permissions_api_spec.rb +127 -0
  626. data/spec/api/pricingcalculator_api_spec.rb +82 -0
  627. data/spec/api/pricingcomponents_api_spec.rb +136 -0
  628. data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
  629. data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
  630. data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
  631. data/spec/api/productrateplans_api_spec.rb +254 -0
  632. data/spec/api/products_api_spec.rb +173 -0
  633. data/spec/api/profiles_api_spec.rb +122 -0
  634. data/spec/api/quotes_api_spec.rb +58 -0
  635. data/spec/api/receipts_api_spec.rb +164 -0
  636. data/spec/api/refunds_api_spec.rb +156 -0
  637. data/spec/api/roles_api_spec.rb +129 -0
  638. data/spec/api/search_api_spec.rb +64 -0
  639. data/spec/api/subscriptions_api_spec.rb +809 -0
  640. data/spec/api/synch_app_configs_api_spec.rb +96 -0
  641. data/spec/api/synch_configs_api_spec.rb +125 -0
  642. data/spec/api/synch_jobs_api_spec.rb +151 -0
  643. data/spec/api/taxationlinks_api_spec.rb +136 -0
  644. data/spec/api/taxationstrategies_api_spec.rb +185 -0
  645. data/spec/api/time_api_spec.rb +58 -0
  646. data/spec/api/tokenization_api_spec.rb +138 -0
  647. data/spec/api/unitofmeasure_api_spec.rb +100 -0
  648. data/spec/api/usage_api_spec.rb +125 -0
  649. data/spec/api/usageperiods_api_spec.rb +99 -0
  650. data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
  651. data/spec/api/usagesessions_api_spec.rb +104 -0
  652. data/spec/api/usernames_api_spec.rb +58 -0
  653. data/spec/api/users_api_spec.rb +187 -0
  654. data/spec/api/vaultedgateways_api_spec.rb +206 -0
  655. data/spec/api/webhooks_api_spec.rb +138 -0
  656. data/spec/api_client_spec.rb +237 -0
  657. data/spec/configuration_spec.rb +53 -0
  658. data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
  659. data/spec/models/account_paged_metadata_spec.rb +89 -0
  660. data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
  661. data/spec/models/account_spec.rb +131 -0
  662. data/spec/models/add_charge_request_spec.rb +155 -0
  663. data/spec/models/add_coupon_code_request_spec.rb +71 -0
  664. data/spec/models/add_payment_method_request_spec.rb +53 -0
  665. data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
  666. data/spec/models/address_paged_metadata_spec.rb +89 -0
  667. data/spec/models/address_spec.rb +143 -0
  668. data/spec/models/aggregating_component_spec.rb +107 -0
  669. data/spec/models/amendment_discard_amendment_spec.rb +137 -0
  670. data/spec/models/amendment_paged_metadata_spec.rb +89 -0
  671. data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
  672. data/spec/models/amendment_spec.rb +131 -0
  673. data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
  674. data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
  675. data/spec/models/api_quote_response_quantity_spec.rb +159 -0
  676. data/spec/models/api_quote_spec.rb +225 -0
  677. data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
  678. data/spec/models/audit_entry_spec.rb +119 -0
  679. data/spec/models/auth_capture_request_spec.rb +115 -0
  680. data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
  681. data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
  682. data/spec/models/bf_error_spec.rb +75 -0
  683. data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
  684. data/spec/models/bf_permission_spec.rb +115 -0
  685. data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
  686. data/spec/models/billing_entity_base_spec.rb +53 -0
  687. data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
  688. data/spec/models/braintree_capture_request_spec.rb +125 -0
  689. data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
  690. data/spec/models/cancel_subscription_request_spec.rb +97 -0
  691. data/spec/models/cancellation_amendment_spec.rb +169 -0
  692. data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
  693. data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
  694. data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
  695. data/spec/models/client_paged_metadata_spec.rb +89 -0
  696. data/spec/models/client_spec.rb +131 -0
  697. data/spec/models/component_change_spec.rb +133 -0
  698. data/spec/models/component_cost_spec.rb +59 -0
  699. data/spec/models/compound_usage_session_spec.rb +71 -0
  700. data/spec/models/compound_usage_spec.rb +71 -0
  701. data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
  702. data/spec/models/coupon_book_definition_spec.rb +157 -0
  703. data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
  704. data/spec/models/coupon_book_spec.rb +131 -0
  705. data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
  706. data/spec/models/coupon_definition_spec.rb +173 -0
  707. data/spec/models/coupon_discount_estimate_spec.rb +83 -0
  708. data/spec/models/coupon_discount_spec.rb +113 -0
  709. data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
  710. data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
  711. data/spec/models/coupon_instance_spec.rb +165 -0
  712. data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
  713. data/spec/models/coupon_modifier_base_spec.rb +149 -0
  714. data/spec/models/coupon_paged_metadata_spec.rb +89 -0
  715. data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
  716. data/spec/models/coupon_rule_spec.rb +173 -0
  717. data/spec/models/coupon_spec.rb +201 -0
  718. data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
  719. data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
  720. data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
  721. data/spec/models/coupon_wrapper_response_spec.rb +83 -0
  722. data/spec/models/create_account_profile_request_spec.rb +125 -0
  723. data/spec/models/create_account_request_spec.rb +83 -0
  724. data/spec/models/create_address_request_spec.rb +107 -0
  725. data/spec/models/create_aggregating_component_request_spec.rb +65 -0
  726. data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
  727. data/spec/models/create_profile_address_request_spec.rb +101 -0
  728. data/spec/models/create_subscription_batch_request_spec.rb +65 -0
  729. data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
  730. data/spec/models/create_subscription_request_spec.rb +173 -0
  731. data/spec/models/credit_account_request_spec.rb +83 -0
  732. data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
  733. data/spec/models/credit_note_spec.rb +135 -0
  734. data/spec/models/credit_subscription_request_spec.rb +77 -0
  735. data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
  736. data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
  737. data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
  738. data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
  739. data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
  740. data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
  741. data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
  742. data/spec/models/dunning_line_spec.rb +121 -0
  743. data/spec/models/dynamic_metadata_spec.rb +47 -0
  744. data/spec/models/email_paged_metadata_spec.rb +89 -0
  745. data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
  746. data/spec/models/email_provider_spec.rb +113 -0
  747. data/spec/models/email_spec.rb +223 -0
  748. data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
  749. data/spec/models/email_subscription_spec.rb +133 -0
  750. data/spec/models/end_trial_amendment_spec.rb +131 -0
  751. data/spec/models/event_data_spec.rb +59 -0
  752. data/spec/models/event_spec.rb +95 -0
  753. data/spec/models/file_sham_spec.rb +47 -0
  754. data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
  755. data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
  756. data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
  757. data/spec/models/fixed_term_spec.rb +157 -0
  758. data/spec/models/flat_pricing_component_spec.rb +221 -0
  759. data/spec/models/import_invoice_line_spec.rb +101 -0
  760. data/spec/models/insertable_billing_entity_spec.rb +139 -0
  761. data/spec/models/invoice_charge_request_spec.rb +75 -0
  762. data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
  763. data/spec/models/invoice_line_payment_spec.rb +225 -0
  764. data/spec/models/invoice_line_spec.rb +245 -0
  765. data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
  766. data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
  767. data/spec/models/invoice_paged_metadata_spec.rb +89 -0
  768. data/spec/models/invoice_payment_spec.rb +141 -0
  769. data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
  770. data/spec/models/invoice_recalculation_request_spec.rb +85 -0
  771. data/spec/models/invoice_spec.rb +341 -0
  772. data/spec/models/issue_invoice_amendment_spec.rb +137 -0
  773. data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
  774. data/spec/models/migration_request_spec.rb +109 -0
  775. data/spec/models/model_alias_spec.rb +89 -0
  776. data/spec/models/mutable_billing_entity_spec.rb +183 -0
  777. data/spec/models/notification_paged_metadata_spec.rb +89 -0
  778. data/spec/models/notification_spec.rb +183 -0
  779. data/spec/models/organization_paged_metadata_spec.rb +89 -0
  780. data/spec/models/organization_spec.rb +131 -0
  781. data/spec/models/password_paged_metadata_spec.rb +89 -0
  782. data/spec/models/password_reset_request_spec.rb +53 -0
  783. data/spec/models/password_spec.rb +89 -0
  784. data/spec/models/pause_request_spec.rb +59 -0
  785. data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
  786. data/spec/models/payment_method_spec.rb +205 -0
  787. data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
  788. data/spec/models/payment_method_subscription_link_spec.rb +107 -0
  789. data/spec/models/payment_paged_metadata_spec.rb +89 -0
  790. data/spec/models/payment_retry_request_spec.rb +59 -0
  791. data/spec/models/payment_spec.rb +157 -0
  792. data/spec/models/pending_component_value_change_spec.rb +71 -0
  793. data/spec/models/period_paged_metadata_spec.rb +89 -0
  794. data/spec/models/period_spec.rb +109 -0
  795. data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
  796. data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
  797. data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
  798. data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
  799. data/spec/models/pricing_component_migration_value_spec.rb +77 -0
  800. data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
  801. data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
  802. data/spec/models/pricing_component_spec.rb +221 -0
  803. data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
  804. data/spec/models/pricing_component_tier_spec.rb +123 -0
  805. data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
  806. data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
  807. data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
  808. data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
  809. data/spec/models/pricing_component_value_request_spec.rb +85 -0
  810. data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
  811. data/spec/models/pricing_component_value_spec.rb +125 -0
  812. data/spec/models/product_coupon_modifier_spec.rb +149 -0
  813. data/spec/models/product_paged_metadata_spec.rb +89 -0
  814. data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
  815. data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
  816. data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
  817. data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
  818. data/spec/models/product_rate_plan_spec.rb +275 -0
  819. data/spec/models/product_spec.rb +167 -0
  820. data/spec/models/profile_paged_metadata_spec.rb +89 -0
  821. data/spec/models/profile_spec.rb +155 -0
  822. data/spec/models/quote_request_spec.rb +161 -0
  823. data/spec/models/quote_request_value_spec.rb +71 -0
  824. data/spec/models/recalculate_charge_request_spec.rb +103 -0
  825. data/spec/models/receipt_paged_metadata_spec.rb +89 -0
  826. data/spec/models/receipt_spec.rb +237 -0
  827. data/spec/models/refund_paged_metadata_spec.rb +89 -0
  828. data/spec/models/refund_spec.rb +227 -0
  829. data/spec/models/resume_request_spec.rb +65 -0
  830. data/spec/models/resume_subscription_amendment_spec.rb +131 -0
  831. data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
  832. data/spec/models/revenue_attribution_spec.rb +191 -0
  833. data/spec/models/revive_subscription_request_spec.rb +53 -0
  834. data/spec/models/role_paged_metadata_spec.rb +89 -0
  835. data/spec/models/role_spec.rb +119 -0
  836. data/spec/models/rule_satisfaction_spec.rb +71 -0
  837. data/spec/models/search_result_paged_metadata_spec.rb +89 -0
  838. data/spec/models/service_end_amendment_spec.rb +131 -0
  839. data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
  840. data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
  841. data/spec/models/stripe_object_spec.rb +47 -0
  842. data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
  843. data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
  844. data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
  845. data/spec/models/subscription_charge_spec.rb +217 -0
  846. data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
  847. data/spec/models/subscription_paged_metadata_spec.rb +89 -0
  848. data/spec/models/subscription_spec.rb +303 -0
  849. data/spec/models/swagger_type_list_inv_spec.rb +53 -0
  850. data/spec/models/swagger_type_list_spec.rb +59 -0
  851. data/spec/models/swagger_type_list_subs_spec.rb +59 -0
  852. data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
  853. data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
  854. data/spec/models/tiered_pricing_component_spec.rb +221 -0
  855. data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
  856. data/spec/models/time_request_spec.rb +105 -0
  857. data/spec/models/time_response_paged_metadata_spec.rb +89 -0
  858. data/spec/models/time_response_spec.rb +117 -0
  859. data/spec/models/time_zone_spec.rb +71 -0
  860. data/spec/models/timer_amendment_spec.rb +189 -0
  861. data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
  862. data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
  863. data/spec/models/unit_discount_spec.rb +71 -0
  864. data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
  865. data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
  866. data/spec/models/unit_of_measure_spec.rb +101 -0
  867. data/spec/models/update_address_request_spec.rb +113 -0
  868. data/spec/models/update_component_value_amendment_spec.rb +155 -0
  869. data/spec/models/update_profile_request_spec.rb +137 -0
  870. data/spec/models/update_role_request_spec.rb +83 -0
  871. data/spec/models/update_subscription_request_spec.rb +109 -0
  872. data/spec/models/usage_paged_metadata_spec.rb +89 -0
  873. data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
  874. data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
  875. data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
  876. data/spec/models/usage_session_spec.rb +135 -0
  877. data/spec/models/usage_spec.rb +165 -0
  878. data/spec/models/user_creation_request_spec.rb +107 -0
  879. data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
  880. data/spec/models/user_paged_metadata_spec.rb +89 -0
  881. data/spec/models/user_spec.rb +131 -0
  882. data/spec/models/username_paged_metadata_spec.rb +89 -0
  883. data/spec/models/username_spec.rb +83 -0
  884. data/spec/models/webhook_paged_metadata_spec.rb +89 -0
  885. data/spec/spec_helper.rb +122 -0
  886. metadata +1401 -0
@@ -0,0 +1,364 @@
1
+ =begin
2
+ #BillForward REST API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require "uri"
25
+
26
+ module BillForward
27
+ class EmailsubscriptionsApi
28
+ attr_accessor :api_client
29
+
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
32
+ end
33
+
34
+ # Create an email subscription.
35
+ # {\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"}
36
+ # @param request .
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [EmailSubscriptionPagedMetadata]
39
+ def create_email_subscription(request, opts = {})
40
+ data, _status_code, _headers = create_email_subscription_with_http_info(request, opts)
41
+ return data
42
+ end
43
+
44
+ # Create an email subscription.
45
+ # {\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"}
46
+ # @param request .
47
+ # @param [Hash] opts the optional parameters
48
+ # @return [Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>] EmailSubscriptionPagedMetadata data, response status code and response headers
49
+ def create_email_subscription_with_http_info(request, opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.create_email_subscription ..."
52
+ end
53
+ # verify the required parameter 'request' is set
54
+ fail ArgumentError, "Missing the required parameter 'request' when calling EmailsubscriptionsApi.create_email_subscription" if request.nil?
55
+ # resource path
56
+ local_var_path = "/email-subscriptions".sub('{format}','json')
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = @api_client.object_to_http_body(request)
77
+ auth_names = []
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'EmailSubscriptionPagedMetadata')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: EmailsubscriptionsApi#create_email_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
91
+ # Unsubscribe from the email specified by the type parameter.
92
+ # { \"nickname\" : \"Unsubscribe\",\"response\" : \"unsubscribeEmail.html\"}
93
+ # @param type
94
+ # @param [Hash] opts the optional parameters
95
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
96
+ # @return [EmailSubscriptionPagedMetadata]
97
+ def delete_email_subscription_by_type(type, opts = {})
98
+ data, _status_code, _headers = delete_email_subscription_by_type_with_http_info(type, opts)
99
+ return data
100
+ end
101
+
102
+ # Unsubscribe from the email specified by the type parameter.
103
+ # { \&quot;nickname\&quot; : \&quot;Unsubscribe\&quot;,\&quot;response\&quot; : \&quot;unsubscribeEmail.html\&quot;}
104
+ # @param type
105
+ # @param [Hash] opts the optional parameters
106
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
107
+ # @return [Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>] EmailSubscriptionPagedMetadata data, response status code and response headers
108
+ def delete_email_subscription_by_type_with_http_info(type, opts = {})
109
+ if @api_client.config.debugging
110
+ @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.delete_email_subscription_by_type ..."
111
+ end
112
+ # verify the required parameter 'type' is set
113
+ fail ArgumentError, "Missing the required parameter 'type' when calling EmailsubscriptionsApi.delete_email_subscription_by_type" if type.nil?
114
+ # verify enum value
115
+ unless ['FailedPayment', 'InvoicePaid', 'SubscriptionCancellation', 'SubscriptionCancelled', 'SubscriptionPlanMigrated', 'SubscriptionPlanMigrating', 'CardExpired', 'CardExpiring'].include?(type)
116
+ fail ArgumentError, "invalid value for 'type', must be one of FailedPayment, InvoicePaid, SubscriptionCancellation, SubscriptionCancelled, SubscriptionPlanMigrated, SubscriptionPlanMigrating, CardExpired, CardExpiring"
117
+ end
118
+ # resource path
119
+ local_var_path = "/email-subscriptions/type={type}".sub('{format}','json').sub('{' + 'type' + '}', type.to_s)
120
+
121
+ # query parameters
122
+ query_params = {}
123
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
124
+
125
+ # header parameters
126
+ header_params = {}
127
+
128
+ # HTTP header 'Accept' (if needed)
129
+ local_header_accept = ['application/json', 'text/xml']
130
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
131
+
132
+ # HTTP header 'Content-Type'
133
+ local_header_content_type = ['text/plain']
134
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
135
+
136
+ # form parameters
137
+ form_params = {}
138
+
139
+ # http body (model)
140
+ post_body = nil
141
+ auth_names = []
142
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => 'EmailSubscriptionPagedMetadata')
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "API called: EmailsubscriptionsApi#delete_email_subscription_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
+ end
152
+ return data, status_code, headers
153
+ end
154
+
155
+ # Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order.
156
+ # {\"nickname\":\"Get all email subscriptions\",\"response\":\"getEmailSubscriptionsAll.html\"}
157
+ # @param state Constrains search to Email Subscriptions of a specific state.
158
+ # @param type Constrains search to Email Subscriptions of a specific type
159
+ # @param [Hash] opts the optional parameters
160
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
161
+ # @option opts [Integer] :offset The offset from the first email-subscription to return. (default to 0)
162
+ # @option opts [Integer] :records The maximum number of email-subscription to return. (default to 10)
163
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
164
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
165
+ # @return [EmailSubscriptionPagedMetadata]
166
+ def get_all_email_subscriptions(state, type, opts = {})
167
+ data, _status_code, _headers = get_all_email_subscriptions_with_http_info(state, type, opts)
168
+ return data
169
+ end
170
+
171
+ # Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order.
172
+ # {\&quot;nickname\&quot;:\&quot;Get all email subscriptions\&quot;,\&quot;response\&quot;:\&quot;getEmailSubscriptionsAll.html\&quot;}
173
+ # @param state Constrains search to Email Subscriptions of a specific state.
174
+ # @param type Constrains search to Email Subscriptions of a specific type
175
+ # @param [Hash] opts the optional parameters
176
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
177
+ # @option opts [Integer] :offset The offset from the first email-subscription to return.
178
+ # @option opts [Integer] :records The maximum number of email-subscription to return.
179
+ # @option opts [String] :order_by Specify a field used to order the result set.
180
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
181
+ # @return [Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>] EmailSubscriptionPagedMetadata data, response status code and response headers
182
+ def get_all_email_subscriptions_with_http_info(state, type, opts = {})
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.get_all_email_subscriptions ..."
185
+ end
186
+ # verify the required parameter 'state' is set
187
+ fail ArgumentError, "Missing the required parameter 'state' when calling EmailsubscriptionsApi.get_all_email_subscriptions" if state.nil?
188
+ # verify enum value
189
+ unless ['Active', 'Disabled'].include?(state)
190
+ fail ArgumentError, "invalid value for 'state', must be one of Active, Disabled"
191
+ end
192
+ # verify the required parameter 'type' is set
193
+ fail ArgumentError, "Missing the required parameter 'type' when calling EmailsubscriptionsApi.get_all_email_subscriptions" if type.nil?
194
+ # verify enum value
195
+ unless ['FailedPayment', 'InvoicePaid', 'SubscriptionCancellation', 'SubscriptionCancelled', 'SubscriptionPlanMigrated', 'SubscriptionPlanMigrating', 'CardExpired', 'CardExpiring'].include?(type)
196
+ fail ArgumentError, "invalid value for 'type', must be one of FailedPayment, InvoicePaid, SubscriptionCancellation, SubscriptionCancelled, SubscriptionPlanMigrated, SubscriptionPlanMigrating, CardExpired, CardExpiring"
197
+ end
198
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
199
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
200
+ end
201
+ # resource path
202
+ local_var_path = "/email-subscriptions".sub('{format}','json')
203
+
204
+ # query parameters
205
+ query_params = {}
206
+ query_params[:'state'] = state
207
+ query_params[:'type'] = type
208
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
209
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
210
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
211
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
212
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
213
+
214
+ # header parameters
215
+ header_params = {}
216
+
217
+ # HTTP header 'Accept' (if needed)
218
+ local_header_accept = ['application/json']
219
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
220
+
221
+ # HTTP header 'Content-Type'
222
+ local_header_content_type = []
223
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
224
+
225
+ # form parameters
226
+ form_params = {}
227
+
228
+ # http body (model)
229
+ post_body = nil
230
+ auth_names = []
231
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
232
+ :header_params => header_params,
233
+ :query_params => query_params,
234
+ :form_params => form_params,
235
+ :body => post_body,
236
+ :auth_names => auth_names,
237
+ :return_type => 'EmailSubscriptionPagedMetadata')
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: EmailsubscriptionsApi#get_all_email_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
244
+ # Retrieves a single email subscription, specified by ID.
245
+ # { \"nickname\" : \"Retrieve by ID\",\"response\" : \"getEmailSubscriptionByID.html\"}
246
+ # @param email_subscription_id
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
249
+ # @option opts [BOOLEAN] :include_retired Include deleted email-subscriptions (default to false)
250
+ # @return [EmailSubscriptionPagedMetadata]
251
+ def get_email_subscription_by_id(email_subscription_id, opts = {})
252
+ data, _status_code, _headers = get_email_subscription_by_id_with_http_info(email_subscription_id, opts)
253
+ return data
254
+ end
255
+
256
+ # Retrieves a single email subscription, specified by ID.
257
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by ID\&quot;,\&quot;response\&quot; : \&quot;getEmailSubscriptionByID.html\&quot;}
258
+ # @param email_subscription_id
259
+ # @param [Hash] opts the optional parameters
260
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
261
+ # @option opts [BOOLEAN] :include_retired Include deleted email-subscriptions
262
+ # @return [Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>] EmailSubscriptionPagedMetadata data, response status code and response headers
263
+ def get_email_subscription_by_id_with_http_info(email_subscription_id, opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.get_email_subscription_by_id ..."
266
+ end
267
+ # verify the required parameter 'email_subscription_id' is set
268
+ fail ArgumentError, "Missing the required parameter 'email_subscription_id' when calling EmailsubscriptionsApi.get_email_subscription_by_id" if email_subscription_id.nil?
269
+ # resource path
270
+ local_var_path = "/email-subscriptions/{email-subscription-id}".sub('{format}','json').sub('{' + 'email-subscription-id' + '}', email_subscription_id.to_s)
271
+
272
+ # query parameters
273
+ query_params = {}
274
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
275
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
276
+
277
+ # header parameters
278
+ header_params = {}
279
+
280
+ # HTTP header 'Accept' (if needed)
281
+ local_header_accept = ['application/json']
282
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
283
+
284
+ # HTTP header 'Content-Type'
285
+ local_header_content_type = ['text/plain']
286
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
287
+
288
+ # form parameters
289
+ form_params = {}
290
+
291
+ # http body (model)
292
+ post_body = nil
293
+ auth_names = []
294
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
295
+ :header_params => header_params,
296
+ :query_params => query_params,
297
+ :form_params => form_params,
298
+ :body => post_body,
299
+ :auth_names => auth_names,
300
+ :return_type => 'EmailSubscriptionPagedMetadata')
301
+ if @api_client.config.debugging
302
+ @api_client.config.logger.debug "API called: EmailsubscriptionsApi#get_email_subscription_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
+ end
304
+ return data, status_code, headers
305
+ end
306
+
307
+ # Update an email subscription.
308
+ # {\"nickname\":\"Update EmailSubscription\",\"request\":\"updateEmailSubscriptionRequest.html\",\"response\":\"updateEmailSubscriptionResponse.html\"}
309
+ # @param request .
310
+ # @param [Hash] opts the optional parameters
311
+ # @return [EmailSubscriptionPagedMetadata]
312
+ def update_email_subscription(request, opts = {})
313
+ data, _status_code, _headers = update_email_subscription_with_http_info(request, opts)
314
+ return data
315
+ end
316
+
317
+ # Update an email subscription.
318
+ # {\&quot;nickname\&quot;:\&quot;Update EmailSubscription\&quot;,\&quot;request\&quot;:\&quot;updateEmailSubscriptionRequest.html\&quot;,\&quot;response\&quot;:\&quot;updateEmailSubscriptionResponse.html\&quot;}
319
+ # @param request .
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>] EmailSubscriptionPagedMetadata data, response status code and response headers
322
+ def update_email_subscription_with_http_info(request, opts = {})
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.update_email_subscription ..."
325
+ end
326
+ # verify the required parameter 'request' is set
327
+ fail ArgumentError, "Missing the required parameter 'request' when calling EmailsubscriptionsApi.update_email_subscription" if request.nil?
328
+ # resource path
329
+ local_var_path = "/email-subscriptions".sub('{format}','json')
330
+
331
+ # query parameters
332
+ query_params = {}
333
+
334
+ # header parameters
335
+ header_params = {}
336
+
337
+ # HTTP header 'Accept' (if needed)
338
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
339
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
340
+
341
+ # HTTP header 'Content-Type'
342
+ local_header_content_type = ['application/json']
343
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
344
+
345
+ # form parameters
346
+ form_params = {}
347
+
348
+ # http body (model)
349
+ post_body = @api_client.object_to_http_body(request)
350
+ auth_names = []
351
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
352
+ :header_params => header_params,
353
+ :query_params => query_params,
354
+ :form_params => form_params,
355
+ :body => post_body,
356
+ :auth_names => auth_names,
357
+ :return_type => 'EmailSubscriptionPagedMetadata')
358
+ if @api_client.config.debugging
359
+ @api_client.config.logger.debug "API called: EmailsubscriptionsApi#update_email_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
360
+ end
361
+ return data, status_code, headers
362
+ end
363
+ end
364
+ end
@@ -0,0 +1,148 @@
1
+ =begin
2
+ #BillForward REST API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require "uri"
25
+
26
+ module BillForward
27
+ class FixedtermdefinitionsApi
28
+ attr_accessor :api_client
29
+
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
32
+ end
33
+
34
+ # Create
35
+ # {\"nickname\":\"Create a new fixed term definition\",\"request\":\"createFixedTermDefinitionRequest.html\",\"response\":\"createFixedTermDefinitionResponse.html\"}
36
+ # @param fixed_term_definiton The fixed-term-definition object to be updated.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [FixedTermDefinitionPagedMetadata]
39
+ def create_fixed_term_definition(fixed_term_definiton, opts = {})
40
+ data, _status_code, _headers = create_fixed_term_definition_with_http_info(fixed_term_definiton, opts)
41
+ return data
42
+ end
43
+
44
+ # Create
45
+ # {\&quot;nickname\&quot;:\&quot;Create a new fixed term definition\&quot;,\&quot;request\&quot;:\&quot;createFixedTermDefinitionRequest.html\&quot;,\&quot;response\&quot;:\&quot;createFixedTermDefinitionResponse.html\&quot;}
46
+ # @param fixed_term_definiton The fixed-term-definition object to be updated.
47
+ # @param [Hash] opts the optional parameters
48
+ # @return [Array<(FixedTermDefinitionPagedMetadata, Fixnum, Hash)>] FixedTermDefinitionPagedMetadata data, response status code and response headers
49
+ def create_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug "Calling API: FixedtermdefinitionsApi.create_fixed_term_definition ..."
52
+ end
53
+ # verify the required parameter 'fixed_term_definiton' is set
54
+ fail ArgumentError, "Missing the required parameter 'fixed_term_definiton' when calling FixedtermdefinitionsApi.create_fixed_term_definition" if fixed_term_definiton.nil?
55
+ # resource path
56
+ local_var_path = "/fixed-term-definitions".sub('{format}','json')
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = @api_client.object_to_http_body(fixed_term_definiton)
77
+ auth_names = []
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'FixedTermDefinitionPagedMetadata')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: FixedtermdefinitionsApi#create_fixed_term_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
91
+ # Update
92
+ # {\"nickname\":\"Update a fixed-term definition\",\"request\":\"updateFixedTermDefinitionRequest.html\",\"response\":\"updateFixedTermDefinitionResponse.html\"}
93
+ # @param fixed_term_definiton The fixed-term-definition object to be updated.
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [FixedTermDefinitionPagedMetadata]
96
+ def update_fixed_term_definition(fixed_term_definiton, opts = {})
97
+ data, _status_code, _headers = update_fixed_term_definition_with_http_info(fixed_term_definiton, opts)
98
+ return data
99
+ end
100
+
101
+ # Update
102
+ # {\&quot;nickname\&quot;:\&quot;Update a fixed-term definition\&quot;,\&quot;request\&quot;:\&quot;updateFixedTermDefinitionRequest.html\&quot;,\&quot;response\&quot;:\&quot;updateFixedTermDefinitionResponse.html\&quot;}
103
+ # @param fixed_term_definiton The fixed-term-definition object to be updated.
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [Array<(FixedTermDefinitionPagedMetadata, Fixnum, Hash)>] FixedTermDefinitionPagedMetadata data, response status code and response headers
106
+ def update_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {})
107
+ if @api_client.config.debugging
108
+ @api_client.config.logger.debug "Calling API: FixedtermdefinitionsApi.update_fixed_term_definition ..."
109
+ end
110
+ # verify the required parameter 'fixed_term_definiton' is set
111
+ fail ArgumentError, "Missing the required parameter 'fixed_term_definiton' when calling FixedtermdefinitionsApi.update_fixed_term_definition" if fixed_term_definiton.nil?
112
+ # resource path
113
+ local_var_path = "/fixed-term-definitions".sub('{format}','json')
114
+
115
+ # query parameters
116
+ query_params = {}
117
+
118
+ # header parameters
119
+ header_params = {}
120
+
121
+ # HTTP header 'Accept' (if needed)
122
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
123
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
124
+
125
+ # HTTP header 'Content-Type'
126
+ local_header_content_type = ['application/json']
127
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
128
+
129
+ # form parameters
130
+ form_params = {}
131
+
132
+ # http body (model)
133
+ post_body = @api_client.object_to_http_body(fixed_term_definiton)
134
+ auth_names = []
135
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
136
+ :header_params => header_params,
137
+ :query_params => query_params,
138
+ :form_params => form_params,
139
+ :body => post_body,
140
+ :auth_names => auth_names,
141
+ :return_type => 'FixedTermDefinitionPagedMetadata')
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: FixedtermdefinitionsApi#update_fixed_term_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+ end
148
+ end
@@ -0,0 +1,91 @@
1
+ =begin
2
+ #BillForward REST API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require "uri"
25
+
26
+ module BillForward
27
+ class FixedtermsApi
28
+ attr_accessor :api_client
29
+
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
32
+ end
33
+
34
+ # Update
35
+ # {\"nickname\":\"Update a fixed term\",\"request\":\"updateFixedTermRequest.html\",\"response\":\"updateFixedTermResponse.html\"}
36
+ # @param payment_method The payment-method object to be updated.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [FixedTermPagedMetadata]
39
+ def update_fixed_term(payment_method, opts = {})
40
+ data, _status_code, _headers = update_fixed_term_with_http_info(payment_method, opts)
41
+ return data
42
+ end
43
+
44
+ # Update
45
+ # {\&quot;nickname\&quot;:\&quot;Update a fixed term\&quot;,\&quot;request\&quot;:\&quot;updateFixedTermRequest.html\&quot;,\&quot;response\&quot;:\&quot;updateFixedTermResponse.html\&quot;}
46
+ # @param payment_method The payment-method object to be updated.
47
+ # @param [Hash] opts the optional parameters
48
+ # @return [Array<(FixedTermPagedMetadata, Fixnum, Hash)>] FixedTermPagedMetadata data, response status code and response headers
49
+ def update_fixed_term_with_http_info(payment_method, opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug "Calling API: FixedtermsApi.update_fixed_term ..."
52
+ end
53
+ # verify the required parameter 'payment_method' is set
54
+ fail ArgumentError, "Missing the required parameter 'payment_method' when calling FixedtermsApi.update_fixed_term" if payment_method.nil?
55
+ # resource path
56
+ local_var_path = "/fixed-terms".sub('{format}','json')
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = @api_client.object_to_http_body(payment_method)
77
+ auth_names = []
78
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'FixedTermPagedMetadata')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: FixedtermsApi#update_fixed_term\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+ end
91
+ end