bf_ruby2 1.2016.229

Sign up to get free protection for your applications and to get access to all the features.
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,3066 @@
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 InvoicesApi
28
+ attr_accessor :api_client
29
+
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
32
+ end
33
+
34
+ # Creates a charge on the specified invoice.
35
+ # {\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"}
36
+ # @param invoice_id ID of the invoice.
37
+ # @param charge The charge request
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [SubscriptionChargePagedMetadata]
40
+ def add_charge_to_invoice(invoice_id, charge, opts = {})
41
+ data, _status_code, _headers = add_charge_to_invoice_with_http_info(invoice_id, charge, opts)
42
+ return data
43
+ end
44
+
45
+ # Creates a charge on the specified invoice.
46
+ # {\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"}
47
+ # @param invoice_id ID of the invoice.
48
+ # @param charge The charge request
49
+ # @param [Hash] opts the optional parameters
50
+ # @return [Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>] SubscriptionChargePagedMetadata data, response status code and response headers
51
+ def add_charge_to_invoice_with_http_info(invoice_id, charge, opts = {})
52
+ if @api_client.config.debugging
53
+ @api_client.config.logger.debug "Calling API: InvoicesApi.add_charge_to_invoice ..."
54
+ end
55
+ # verify the required parameter 'invoice_id' is set
56
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.add_charge_to_invoice" if invoice_id.nil?
57
+ # verify the required parameter 'charge' is set
58
+ fail ArgumentError, "Missing the required parameter 'charge' when calling InvoicesApi.add_charge_to_invoice" if charge.nil?
59
+ # resource path
60
+ local_var_path = "/invoices/{invoice-ID}/charges".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
61
+
62
+ # query parameters
63
+ query_params = {}
64
+
65
+ # header parameters
66
+ header_params = {}
67
+
68
+ # HTTP header 'Accept' (if needed)
69
+ local_header_accept = ['application/json']
70
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
71
+
72
+ # HTTP header 'Content-Type'
73
+ local_header_content_type = ['application/json']
74
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
75
+
76
+ # form parameters
77
+ form_params = {}
78
+
79
+ # http body (model)
80
+ post_body = @api_client.object_to_http_body(charge)
81
+ auth_names = []
82
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
83
+ :header_params => header_params,
84
+ :query_params => query_params,
85
+ :form_params => form_params,
86
+ :body => post_body,
87
+ :auth_names => auth_names,
88
+ :return_type => 'SubscriptionChargePagedMetadata')
89
+ if @api_client.config.debugging
90
+ @api_client.config.logger.debug "API called: InvoicesApi#add_charge_to_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
91
+ end
92
+ return data, status_code, headers
93
+ end
94
+
95
+ # Aggregate Invoices into to one parent Invoice
96
+ # {\"nickname\":\"Aggregate invoices\",\"response\":\"AggregateResponse.html\",\"request\":\"AggregateRequest.html\"}
97
+ # @param request
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [InvoicePagedMetadata]
100
+ def aggregate_invoices(request, opts = {})
101
+ data, _status_code, _headers = aggregate_invoices_with_http_info(request, opts)
102
+ return data
103
+ end
104
+
105
+ # Aggregate Invoices into to one parent Invoice
106
+ # {\&quot;nickname\&quot;:\&quot;Aggregate invoices\&quot;,\&quot;response\&quot;:\&quot;AggregateResponse.html\&quot;,\&quot;request\&quot;:\&quot;AggregateRequest.html\&quot;}
107
+ # @param request
108
+ # @param [Hash] opts the optional parameters
109
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
110
+ def aggregate_invoices_with_http_info(request, opts = {})
111
+ if @api_client.config.debugging
112
+ @api_client.config.logger.debug "Calling API: InvoicesApi.aggregate_invoices ..."
113
+ end
114
+ # verify the required parameter 'request' is set
115
+ fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.aggregate_invoices" if request.nil?
116
+ # resource path
117
+ local_var_path = "/invoices/aggregate".sub('{format}','json')
118
+
119
+ # query parameters
120
+ query_params = {}
121
+
122
+ # header parameters
123
+ header_params = {}
124
+
125
+ # HTTP header 'Accept' (if needed)
126
+ local_header_accept = ['application/json']
127
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
128
+
129
+ # HTTP header 'Content-Type'
130
+ local_header_content_type = ['application/json']
131
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
132
+
133
+ # form parameters
134
+ form_params = {}
135
+
136
+ # http body (model)
137
+ post_body = @api_client.object_to_http_body(request)
138
+ auth_names = []
139
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names,
145
+ :return_type => 'InvoicePagedMetadata')
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: InvoicesApi#aggregate_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
151
+
152
+ # Attempt payment for the outstanding value of an invoice
153
+ # {\"nickname\":\"Execute invoice\",\"response\":\"executeInvoiceResponse.html\",\"request\":\"ExecuteInvoiceRequest.html\"}
154
+ # @param invoice_id
155
+ # @param request
156
+ # @param [Hash] opts the optional parameters
157
+ # @return [InvoicePagedMetadata]
158
+ def execute_invoice(invoice_id, request, opts = {})
159
+ data, _status_code, _headers = execute_invoice_with_http_info(invoice_id, request, opts)
160
+ return data
161
+ end
162
+
163
+ # Attempt payment for the outstanding value of an invoice
164
+ # {\&quot;nickname\&quot;:\&quot;Execute invoice\&quot;,\&quot;response\&quot;:\&quot;executeInvoiceResponse.html\&quot;,\&quot;request\&quot;:\&quot;ExecuteInvoiceRequest.html\&quot;}
165
+ # @param invoice_id
166
+ # @param request
167
+ # @param [Hash] opts the optional parameters
168
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
169
+ def execute_invoice_with_http_info(invoice_id, request, opts = {})
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug "Calling API: InvoicesApi.execute_invoice ..."
172
+ end
173
+ # verify the required parameter 'invoice_id' is set
174
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.execute_invoice" if invoice_id.nil?
175
+ # verify the required parameter 'request' is set
176
+ fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.execute_invoice" if request.nil?
177
+ # resource path
178
+ local_var_path = "/invoices/{invoice-ID}/execute".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
179
+
180
+ # query parameters
181
+ query_params = {}
182
+
183
+ # header parameters
184
+ header_params = {}
185
+
186
+ # HTTP header 'Accept' (if needed)
187
+ local_header_accept = ['application/json']
188
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
189
+
190
+ # HTTP header 'Content-Type'
191
+ local_header_content_type = ['application/json']
192
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
193
+
194
+ # form parameters
195
+ form_params = {}
196
+
197
+ # http body (model)
198
+ post_body = @api_client.object_to_http_body(request)
199
+ auth_names = []
200
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
201
+ :header_params => header_params,
202
+ :query_params => query_params,
203
+ :form_params => form_params,
204
+ :body => post_body,
205
+ :auth_names => auth_names,
206
+ :return_type => 'InvoicePagedMetadata')
207
+ if @api_client.config.debugging
208
+ @api_client.config.logger.debug "API called: InvoicesApi#execute_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
209
+ end
210
+ return data, status_code, headers
211
+ end
212
+
213
+ # Generates InvoiceLinePayments for all existing InvoicePayments.
214
+ # { \"nickname\" : \"Generate InvoiceLinePayments\",\"response\" : \"Generate InvoiceLinePayments.html\"}
215
+ # @param [Hash] opts the optional parameters
216
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
217
+ # @return [InvoiceLinePaymentPagedMetadata]
218
+ def generate_line_payments_for_all_invoices(opts = {})
219
+ data, _status_code, _headers = generate_line_payments_for_all_invoices_with_http_info(opts)
220
+ return data
221
+ end
222
+
223
+ # Generates InvoiceLinePayments for all existing InvoicePayments.
224
+ # { \&quot;nickname\&quot; : \&quot;Generate InvoiceLinePayments\&quot;,\&quot;response\&quot; : \&quot;Generate InvoiceLinePayments.html\&quot;}
225
+ # @param [Hash] opts the optional parameters
226
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
227
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
228
+ def generate_line_payments_for_all_invoices_with_http_info(opts = {})
229
+ if @api_client.config.debugging
230
+ @api_client.config.logger.debug "Calling API: InvoicesApi.generate_line_payments_for_all_invoices ..."
231
+ end
232
+ # resource path
233
+ local_var_path = "/invoices/generate-line-payments".sub('{format}','json')
234
+
235
+ # query parameters
236
+ query_params = {}
237
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
238
+
239
+ # header parameters
240
+ header_params = {}
241
+
242
+ # HTTP header 'Accept' (if needed)
243
+ local_header_accept = ['application/json']
244
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
245
+
246
+ # HTTP header 'Content-Type'
247
+ local_header_content_type = ['application/json']
248
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
249
+
250
+ # form parameters
251
+ form_params = {}
252
+
253
+ # http body (model)
254
+ post_body = nil
255
+ auth_names = []
256
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
257
+ :header_params => header_params,
258
+ :query_params => query_params,
259
+ :form_params => form_params,
260
+ :body => post_body,
261
+ :auth_names => auth_names,
262
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
263
+ if @api_client.config.debugging
264
+ @api_client.config.logger.debug "API called: InvoicesApi#generate_line_payments_for_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
265
+ end
266
+ return data, status_code, headers
267
+ end
268
+
269
+ # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
270
+ # { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.html\"}
271
+ # @param [Hash] opts the optional parameters
272
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
273
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
274
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
275
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
276
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
277
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
278
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded. (default to true)
279
+ # @option opts [String] :metadata
280
+ # @return [InvoicePagedMetadata]
281
+ def get_all_invoices(opts = {})
282
+ data, _status_code, _headers = get_all_invoices_with_http_info(opts)
283
+ return data
284
+ end
285
+
286
+ # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
287
+ # { \&quot;nickname\&quot; : \&quot;Retrieve all invoices\&quot;,\&quot;response\&quot; : \&quot;getInvoiceAll.html\&quot;}
288
+ # @param [Hash] opts the optional parameters
289
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
290
+ # @option opts [Integer] :offset The offset from the first invoice to return.
291
+ # @option opts [Integer] :records The maximum number of invoices to return.
292
+ # @option opts [String] :order_by Specify a field used to order the result set.
293
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
294
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
295
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded.
296
+ # @option opts [String] :metadata
297
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
298
+ def get_all_invoices_with_http_info(opts = {})
299
+ if @api_client.config.debugging
300
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_all_invoices ..."
301
+ end
302
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
303
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
304
+ end
305
+ # resource path
306
+ local_var_path = "/invoices".sub('{format}','json')
307
+
308
+ # query parameters
309
+ query_params = {}
310
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
311
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
312
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
313
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
314
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
315
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
316
+ query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
317
+ query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
318
+
319
+ # header parameters
320
+ header_params = {}
321
+
322
+ # HTTP header 'Accept' (if needed)
323
+ local_header_accept = ['application/json']
324
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
325
+
326
+ # HTTP header 'Content-Type'
327
+ local_header_content_type = ['text/plain', 'application/json']
328
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
329
+
330
+ # form parameters
331
+ form_params = {}
332
+
333
+ # http body (model)
334
+ post_body = nil
335
+ auth_names = []
336
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
337
+ :header_params => header_params,
338
+ :query_params => query_params,
339
+ :form_params => form_params,
340
+ :body => post_body,
341
+ :auth_names => auth_names,
342
+ :return_type => 'InvoicePagedMetadata')
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "API called: InvoicesApi#get_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
345
+ end
346
+ return data, status_code, headers
347
+ end
348
+
349
+ # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
350
+ # { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.csv\"}
351
+ # @param [Hash] opts the optional parameters
352
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
353
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
354
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
355
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
356
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
357
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
358
+ # @return [InvoicePagedMetadata]
359
+ def get_all_invoices_as_csv(opts = {})
360
+ data, _status_code, _headers = get_all_invoices_as_csv_with_http_info(opts)
361
+ return data
362
+ end
363
+
364
+ # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
365
+ # { \&quot;nickname\&quot; : \&quot;Retrieve all invoices\&quot;,\&quot;response\&quot; : \&quot;getInvoiceAll.csv\&quot;}
366
+ # @param [Hash] opts the optional parameters
367
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
368
+ # @option opts [Integer] :offset The offset from the first invoice to return.
369
+ # @option opts [Integer] :records The maximum number of invoices to return.
370
+ # @option opts [String] :order_by Specify a field used to order the result set.
371
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
372
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
373
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
374
+ def get_all_invoices_as_csv_with_http_info(opts = {})
375
+ if @api_client.config.debugging
376
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_all_invoices_as_csv ..."
377
+ end
378
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
379
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
380
+ end
381
+ # resource path
382
+ local_var_path = "/invoices/all.csv".sub('{format}','json')
383
+
384
+ # query parameters
385
+ query_params = {}
386
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
387
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
388
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
389
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
390
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
391
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
392
+
393
+ # header parameters
394
+ header_params = {}
395
+
396
+ # HTTP header 'Accept' (if needed)
397
+ local_header_accept = ['text/csv']
398
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
399
+
400
+ # HTTP header 'Content-Type'
401
+ local_header_content_type = ['text/plain', 'application/json']
402
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
403
+
404
+ # form parameters
405
+ form_params = {}
406
+
407
+ # http body (model)
408
+ post_body = nil
409
+ auth_names = []
410
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
411
+ :header_params => header_params,
412
+ :query_params => query_params,
413
+ :form_params => form_params,
414
+ :body => post_body,
415
+ :auth_names => auth_names,
416
+ :return_type => 'InvoicePagedMetadata')
417
+ if @api_client.config.debugging
418
+ @api_client.config.logger.debug "API called: InvoicesApi#get_all_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
419
+ end
420
+ return data, status_code, headers
421
+ end
422
+
423
+ # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
424
+ # { \"nickname\" : \"(CSV) Retrieve bucketed revenue attributions\",\"response\" : \"getBucketedRevenueAttributions.csv\"}
425
+ # @param [Hash] opts the optional parameters
426
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
427
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
428
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
429
+ # @return [String]
430
+ def get_bucketed_revenue_attributions_as_csv(opts = {})
431
+ data, _status_code, _headers = get_bucketed_revenue_attributions_as_csv_with_http_info(opts)
432
+ return data
433
+ end
434
+
435
+ # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
436
+ # { \&quot;nickname\&quot; : \&quot;(CSV) Retrieve bucketed revenue attributions\&quot;,\&quot;response\&quot; : \&quot;getBucketedRevenueAttributions.csv\&quot;}
437
+ # @param [Hash] opts the optional parameters
438
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
439
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
440
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
441
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
442
+ def get_bucketed_revenue_attributions_as_csv_with_http_info(opts = {})
443
+ if @api_client.config.debugging
444
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_bucketed_revenue_attributions_as_csv ..."
445
+ end
446
+ # resource path
447
+ local_var_path = "/invoices/bucketed-revenue-attributions.csv".sub('{format}','json')
448
+
449
+ # query parameters
450
+ query_params = {}
451
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
452
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
453
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
454
+
455
+ # header parameters
456
+ header_params = {}
457
+
458
+ # HTTP header 'Accept' (if needed)
459
+ local_header_accept = []
460
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
461
+
462
+ # HTTP header 'Content-Type'
463
+ local_header_content_type = []
464
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
465
+
466
+ # form parameters
467
+ form_params = {}
468
+
469
+ # http body (model)
470
+ post_body = nil
471
+ auth_names = []
472
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
473
+ :header_params => header_params,
474
+ :query_params => query_params,
475
+ :form_params => form_params,
476
+ :body => post_body,
477
+ :auth_names => auth_names,
478
+ :return_type => 'String')
479
+ if @api_client.config.debugging
480
+ @api_client.config.logger.debug "API called: InvoicesApi#get_bucketed_revenue_attributions_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
481
+ end
482
+ return data, status_code, headers
483
+ end
484
+
485
+ # Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
486
+ # {\"nickname\":\"List on invoice\",\"response\":\"getChargesInvoice.html\"}
487
+ # @param invoice_id
488
+ # @param [Hash] opts the optional parameters
489
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
490
+ # @option opts [Integer] :offset The offset from the first subscription to return. (default to 0)
491
+ # @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10)
492
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to id)
493
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
494
+ # @option opts [String] :state Ihe direction of any ordering, either ASC or DESC.
495
+ # @option opts [String] :type Ihe direction of any ordering, either ASC or DESC.
496
+ # @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false)
497
+ # @return [SubscriptionChargePagedMetadata]
498
+ def get_charges_on_invoice(invoice_id, opts = {})
499
+ data, _status_code, _headers = get_charges_on_invoice_with_http_info(invoice_id, opts)
500
+ return data
501
+ end
502
+
503
+ # Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
504
+ # {\&quot;nickname\&quot;:\&quot;List on invoice\&quot;,\&quot;response\&quot;:\&quot;getChargesInvoice.html\&quot;}
505
+ # @param invoice_id
506
+ # @param [Hash] opts the optional parameters
507
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
508
+ # @option opts [Integer] :offset The offset from the first subscription to return.
509
+ # @option opts [Integer] :records The maximum number of subscriptions to return.
510
+ # @option opts [String] :order_by Specify a field used to order the result set.
511
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
512
+ # @option opts [String] :state Ihe direction of any ordering, either ASC or DESC.
513
+ # @option opts [String] :type Ihe direction of any ordering, either ASC or DESC.
514
+ # @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned.
515
+ # @return [Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>] SubscriptionChargePagedMetadata data, response status code and response headers
516
+ def get_charges_on_invoice_with_http_info(invoice_id, opts = {})
517
+ if @api_client.config.debugging
518
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_charges_on_invoice ..."
519
+ end
520
+ # verify the required parameter 'invoice_id' is set
521
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_charges_on_invoice" if invoice_id.nil?
522
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
523
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
524
+ end
525
+ if opts[:'state'] && !['Voided', 'Pending', 'AwaitingPayment', 'Paid', 'Failed'].include?(opts[:'state'])
526
+ fail ArgumentError, 'invalid value for "state", must be one of Voided, Pending, AwaitingPayment, Paid, Failed'
527
+ end
528
+ if opts[:'type'] && !['Setup', 'Upgrade', 'Manual', 'ProductRatePlanMigration', 'Arrears', 'Advance', 'Coupon', 'Usage', 'PricingComponent'].include?(opts[:'type'])
529
+ fail ArgumentError, 'invalid value for "type", must be one of Setup, Upgrade, Manual, ProductRatePlanMigration, Arrears, Advance, Coupon, Usage, PricingComponent'
530
+ end
531
+ # resource path
532
+ local_var_path = "/invoices/{invoice-ID}/charges".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
533
+
534
+ # query parameters
535
+ query_params = {}
536
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
537
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
538
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
539
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
540
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
541
+ query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
542
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
543
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
544
+
545
+ # header parameters
546
+ header_params = {}
547
+
548
+ # HTTP header 'Accept' (if needed)
549
+ local_header_accept = ['application/json']
550
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
551
+
552
+ # HTTP header 'Content-Type'
553
+ local_header_content_type = ['text/plain', 'application/json']
554
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
555
+
556
+ # form parameters
557
+ form_params = {}
558
+
559
+ # http body (model)
560
+ post_body = nil
561
+ auth_names = []
562
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
563
+ :header_params => header_params,
564
+ :query_params => query_params,
565
+ :form_params => form_params,
566
+ :body => post_body,
567
+ :auth_names => auth_names,
568
+ :return_type => 'SubscriptionChargePagedMetadata')
569
+ if @api_client.config.debugging
570
+ @api_client.config.logger.debug "API called: InvoicesApi#get_charges_on_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
571
+ end
572
+ return data, status_code, headers
573
+ end
574
+
575
+ # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
576
+ # { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"}
577
+ # @param [Hash] opts the optional parameters
578
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
579
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
580
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
581
+ # @return [InvoiceLinePaymentPagedMetadata]
582
+ def get_credit_invoice_line_payments_from_invoices_as_csv(opts = {})
583
+ data, _status_code, _headers = get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
584
+ return data
585
+ end
586
+
587
+ # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
588
+ # { \&quot;nickname\&quot; : \&quot;Credit InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Credit InvoiceLinePayments.csv\&quot;}
589
+ # @param [Hash] opts the optional parameters
590
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
591
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
592
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
593
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
594
+ def get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
595
+ if @api_client.config.debugging
596
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_credit_invoice_line_payments_from_invoices_as_csv ..."
597
+ end
598
+ # resource path
599
+ local_var_path = "/invoices/credit.csv".sub('{format}','json')
600
+
601
+ # query parameters
602
+ query_params = {}
603
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
604
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
605
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
606
+
607
+ # header parameters
608
+ header_params = {}
609
+
610
+ # HTTP header 'Accept' (if needed)
611
+ local_header_accept = ['text/csv']
612
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
613
+
614
+ # HTTP header 'Content-Type'
615
+ local_header_content_type = ['text/plain', 'application/json']
616
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
617
+
618
+ # form parameters
619
+ form_params = {}
620
+
621
+ # http body (model)
622
+ post_body = nil
623
+ auth_names = []
624
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
625
+ :header_params => header_params,
626
+ :query_params => query_params,
627
+ :form_params => form_params,
628
+ :body => post_body,
629
+ :auth_names => auth_names,
630
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
631
+ if @api_client.config.debugging
632
+ @api_client.config.logger.debug "API called: InvoicesApi#get_credit_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
633
+ end
634
+ return data, status_code, headers
635
+ end
636
+
637
+ # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
638
+ # { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"}
639
+ # @param [Hash] opts the optional parameters
640
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
641
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
642
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
643
+ # @return [InvoiceLinePaymentPagedMetadata]
644
+ def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {})
645
+ data, _status_code, _headers = get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts)
646
+ return data
647
+ end
648
+
649
+ # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
650
+ # { \&quot;nickname\&quot; : \&quot;Credit InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Credit InvoiceLinePayments.csv\&quot;}
651
+ # @param [Hash] opts the optional parameters
652
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
653
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
654
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
655
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
656
+ def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {})
657
+ if @api_client.config.debugging
658
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received ..."
659
+ end
660
+ # resource path
661
+ local_var_path = "/invoices/payment-received/credit.csv".sub('{format}','json')
662
+
663
+ # query parameters
664
+ query_params = {}
665
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
666
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
667
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
668
+
669
+ # header parameters
670
+ header_params = {}
671
+
672
+ # HTTP header 'Accept' (if needed)
673
+ local_header_accept = ['text/csv']
674
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
675
+
676
+ # HTTP header 'Content-Type'
677
+ local_header_content_type = ['text/plain', 'application/json']
678
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
679
+
680
+ # form parameters
681
+ form_params = {}
682
+
683
+ # http body (model)
684
+ post_body = nil
685
+ auth_names = []
686
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
687
+ :header_params => header_params,
688
+ :query_params => query_params,
689
+ :form_params => form_params,
690
+ :body => post_body,
691
+ :auth_names => auth_names,
692
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
693
+ if @api_client.config.debugging
694
+ @api_client.config.logger.debug "API called: InvoicesApi#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
695
+ end
696
+ return data, status_code, headers
697
+ end
698
+
699
+ # Retrieves received revenue from InvoicePayments upon line items, in CSV format.
700
+ # { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"}
701
+ # @param [Hash] opts the optional parameters
702
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
703
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
704
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
705
+ # @return [InvoiceLinePaymentPagedMetadata]
706
+ def get_debit_invoice_line_payments_from_invoices_as_csv(opts = {})
707
+ data, _status_code, _headers = get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
708
+ return data
709
+ end
710
+
711
+ # Retrieves received revenue from InvoicePayments upon line items, in CSV format.
712
+ # { \&quot;nickname\&quot; : \&quot;Debit InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Debit InvoiceLinePayments.csv\&quot;}
713
+ # @param [Hash] opts the optional parameters
714
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
715
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
716
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
717
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
718
+ def get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
719
+ if @api_client.config.debugging
720
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_debit_invoice_line_payments_from_invoices_as_csv ..."
721
+ end
722
+ # resource path
723
+ local_var_path = "/invoices/revenue.csv".sub('{format}','json')
724
+
725
+ # query parameters
726
+ query_params = {}
727
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
728
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
729
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
730
+
731
+ # header parameters
732
+ header_params = {}
733
+
734
+ # HTTP header 'Accept' (if needed)
735
+ local_header_accept = ['text/csv']
736
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
737
+
738
+ # HTTP header 'Content-Type'
739
+ local_header_content_type = ['text/plain', 'application/json']
740
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
741
+
742
+ # form parameters
743
+ form_params = {}
744
+
745
+ # http body (model)
746
+ post_body = nil
747
+ auth_names = []
748
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
749
+ :header_params => header_params,
750
+ :query_params => query_params,
751
+ :form_params => form_params,
752
+ :body => post_body,
753
+ :auth_names => auth_names,
754
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
755
+ if @api_client.config.debugging
756
+ @api_client.config.logger.debug "API called: InvoicesApi#get_debit_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
757
+ end
758
+ return data, status_code, headers
759
+ end
760
+
761
+ # Retrieves received revenue from InvoicePayments upon line items, in CSV format.
762
+ # { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"}
763
+ # @param [Hash] opts the optional parameters
764
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
765
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
766
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
767
+ # @return [InvoiceLinePaymentPagedMetadata]
768
+ def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts = {})
769
+ data, _status_code, _headers = get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts)
770
+ return data
771
+ end
772
+
773
+ # Retrieves received revenue from InvoicePayments upon line items, in CSV format.
774
+ # { \&quot;nickname\&quot; : \&quot;Debit InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Debit InvoiceLinePayments.csv\&quot;}
775
+ # @param [Hash] opts the optional parameters
776
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
777
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
778
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
779
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
780
+ def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(opts = {})
781
+ if @api_client.config.debugging
782
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received ..."
783
+ end
784
+ # resource path
785
+ local_var_path = "/invoices/payment-received/revenue.csv".sub('{format}','json')
786
+
787
+ # query parameters
788
+ query_params = {}
789
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
790
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
791
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
792
+
793
+ # header parameters
794
+ header_params = {}
795
+
796
+ # HTTP header 'Accept' (if needed)
797
+ local_header_accept = ['text/csv']
798
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
799
+
800
+ # HTTP header 'Content-Type'
801
+ local_header_content_type = ['text/plain', 'application/json']
802
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
803
+
804
+ # form parameters
805
+ form_params = {}
806
+
807
+ # http body (model)
808
+ post_body = nil
809
+ auth_names = []
810
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
811
+ :header_params => header_params,
812
+ :query_params => query_params,
813
+ :form_params => form_params,
814
+ :body => post_body,
815
+ :auth_names => auth_names,
816
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
817
+ if @api_client.config.debugging
818
+ @api_client.config.logger.debug "API called: InvoicesApi#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
819
+ end
820
+ return data, status_code, headers
821
+ end
822
+
823
+ # Retrieves a single invoice specified by the ID parameter.
824
+ # { \"nickname\" : \"HTML invoice\",\"response\" : \"getInvoiceByID.HTML.html\"}
825
+ # @param id The ID of the invoice.
826
+ # @param [Hash] opts the optional parameters
827
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
828
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
829
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
830
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
831
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
832
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
833
+ # @option opts [BOOLEAN] :tier_breakdown Whether to provide a breakdown of charge tiering. (default to false)
834
+ # @option opts [BOOLEAN] :inclusive_end Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \&quot;period end\&quot; date shown to the customer. (default to false)
835
+ # @option opts [BOOLEAN] :show_zero_cost Whether to show zero-cost lines. (default to true)
836
+ # @option opts [BOOLEAN] :show_plan_only_when_ambiguous Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice. (default to true)
837
+ # @return [String]
838
+ def get_invoice_as_html(id, opts = {})
839
+ data, _status_code, _headers = get_invoice_as_html_with_http_info(id, opts)
840
+ return data
841
+ end
842
+
843
+ # Retrieves a single invoice specified by the ID parameter.
844
+ # { \&quot;nickname\&quot; : \&quot;HTML invoice\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByID.HTML.html\&quot;}
845
+ # @param id The ID of the invoice.
846
+ # @param [Hash] opts the optional parameters
847
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
848
+ # @option opts [Integer] :offset The offset from the first invoice to return.
849
+ # @option opts [Integer] :records The maximum number of invoices to return.
850
+ # @option opts [String] :order_by Specify a field used to order the result set.
851
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
852
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
853
+ # @option opts [BOOLEAN] :tier_breakdown Whether to provide a breakdown of charge tiering.
854
+ # @option opts [BOOLEAN] :inclusive_end Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \&quot;period end\&quot; date shown to the customer.
855
+ # @option opts [BOOLEAN] :show_zero_cost Whether to show zero-cost lines.
856
+ # @option opts [BOOLEAN] :show_plan_only_when_ambiguous Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice.
857
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
858
+ def get_invoice_as_html_with_http_info(id, opts = {})
859
+ if @api_client.config.debugging
860
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_as_html ..."
861
+ end
862
+ # verify the required parameter 'id' is set
863
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_as_html" if id.nil?
864
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
865
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
866
+ end
867
+ # resource path
868
+ local_var_path = "/invoices/{ID}.html".sub('{format}','json').sub('{' + 'ID' + '}', id.to_s)
869
+
870
+ # query parameters
871
+ query_params = {}
872
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
873
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
874
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
875
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
876
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
877
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
878
+ query_params[:'tier_breakdown'] = opts[:'tier_breakdown'] if !opts[:'tier_breakdown'].nil?
879
+ query_params[:'inclusive_end'] = opts[:'inclusive_end'] if !opts[:'inclusive_end'].nil?
880
+ query_params[:'show_zero_cost'] = opts[:'show_zero_cost'] if !opts[:'show_zero_cost'].nil?
881
+ query_params[:'show_plan_only_when_ambiguous'] = opts[:'show_plan_only_when_ambiguous'] if !opts[:'show_plan_only_when_ambiguous'].nil?
882
+
883
+ # header parameters
884
+ header_params = {}
885
+
886
+ # HTTP header 'Accept' (if needed)
887
+ local_header_accept = ['text/html']
888
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
889
+
890
+ # HTTP header 'Content-Type'
891
+ local_header_content_type = ['text/plain', 'application/json']
892
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
893
+
894
+ # form parameters
895
+ form_params = {}
896
+
897
+ # http body (model)
898
+ post_body = nil
899
+ auth_names = []
900
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
901
+ :header_params => header_params,
902
+ :query_params => query_params,
903
+ :form_params => form_params,
904
+ :body => post_body,
905
+ :auth_names => auth_names,
906
+ :return_type => 'String')
907
+ if @api_client.config.debugging
908
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_as_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
909
+ end
910
+ return data, status_code, headers
911
+ end
912
+
913
+ # Retrieves a single invoice specified by the ID parameter.
914
+ # { \"nickname\" : \"PDF Invoice\",\"response\" : \"getInvoiceByID.pdf\"}
915
+ # @param id The ID of the invoice.
916
+ # @param [Hash] opts the optional parameters
917
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
918
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
919
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
920
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
921
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
922
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
923
+ # @option opts [BOOLEAN] :tier_breakdown Whether to provide a breakdown of charge tiering. (default to false)
924
+ # @option opts [BOOLEAN] :inclusive_end Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \&quot;period end\&quot; date shown to the customer. (default to false)
925
+ # @option opts [BOOLEAN] :show_zero_cost Whether to show zero-cost lines. (default to true)
926
+ # @option opts [BOOLEAN] :show_plan_only_when_ambiguous Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice. (default to true)
927
+ # @option opts [BOOLEAN] :include_footer
928
+ # @option opts [String] :group_line_items_by
929
+ # @return [File]
930
+ def get_invoice_as_pdf(id, opts = {})
931
+ data, _status_code, _headers = get_invoice_as_pdf_with_http_info(id, opts)
932
+ return data
933
+ end
934
+
935
+ # Retrieves a single invoice specified by the ID parameter.
936
+ # { \&quot;nickname\&quot; : \&quot;PDF Invoice\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByID.pdf\&quot;}
937
+ # @param id The ID of the invoice.
938
+ # @param [Hash] opts the optional parameters
939
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
940
+ # @option opts [Integer] :offset The offset from the first invoice to return.
941
+ # @option opts [Integer] :records The maximum number of invoices to return.
942
+ # @option opts [String] :order_by Specify a field used to order the result set.
943
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
944
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
945
+ # @option opts [BOOLEAN] :tier_breakdown Whether to provide a breakdown of charge tiering.
946
+ # @option opts [BOOLEAN] :inclusive_end Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \&quot;period end\&quot; date shown to the customer.
947
+ # @option opts [BOOLEAN] :show_zero_cost Whether to show zero-cost lines.
948
+ # @option opts [BOOLEAN] :show_plan_only_when_ambiguous Whether to state which plan the Invoice lines came from, regardless of whether there&#39;s only one plan involved in this Invoice.
949
+ # @option opts [BOOLEAN] :include_footer
950
+ # @option opts [String] :group_line_items_by
951
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
952
+ def get_invoice_as_pdf_with_http_info(id, opts = {})
953
+ if @api_client.config.debugging
954
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_as_pdf ..."
955
+ end
956
+ # verify the required parameter 'id' is set
957
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_as_pdf" if id.nil?
958
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
959
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
960
+ end
961
+ if opts[:'group_line_items_by'] && !['Product', 'RatePlan', 'ProductAndRatePlan'].include?(opts[:'group_line_items_by'])
962
+ fail ArgumentError, 'invalid value for "group_line_items_by", must be one of Product, RatePlan, ProductAndRatePlan'
963
+ end
964
+ # resource path
965
+ local_var_path = "/invoices/{ID}.pdf".sub('{format}','json').sub('{' + 'ID' + '}', id.to_s)
966
+
967
+ # query parameters
968
+ query_params = {}
969
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
970
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
971
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
972
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
973
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
974
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
975
+ query_params[:'tier_breakdown'] = opts[:'tier_breakdown'] if !opts[:'tier_breakdown'].nil?
976
+ query_params[:'inclusive_end'] = opts[:'inclusive_end'] if !opts[:'inclusive_end'].nil?
977
+ query_params[:'show_zero_cost'] = opts[:'show_zero_cost'] if !opts[:'show_zero_cost'].nil?
978
+ query_params[:'show_plan_only_when_ambiguous'] = opts[:'show_plan_only_when_ambiguous'] if !opts[:'show_plan_only_when_ambiguous'].nil?
979
+ query_params[:'include_footer'] = opts[:'include_footer'] if !opts[:'include_footer'].nil?
980
+ query_params[:'group_line_items_by'] = opts[:'group_line_items_by'] if !opts[:'group_line_items_by'].nil?
981
+
982
+ # header parameters
983
+ header_params = {}
984
+
985
+ # HTTP header 'Accept' (if needed)
986
+ local_header_accept = ['application/pdf']
987
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
988
+
989
+ # HTTP header 'Content-Type'
990
+ local_header_content_type = ['text/plain', 'application/json']
991
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
992
+
993
+ # form parameters
994
+ form_params = {}
995
+
996
+ # http body (model)
997
+ post_body = nil
998
+ auth_names = []
999
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1000
+ :header_params => header_params,
1001
+ :query_params => query_params,
1002
+ :form_params => form_params,
1003
+ :body => post_body,
1004
+ :auth_names => auth_names,
1005
+ :return_type => 'File')
1006
+ if @api_client.config.debugging
1007
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1008
+ end
1009
+ return data, status_code, headers
1010
+ end
1011
+
1012
+ # Retrieves a single invoice specified by the invoice-ID parameter.
1013
+ # { \"nickname\" : \"Retrieve an existing invoice\",\"response\" : \"getInvoiceByID.html\"}
1014
+ # @param invoice_id The ID of the invoice.
1015
+ # @param [Hash] opts the optional parameters
1016
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1017
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
1018
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
1019
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1020
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1021
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1022
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded. (default to true)
1023
+ # @return [InvoicePagedMetadata]
1024
+ def get_invoice_by_id(invoice_id, opts = {})
1025
+ data, _status_code, _headers = get_invoice_by_id_with_http_info(invoice_id, opts)
1026
+ return data
1027
+ end
1028
+
1029
+ # Retrieves a single invoice specified by the invoice-ID parameter.
1030
+ # { \&quot;nickname\&quot; : \&quot;Retrieve an existing invoice\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByID.html\&quot;}
1031
+ # @param invoice_id The ID of the invoice.
1032
+ # @param [Hash] opts the optional parameters
1033
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1034
+ # @option opts [Integer] :offset The offset from the first invoice to return.
1035
+ # @option opts [Integer] :records The maximum number of invoices to return.
1036
+ # @option opts [String] :order_by Specify a field used to order the result set.
1037
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1038
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1039
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded.
1040
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1041
+ def get_invoice_by_id_with_http_info(invoice_id, opts = {})
1042
+ if @api_client.config.debugging
1043
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_id ..."
1044
+ end
1045
+ # verify the required parameter 'invoice_id' is set
1046
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_invoice_by_id" if invoice_id.nil?
1047
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1048
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1049
+ end
1050
+ # resource path
1051
+ local_var_path = "/invoices/{invoice-ID}".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
1052
+
1053
+ # query parameters
1054
+ query_params = {}
1055
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1056
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1057
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1058
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1059
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1060
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1061
+ query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
1062
+
1063
+ # header parameters
1064
+ header_params = {}
1065
+
1066
+ # HTTP header 'Accept' (if needed)
1067
+ local_header_accept = ['application/json']
1068
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1069
+
1070
+ # HTTP header 'Content-Type'
1071
+ local_header_content_type = ['text/plain', 'application/json']
1072
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1073
+
1074
+ # form parameters
1075
+ form_params = {}
1076
+
1077
+ # http body (model)
1078
+ post_body = nil
1079
+ auth_names = []
1080
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1081
+ :header_params => header_params,
1082
+ :query_params => query_params,
1083
+ :form_params => form_params,
1084
+ :body => post_body,
1085
+ :auth_names => auth_names,
1086
+ :return_type => 'InvoicePagedMetadata')
1087
+ if @api_client.config.debugging
1088
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1089
+ end
1090
+ return data, status_code, headers
1091
+ end
1092
+
1093
+ # Retrieves a single invoice specified by the ID parameter.
1094
+ # { \"nickname\" : \"CSV invoice\",\"response\" : \"getInvoiceByID.csv\"}
1095
+ # @param id The ID of the invoice.
1096
+ # @param [Hash] opts the optional parameters
1097
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1098
+ # @return [String]
1099
+ def get_invoice_by_id_as_csv(id, opts = {})
1100
+ data, _status_code, _headers = get_invoice_by_id_as_csv_with_http_info(id, opts)
1101
+ return data
1102
+ end
1103
+
1104
+ # Retrieves a single invoice specified by the ID parameter.
1105
+ # { \&quot;nickname\&quot; : \&quot;CSV invoice\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByID.csv\&quot;}
1106
+ # @param id The ID of the invoice.
1107
+ # @param [Hash] opts the optional parameters
1108
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1109
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1110
+ def get_invoice_by_id_as_csv_with_http_info(id, opts = {})
1111
+ if @api_client.config.debugging
1112
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_id_as_csv ..."
1113
+ end
1114
+ # verify the required parameter 'id' is set
1115
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice_by_id_as_csv" if id.nil?
1116
+ # resource path
1117
+ local_var_path = "/invoices/{ID}.csv".sub('{format}','json').sub('{' + 'ID' + '}', id.to_s)
1118
+
1119
+ # query parameters
1120
+ query_params = {}
1121
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1122
+
1123
+ # header parameters
1124
+ header_params = {}
1125
+
1126
+ # HTTP header 'Accept' (if needed)
1127
+ local_header_accept = ['text/csv']
1128
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1129
+
1130
+ # HTTP header 'Content-Type'
1131
+ local_header_content_type = ['text/plain', 'application/json']
1132
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1133
+
1134
+ # form parameters
1135
+ form_params = {}
1136
+
1137
+ # http body (model)
1138
+ post_body = nil
1139
+ auth_names = []
1140
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1141
+ :header_params => header_params,
1142
+ :query_params => query_params,
1143
+ :form_params => form_params,
1144
+ :body => post_body,
1145
+ :auth_names => auth_names,
1146
+ :return_type => 'String')
1147
+ if @api_client.config.debugging
1148
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_id_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1149
+ end
1150
+ return data, status_code, headers
1151
+ end
1152
+
1153
+ # Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
1154
+ # { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getInvoiceBySubscriptionID.html\"}
1155
+ # @param subscription_id ID of the subscription.
1156
+ # @param [Hash] opts the optional parameters
1157
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1158
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
1159
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
1160
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1161
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1162
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1163
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded. (default to true)
1164
+ # @return [InvoicePagedMetadata]
1165
+ def get_invoice_by_subscription_id(subscription_id, opts = {})
1166
+ data, _status_code, _headers = get_invoice_by_subscription_id_with_http_info(subscription_id, opts)
1167
+ return data
1168
+ end
1169
+
1170
+ # Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
1171
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by subscription\&quot;,\&quot;response\&quot; : \&quot;getInvoiceBySubscriptionID.html\&quot;}
1172
+ # @param subscription_id ID of the subscription.
1173
+ # @param [Hash] opts the optional parameters
1174
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1175
+ # @option opts [Integer] :offset The offset from the first invoice to return.
1176
+ # @option opts [Integer] :records The maximum number of invoices to return.
1177
+ # @option opts [String] :order_by Specify a field used to order the result set.
1178
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1179
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1180
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded.
1181
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1182
+ def get_invoice_by_subscription_id_with_http_info(subscription_id, opts = {})
1183
+ if @api_client.config.debugging
1184
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_subscription_id ..."
1185
+ end
1186
+ # verify the required parameter 'subscription_id' is set
1187
+ fail ArgumentError, "Missing the required parameter 'subscription_id' when calling InvoicesApi.get_invoice_by_subscription_id" if subscription_id.nil?
1188
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1189
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1190
+ end
1191
+ # resource path
1192
+ local_var_path = "/invoices/subscription/{subscription-ID}".sub('{format}','json').sub('{' + 'subscription-ID' + '}', subscription_id.to_s)
1193
+
1194
+ # query parameters
1195
+ query_params = {}
1196
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1197
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1198
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1199
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1200
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1201
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1202
+ query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
1203
+
1204
+ # header parameters
1205
+ header_params = {}
1206
+
1207
+ # HTTP header 'Accept' (if needed)
1208
+ local_header_accept = ['application/json']
1209
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1210
+
1211
+ # HTTP header 'Content-Type'
1212
+ local_header_content_type = ['text/plain', 'application/json']
1213
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1214
+
1215
+ # form parameters
1216
+ form_params = {}
1217
+
1218
+ # http body (model)
1219
+ post_body = nil
1220
+ auth_names = []
1221
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1222
+ :header_params => header_params,
1223
+ :query_params => query_params,
1224
+ :form_params => form_params,
1225
+ :body => post_body,
1226
+ :auth_names => auth_names,
1227
+ :return_type => 'InvoicePagedMetadata')
1228
+ if @api_client.config.debugging
1229
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_subscription_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1230
+ end
1231
+ return data, status_code, headers
1232
+ end
1233
+
1234
+ # Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
1235
+ # { \"nickname\" : \"Retrieve by subscription version\",\"response\" : \"getInvoiceBySubscriptionVersionID.html\"}
1236
+ # @param subscription_version_id Version ID of the subscription.
1237
+ # @param [Hash] opts the optional parameters
1238
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1239
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
1240
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
1241
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1242
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1243
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1244
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded. (default to true)
1245
+ # @return [InvoicePagedMetadata]
1246
+ def get_invoice_by_subscription_version_id(subscription_version_id, opts = {})
1247
+ data, _status_code, _headers = get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, opts)
1248
+ return data
1249
+ end
1250
+
1251
+ # Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
1252
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by subscription version\&quot;,\&quot;response\&quot; : \&quot;getInvoiceBySubscriptionVersionID.html\&quot;}
1253
+ # @param subscription_version_id Version ID of the subscription.
1254
+ # @param [Hash] opts the optional parameters
1255
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1256
+ # @option opts [Integer] :offset The offset from the first invoice to return.
1257
+ # @option opts [Integer] :records The maximum number of invoices to return.
1258
+ # @option opts [String] :order_by Specify a field used to order the result set.
1259
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1260
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1261
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded.
1262
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1263
+ def get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, opts = {})
1264
+ if @api_client.config.debugging
1265
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_subscription_version_id ..."
1266
+ end
1267
+ # verify the required parameter 'subscription_version_id' is set
1268
+ fail ArgumentError, "Missing the required parameter 'subscription_version_id' when calling InvoicesApi.get_invoice_by_subscription_version_id" if subscription_version_id.nil?
1269
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1270
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1271
+ end
1272
+ # resource path
1273
+ local_var_path = "/invoices/subscription/version/{subscription-version-ID}".sub('{format}','json').sub('{' + 'subscription-version-ID' + '}', subscription_version_id.to_s)
1274
+
1275
+ # query parameters
1276
+ query_params = {}
1277
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1278
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1279
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1280
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1281
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1282
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1283
+ query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
1284
+
1285
+ # header parameters
1286
+ header_params = {}
1287
+
1288
+ # HTTP header 'Accept' (if needed)
1289
+ local_header_accept = ['application/json']
1290
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1291
+
1292
+ # HTTP header 'Content-Type'
1293
+ local_header_content_type = ['text/plain', 'application/json']
1294
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1295
+
1296
+ # form parameters
1297
+ form_params = {}
1298
+
1299
+ # http body (model)
1300
+ post_body = nil
1301
+ auth_names = []
1302
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1303
+ :header_params => header_params,
1304
+ :query_params => query_params,
1305
+ :form_params => form_params,
1306
+ :body => post_body,
1307
+ :auth_names => auth_names,
1308
+ :return_type => 'InvoicePagedMetadata')
1309
+ if @api_client.config.debugging
1310
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_subscription_version_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1311
+ end
1312
+ return data, status_code, headers
1313
+ end
1314
+
1315
+ # Retrieves a single invoice, specified by the version-ID parameter.
1316
+ # { \"nickname\" : \"Retrieve by version\",\"response\" : \"getInvoiceByVersionID.html\"}
1317
+ # @param version_id The version-ID of the invoice.
1318
+ # @param [Hash] opts the optional parameters
1319
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1320
+ # @return [InvoicePagedMetadata]
1321
+ def get_invoice_by_version_id(version_id, opts = {})
1322
+ data, _status_code, _headers = get_invoice_by_version_id_with_http_info(version_id, opts)
1323
+ return data
1324
+ end
1325
+
1326
+ # Retrieves a single invoice, specified by the version-ID parameter.
1327
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by version\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByVersionID.html\&quot;}
1328
+ # @param version_id The version-ID of the invoice.
1329
+ # @param [Hash] opts the optional parameters
1330
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1331
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1332
+ def get_invoice_by_version_id_with_http_info(version_id, opts = {})
1333
+ if @api_client.config.debugging
1334
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoice_by_version_id ..."
1335
+ end
1336
+ # verify the required parameter 'version_id' is set
1337
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling InvoicesApi.get_invoice_by_version_id" if version_id.nil?
1338
+ # resource path
1339
+ local_var_path = "/invoices/version/{version-ID}".sub('{format}','json').sub('{' + 'version-ID' + '}', version_id.to_s)
1340
+
1341
+ # query parameters
1342
+ query_params = {}
1343
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1344
+
1345
+ # header parameters
1346
+ header_params = {}
1347
+
1348
+ # HTTP header 'Accept' (if needed)
1349
+ local_header_accept = ['application/json', 'text/xml']
1350
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1351
+
1352
+ # HTTP header 'Content-Type'
1353
+ local_header_content_type = ['text/plain', 'application/json']
1354
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1355
+
1356
+ # form parameters
1357
+ form_params = {}
1358
+
1359
+ # http body (model)
1360
+ post_body = nil
1361
+ auth_names = []
1362
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1363
+ :header_params => header_params,
1364
+ :query_params => query_params,
1365
+ :form_params => form_params,
1366
+ :body => post_body,
1367
+ :auth_names => auth_names,
1368
+ :return_type => 'InvoicePagedMetadata')
1369
+ if @api_client.config.debugging
1370
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoice_by_version_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1371
+ end
1372
+ return data, status_code, headers
1373
+ end
1374
+
1375
+ # Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
1376
+ # { \"nickname\" : \"Retrieve by account\",\"response\" : \"getInvoiceByAccountID.html\"}
1377
+ # @param account_id ID of the account.
1378
+ # @param [Hash] opts the optional parameters
1379
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1380
+ # @option opts [Integer] :offset The offset from the first invoice to return. (default to 0)
1381
+ # @option opts [Integer] :records The maximum number of invoices to return. (default to 10)
1382
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1383
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1384
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1385
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded. (default to true)
1386
+ # @return [InvoicePagedMetadata]
1387
+ def get_invoices_by_account_id(account_id, opts = {})
1388
+ data, _status_code, _headers = get_invoices_by_account_id_with_http_info(account_id, opts)
1389
+ return data
1390
+ end
1391
+
1392
+ # Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
1393
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by account\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByAccountID.html\&quot;}
1394
+ # @param account_id ID of the account.
1395
+ # @param [Hash] opts the optional parameters
1396
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1397
+ # @option opts [Integer] :offset The offset from the first invoice to return.
1398
+ # @option opts [Integer] :records The maximum number of invoices to return.
1399
+ # @option opts [String] :order_by Specify a field used to order the result set.
1400
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1401
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1402
+ # @option opts [BOOLEAN] :exclude_children Should child invoices be excluded.
1403
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1404
+ def get_invoices_by_account_id_with_http_info(account_id, opts = {})
1405
+ if @api_client.config.debugging
1406
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_account_id ..."
1407
+ end
1408
+ # verify the required parameter 'account_id' is set
1409
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvoicesApi.get_invoices_by_account_id" if account_id.nil?
1410
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1411
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1412
+ end
1413
+ # resource path
1414
+ local_var_path = "/invoices/account/{account-ID}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
1415
+
1416
+ # query parameters
1417
+ query_params = {}
1418
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1419
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1420
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1421
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1422
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1423
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1424
+ query_params[:'exclude_children'] = opts[:'exclude_children'] if !opts[:'exclude_children'].nil?
1425
+
1426
+ # header parameters
1427
+ header_params = {}
1428
+
1429
+ # HTTP header 'Accept' (if needed)
1430
+ local_header_accept = ['application/json']
1431
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1432
+
1433
+ # HTTP header 'Content-Type'
1434
+ local_header_content_type = ['text/plain', 'application/json']
1435
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1436
+
1437
+ # form parameters
1438
+ form_params = {}
1439
+
1440
+ # http body (model)
1441
+ post_body = nil
1442
+ auth_names = []
1443
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1444
+ :header_params => header_params,
1445
+ :query_params => query_params,
1446
+ :form_params => form_params,
1447
+ :body => post_body,
1448
+ :auth_names => auth_names,
1449
+ :return_type => 'InvoicePagedMetadata')
1450
+ if @api_client.config.debugging
1451
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1452
+ end
1453
+ return data, status_code, headers
1454
+ end
1455
+
1456
+ # Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1457
+ # { \"nickname\" : \"Retrieve by period-end\",\"response\" : \"getInvoiceByPeriodEnd.html\"}
1458
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1459
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1460
+ # @param [Hash] opts the optional parameters
1461
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1462
+ # @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
1463
+ # @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
1464
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1465
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1466
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1467
+ # @return [InvoicePagedMetadata]
1468
+ def get_invoices_by_period_end(lower_threshold, upper_threshold, opts = {})
1469
+ data, _status_code, _headers = get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, opts)
1470
+ return data
1471
+ end
1472
+
1473
+ # Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1474
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by period-end\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByPeriodEnd.html\&quot;}
1475
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1476
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1477
+ # @param [Hash] opts the optional parameters
1478
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1479
+ # @option opts [Integer] :offset The offset from the first taxation-link to return.
1480
+ # @option opts [Integer] :records The maximum number of taxation-links to return.
1481
+ # @option opts [String] :order_by Specify a field used to order the result set.
1482
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1483
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1484
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1485
+ def get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, opts = {})
1486
+ if @api_client.config.debugging
1487
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_end ..."
1488
+ end
1489
+ # verify the required parameter 'lower_threshold' is set
1490
+ fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_end" if lower_threshold.nil?
1491
+ # verify the required parameter 'upper_threshold' is set
1492
+ fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_end" if upper_threshold.nil?
1493
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1494
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1495
+ end
1496
+ # resource path
1497
+ local_var_path = "/invoices/period-end/{lower-threshold}/{upper-threshold}".sub('{format}','json').sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
1498
+
1499
+ # query parameters
1500
+ query_params = {}
1501
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1502
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1503
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1504
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1505
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1506
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1507
+
1508
+ # header parameters
1509
+ header_params = {}
1510
+
1511
+ # HTTP header 'Accept' (if needed)
1512
+ local_header_accept = ['application/json']
1513
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1514
+
1515
+ # HTTP header 'Content-Type'
1516
+ local_header_content_type = ['text/plain', 'application/json']
1517
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1518
+
1519
+ # form parameters
1520
+ form_params = {}
1521
+
1522
+ # http body (model)
1523
+ post_body = nil
1524
+ auth_names = []
1525
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1526
+ :header_params => header_params,
1527
+ :query_params => query_params,
1528
+ :form_params => form_params,
1529
+ :body => post_body,
1530
+ :auth_names => auth_names,
1531
+ :return_type => 'InvoicePagedMetadata')
1532
+ if @api_client.config.debugging
1533
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_end\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1534
+ end
1535
+ return data, status_code, headers
1536
+ end
1537
+
1538
+ # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1539
+ # { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.html\"}
1540
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1541
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1542
+ # @param [Hash] opts the optional parameters
1543
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1544
+ # @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
1545
+ # @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
1546
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1547
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1548
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1549
+ # @return [InvoicePagedMetadata]
1550
+ def get_invoices_by_period_start(lower_threshold, upper_threshold, opts = {})
1551
+ data, _status_code, _headers = get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, opts)
1552
+ return data
1553
+ end
1554
+
1555
+ # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1556
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by period-start\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByPeriodStart.html\&quot;}
1557
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1558
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1559
+ # @param [Hash] opts the optional parameters
1560
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1561
+ # @option opts [Integer] :offset The offset from the first taxation-link to return.
1562
+ # @option opts [Integer] :records The maximum number of taxation-links to return.
1563
+ # @option opts [String] :order_by Specify a field used to order the result set.
1564
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1565
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1566
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1567
+ def get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, opts = {})
1568
+ if @api_client.config.debugging
1569
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_start ..."
1570
+ end
1571
+ # verify the required parameter 'lower_threshold' is set
1572
+ fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_start" if lower_threshold.nil?
1573
+ # verify the required parameter 'upper_threshold' is set
1574
+ fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_start" if upper_threshold.nil?
1575
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1576
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1577
+ end
1578
+ # resource path
1579
+ local_var_path = "/invoices/period-start/{lower-threshold}/{upper-threshold}".sub('{format}','json').sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
1580
+
1581
+ # query parameters
1582
+ query_params = {}
1583
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1584
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1585
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1586
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1587
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1588
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1589
+
1590
+ # header parameters
1591
+ header_params = {}
1592
+
1593
+ # HTTP header 'Accept' (if needed)
1594
+ local_header_accept = ['application/json']
1595
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1596
+
1597
+ # HTTP header 'Content-Type'
1598
+ local_header_content_type = ['text/plain', 'application/json']
1599
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1600
+
1601
+ # form parameters
1602
+ form_params = {}
1603
+
1604
+ # http body (model)
1605
+ post_body = nil
1606
+ auth_names = []
1607
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1608
+ :header_params => header_params,
1609
+ :query_params => query_params,
1610
+ :form_params => form_params,
1611
+ :body => post_body,
1612
+ :auth_names => auth_names,
1613
+ :return_type => 'InvoicePagedMetadata')
1614
+ if @api_client.config.debugging
1615
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1616
+ end
1617
+ return data, status_code, headers
1618
+ end
1619
+
1620
+ # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1621
+ # { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.csv\"}
1622
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1623
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1624
+ # @param [Hash] opts the optional parameters
1625
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1626
+ # @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
1627
+ # @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
1628
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1629
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1630
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1631
+ # @return [InvoicePagedMetadata]
1632
+ def get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, opts = {})
1633
+ data, _status_code, _headers = get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, opts)
1634
+ return data
1635
+ end
1636
+
1637
+ # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1638
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by period-start\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByPeriodStart.csv\&quot;}
1639
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1640
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1641
+ # @param [Hash] opts the optional parameters
1642
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1643
+ # @option opts [Integer] :offset The offset from the first taxation-link to return.
1644
+ # @option opts [Integer] :records The maximum number of taxation-links to return.
1645
+ # @option opts [String] :order_by Specify a field used to order the result set.
1646
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1647
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1648
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1649
+ def get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, opts = {})
1650
+ if @api_client.config.debugging
1651
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_period_start_as_csv ..."
1652
+ end
1653
+ # verify the required parameter 'lower_threshold' is set
1654
+ fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_period_start_as_csv" if lower_threshold.nil?
1655
+ # verify the required parameter 'upper_threshold' is set
1656
+ fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_period_start_as_csv" if upper_threshold.nil?
1657
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1658
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1659
+ end
1660
+ # resource path
1661
+ local_var_path = "/invoices/period-start/{lower-threshold}/{upper-threshold}.csv".sub('{format}','json').sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
1662
+
1663
+ # query parameters
1664
+ query_params = {}
1665
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1666
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1667
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1668
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1669
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1670
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1671
+
1672
+ # header parameters
1673
+ header_params = {}
1674
+
1675
+ # HTTP header 'Accept' (if needed)
1676
+ local_header_accept = ['text/csv']
1677
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1678
+
1679
+ # HTTP header 'Content-Type'
1680
+ local_header_content_type = ['text/plain', 'application/json']
1681
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1682
+
1683
+ # form parameters
1684
+ form_params = {}
1685
+
1686
+ # http body (model)
1687
+ post_body = nil
1688
+ auth_names = []
1689
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1690
+ :header_params => header_params,
1691
+ :query_params => query_params,
1692
+ :form_params => form_params,
1693
+ :body => post_body,
1694
+ :auth_names => auth_names,
1695
+ :return_type => 'InvoicePagedMetadata')
1696
+ if @api_client.config.debugging
1697
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_period_start_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1698
+ end
1699
+ return data, status_code, headers
1700
+ end
1701
+
1702
+ # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
1703
+ # { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.html\"}
1704
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1705
+ # @param [Hash] opts the optional parameters
1706
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1707
+ # @option opts [Integer] :offset The offset from the first subscription to return. (default to 0)
1708
+ # @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10)
1709
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to ID)
1710
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1711
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1712
+ # @return [InvoicePagedMetadata]
1713
+ def get_invoices_by_state(state, opts = {})
1714
+ data, _status_code, _headers = get_invoices_by_state_with_http_info(state, opts)
1715
+ return data
1716
+ end
1717
+
1718
+ # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
1719
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by state\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByState.html\&quot;}
1720
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1721
+ # @param [Hash] opts the optional parameters
1722
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1723
+ # @option opts [Integer] :offset The offset from the first subscription to return.
1724
+ # @option opts [Integer] :records The maximum number of subscriptions to return.
1725
+ # @option opts [String] :order_by Specify a field used to order the result set.
1726
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1727
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1728
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1729
+ def get_invoices_by_state_with_http_info(state, opts = {})
1730
+ if @api_client.config.debugging
1731
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state ..."
1732
+ end
1733
+ # verify the required parameter 'state' is set
1734
+ fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state" if state.nil?
1735
+ # verify enum value
1736
+ unless ['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
1737
+ fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
1738
+ end
1739
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1740
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1741
+ end
1742
+ # resource path
1743
+ local_var_path = "/invoices/state/{state}".sub('{format}','json').sub('{' + 'state' + '}', state.to_s)
1744
+
1745
+ # query parameters
1746
+ query_params = {}
1747
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1748
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1749
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1750
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1751
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1752
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1753
+
1754
+ # header parameters
1755
+ header_params = {}
1756
+
1757
+ # HTTP header 'Accept' (if needed)
1758
+ local_header_accept = ['application/json']
1759
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1760
+
1761
+ # HTTP header 'Content-Type'
1762
+ local_header_content_type = ['text/plain', 'application/json']
1763
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1764
+
1765
+ # form parameters
1766
+ form_params = {}
1767
+
1768
+ # http body (model)
1769
+ post_body = nil
1770
+ auth_names = []
1771
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1772
+ :header_params => header_params,
1773
+ :query_params => query_params,
1774
+ :form_params => form_params,
1775
+ :body => post_body,
1776
+ :auth_names => auth_names,
1777
+ :return_type => 'InvoicePagedMetadata')
1778
+ if @api_client.config.debugging
1779
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1780
+ end
1781
+ return data, status_code, headers
1782
+ end
1783
+
1784
+ # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1785
+ # { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.html\"}
1786
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1787
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1788
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1789
+ # @param [Hash] opts the optional parameters
1790
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1791
+ # @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
1792
+ # @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
1793
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1794
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1795
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1796
+ # @return [InvoicePagedMetadata]
1797
+ def get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, opts = {})
1798
+ data, _status_code, _headers = get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, opts)
1799
+ return data
1800
+ end
1801
+
1802
+ # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1803
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by state and period-start\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByStateAndPeriodStart.html\&quot;}
1804
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1805
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1806
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1807
+ # @param [Hash] opts the optional parameters
1808
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1809
+ # @option opts [Integer] :offset The offset from the first taxation-link to return.
1810
+ # @option opts [Integer] :records The maximum number of taxation-links to return.
1811
+ # @option opts [String] :order_by Specify a field used to order the result set.
1812
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1813
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1814
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1815
+ def get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, opts = {})
1816
+ if @api_client.config.debugging
1817
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_and_period_start ..."
1818
+ end
1819
+ # verify the required parameter 'state' is set
1820
+ fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_and_period_start" if state.nil?
1821
+ # verify enum value
1822
+ unless ['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
1823
+ fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
1824
+ end
1825
+ # verify the required parameter 'lower_threshold' is set
1826
+ fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start" if lower_threshold.nil?
1827
+ # verify the required parameter 'upper_threshold' is set
1828
+ fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start" if upper_threshold.nil?
1829
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1830
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1831
+ end
1832
+ # resource path
1833
+ local_var_path = "/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}".sub('{format}','json').sub('{' + 'state' + '}', state.to_s).sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
1834
+
1835
+ # query parameters
1836
+ query_params = {}
1837
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1838
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1839
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1840
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1841
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1842
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1843
+
1844
+ # header parameters
1845
+ header_params = {}
1846
+
1847
+ # HTTP header 'Accept' (if needed)
1848
+ local_header_accept = ['application/json']
1849
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1850
+
1851
+ # HTTP header 'Content-Type'
1852
+ local_header_content_type = ['text/plain', 'application/json']
1853
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1854
+
1855
+ # form parameters
1856
+ form_params = {}
1857
+
1858
+ # http body (model)
1859
+ post_body = nil
1860
+ auth_names = []
1861
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1862
+ :header_params => header_params,
1863
+ :query_params => query_params,
1864
+ :form_params => form_params,
1865
+ :body => post_body,
1866
+ :auth_names => auth_names,
1867
+ :return_type => 'InvoicePagedMetadata')
1868
+ if @api_client.config.debugging
1869
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_and_period_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1870
+ end
1871
+ return data, status_code, headers
1872
+ end
1873
+
1874
+ # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1875
+ # { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.csv\"}
1876
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1877
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1878
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1879
+ # @param [Hash] opts the optional parameters
1880
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1881
+ # @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
1882
+ # @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
1883
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to created)
1884
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1885
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1886
+ # @return [InvoicePagedMetadata]
1887
+ def get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, opts = {})
1888
+ data, _status_code, _headers = get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, opts)
1889
+ return data
1890
+ end
1891
+
1892
+ # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
1893
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by state and period-start\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByStateAndPeriodStart.csv\&quot;}
1894
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1895
+ # @param lower_threshold The UTC DateTime specifying the start of the result period.
1896
+ # @param upper_threshold The UTC DateTime specifying the end of the result period.
1897
+ # @param [Hash] opts the optional parameters
1898
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1899
+ # @option opts [Integer] :offset The offset from the first taxation-link to return.
1900
+ # @option opts [Integer] :records The maximum number of taxation-links to return.
1901
+ # @option opts [String] :order_by Specify a field used to order the result set.
1902
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1903
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1904
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1905
+ def get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, opts = {})
1906
+ if @api_client.config.debugging
1907
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_and_period_start_as_csv ..."
1908
+ end
1909
+ # verify the required parameter 'state' is set
1910
+ fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv" if state.nil?
1911
+ # verify enum value
1912
+ unless ['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
1913
+ fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
1914
+ end
1915
+ # verify the required parameter 'lower_threshold' is set
1916
+ fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv" if lower_threshold.nil?
1917
+ # verify the required parameter 'upper_threshold' is set
1918
+ fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling InvoicesApi.get_invoices_by_state_and_period_start_as_csv" if upper_threshold.nil?
1919
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
1920
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
1921
+ end
1922
+ # resource path
1923
+ local_var_path = "/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv".sub('{format}','json').sub('{' + 'state' + '}', state.to_s).sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
1924
+
1925
+ # query parameters
1926
+ query_params = {}
1927
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
1928
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1929
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
1930
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1931
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1932
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
1933
+
1934
+ # header parameters
1935
+ header_params = {}
1936
+
1937
+ # HTTP header 'Accept' (if needed)
1938
+ local_header_accept = ['text/csv']
1939
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1940
+
1941
+ # HTTP header 'Content-Type'
1942
+ local_header_content_type = ['text/plain', 'application/json']
1943
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1944
+
1945
+ # form parameters
1946
+ form_params = {}
1947
+
1948
+ # http body (model)
1949
+ post_body = nil
1950
+ auth_names = []
1951
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1952
+ :header_params => header_params,
1953
+ :query_params => query_params,
1954
+ :form_params => form_params,
1955
+ :body => post_body,
1956
+ :auth_names => auth_names,
1957
+ :return_type => 'InvoicePagedMetadata')
1958
+ if @api_client.config.debugging
1959
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_and_period_start_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1960
+ end
1961
+ return data, status_code, headers
1962
+ end
1963
+
1964
+ # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
1965
+ # { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.csv\"}
1966
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1967
+ # @param [Hash] opts the optional parameters
1968
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1969
+ # @option opts [Integer] :offset The offset from the first subscription to return. (default to 0)
1970
+ # @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10)
1971
+ # @option opts [String] :order_by Specify a field used to order the result set. (default to ID)
1972
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
1973
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to false)
1974
+ # @return [InvoicePagedMetadata]
1975
+ def get_invoices_by_state_as_csv(state, opts = {})
1976
+ data, _status_code, _headers = get_invoices_by_state_as_csv_with_http_info(state, opts)
1977
+ return data
1978
+ end
1979
+
1980
+ # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
1981
+ # { \&quot;nickname\&quot; : \&quot;Retrieve by state\&quot;,\&quot;response\&quot; : \&quot;getInvoiceByState.csv\&quot;}
1982
+ # @param state The current state of the invoice, either Paid, Pending, Unpaid or Voided.
1983
+ # @param [Hash] opts the optional parameters
1984
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
1985
+ # @option opts [Integer] :offset The offset from the first subscription to return.
1986
+ # @option opts [Integer] :records The maximum number of subscriptions to return.
1987
+ # @option opts [String] :order_by Specify a field used to order the result set.
1988
+ # @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
1989
+ # @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
1990
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
1991
+ def get_invoices_by_state_as_csv_with_http_info(state, opts = {})
1992
+ if @api_client.config.debugging
1993
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_invoices_by_state_as_csv ..."
1994
+ end
1995
+ # verify the required parameter 'state' is set
1996
+ fail ArgumentError, "Missing the required parameter 'state' when calling InvoicesApi.get_invoices_by_state_as_csv" if state.nil?
1997
+ # verify enum value
1998
+ unless ['Paid', 'Unpaid', 'Pending', 'Voided'].include?(state)
1999
+ fail ArgumentError, "invalid value for 'state', must be one of Paid, Unpaid, Pending, Voided"
2000
+ end
2001
+ if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
2002
+ fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
2003
+ end
2004
+ # resource path
2005
+ local_var_path = "/invoices/state/{state}.csv".sub('{format}','json').sub('{' + 'state' + '}', state.to_s)
2006
+
2007
+ # query parameters
2008
+ query_params = {}
2009
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2010
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
2011
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
2012
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
2013
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
2014
+ query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
2015
+
2016
+ # header parameters
2017
+ header_params = {}
2018
+
2019
+ # HTTP header 'Accept' (if needed)
2020
+ local_header_accept = ['text/csv']
2021
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2022
+
2023
+ # HTTP header 'Content-Type'
2024
+ local_header_content_type = ['text/plain', 'application/json']
2025
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2026
+
2027
+ # form parameters
2028
+ form_params = {}
2029
+
2030
+ # http body (model)
2031
+ post_body = nil
2032
+ auth_names = []
2033
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2034
+ :header_params => header_params,
2035
+ :query_params => query_params,
2036
+ :form_params => form_params,
2037
+ :body => post_body,
2038
+ :auth_names => auth_names,
2039
+ :return_type => 'InvoicePagedMetadata')
2040
+ if @api_client.config.debugging
2041
+ @api_client.config.logger.debug "API called: InvoicesApi#get_invoices_by_state_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2042
+ end
2043
+ return data, status_code, headers
2044
+ end
2045
+
2046
+ # Retrieves all InvoiceLine payment attributions.
2047
+ # { \"nickname\" : \"Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.html\"}
2048
+ # @param [Hash] opts the optional parameters
2049
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2050
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
2051
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
2052
+ # @option opts [Array<String>] :include_gateway Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).
2053
+ # @option opts [Array<String>] :exclude_gateway Include attributions from payments made via all payment gateways, except these.
2054
+ # @return [InvoiceLinePaymentPagedMetadata]
2055
+ def get_line_payments(opts = {})
2056
+ data, _status_code, _headers = get_line_payments_with_http_info(opts)
2057
+ return data
2058
+ end
2059
+
2060
+ # Retrieves all InvoiceLine payment attributions.
2061
+ # { \&quot;nickname\&quot; : \&quot;Retrieve InvoiceLine payment attributions\&quot;,\&quot;response\&quot; : \&quot;getInvoiceLinePayments.html\&quot;}
2062
+ # @param [Hash] opts the optional parameters
2063
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2064
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
2065
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
2066
+ # @option opts [Array<String>] :include_gateway Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).
2067
+ # @option opts [Array<String>] :exclude_gateway Include attributions from payments made via all payment gateways, except these.
2068
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
2069
+ def get_line_payments_with_http_info(opts = {})
2070
+ if @api_client.config.debugging
2071
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_line_payments ..."
2072
+ end
2073
+ if opts[:'include_gateway'] && !['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(opts[:'include_gateway'])
2074
+ fail ArgumentError, 'invalid value for "include_gateway", must be one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
2075
+ end
2076
+ if opts[:'exclude_gateway'] && !['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(opts[:'exclude_gateway'])
2077
+ fail ArgumentError, 'invalid value for "exclude_gateway", must be one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
2078
+ end
2079
+ # resource path
2080
+ local_var_path = "/invoices/line-payments".sub('{format}','json')
2081
+
2082
+ # query parameters
2083
+ query_params = {}
2084
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2085
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2086
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2087
+ query_params[:'include_gateway'] = @api_client.build_collection_param(opts[:'include_gateway'], :multi) if !opts[:'include_gateway'].nil?
2088
+ query_params[:'exclude_gateway'] = @api_client.build_collection_param(opts[:'exclude_gateway'], :multi) if !opts[:'exclude_gateway'].nil?
2089
+
2090
+ # header parameters
2091
+ header_params = {}
2092
+
2093
+ # HTTP header 'Accept' (if needed)
2094
+ local_header_accept = []
2095
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2096
+
2097
+ # HTTP header 'Content-Type'
2098
+ local_header_content_type = []
2099
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2100
+
2101
+ # form parameters
2102
+ form_params = {}
2103
+
2104
+ # http body (model)
2105
+ post_body = nil
2106
+ auth_names = []
2107
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2108
+ :header_params => header_params,
2109
+ :query_params => query_params,
2110
+ :form_params => form_params,
2111
+ :body => post_body,
2112
+ :auth_names => auth_names,
2113
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
2114
+ if @api_client.config.debugging
2115
+ @api_client.config.logger.debug "API called: InvoicesApi#get_line_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2116
+ end
2117
+ return data, status_code, headers
2118
+ end
2119
+
2120
+ # Retrieves (as CSV) all InvoiceLine payment attributions.
2121
+ # { \"nickname\" : \"(CSV) Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.csv\"}
2122
+ # @param [Hash] opts the optional parameters
2123
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2124
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
2125
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
2126
+ # @option opts [Array<String>] :include_gateway Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).
2127
+ # @option opts [Array<String>] :exclude_gateway Include attributions from payments made via all payment gateways, except these.
2128
+ # @return [InvoiceLinePaymentPagedMetadata]
2129
+ def get_line_payments_as_csv(opts = {})
2130
+ data, _status_code, _headers = get_line_payments_as_csv_with_http_info(opts)
2131
+ return data
2132
+ end
2133
+
2134
+ # Retrieves (as CSV) all InvoiceLine payment attributions.
2135
+ # { \&quot;nickname\&quot; : \&quot;(CSV) Retrieve InvoiceLine payment attributions\&quot;,\&quot;response\&quot; : \&quot;getInvoiceLinePayments.csv\&quot;}
2136
+ # @param [Hash] opts the optional parameters
2137
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2138
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
2139
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
2140
+ # @option opts [Array<String>] :include_gateway Include attributions only from payments made via these payment gateways. Takes precedence over &#x60;exclude_gateway&#x60; param (if both are provided).
2141
+ # @option opts [Array<String>] :exclude_gateway Include attributions from payments made via all payment gateways, except these.
2142
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
2143
+ def get_line_payments_as_csv_with_http_info(opts = {})
2144
+ if @api_client.config.debugging
2145
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_line_payments_as_csv ..."
2146
+ end
2147
+ if opts[:'include_gateway'] && !['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(opts[:'include_gateway'])
2148
+ fail ArgumentError, 'invalid value for "include_gateway", must be one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
2149
+ end
2150
+ if opts[:'exclude_gateway'] && !['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(opts[:'exclude_gateway'])
2151
+ fail ArgumentError, 'invalid value for "exclude_gateway", must be one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash'
2152
+ end
2153
+ # resource path
2154
+ local_var_path = "/invoices/line-payments.csv".sub('{format}','json')
2155
+
2156
+ # query parameters
2157
+ query_params = {}
2158
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2159
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2160
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2161
+ query_params[:'include_gateway'] = @api_client.build_collection_param(opts[:'include_gateway'], :multi) if !opts[:'include_gateway'].nil?
2162
+ query_params[:'exclude_gateway'] = @api_client.build_collection_param(opts[:'exclude_gateway'], :multi) if !opts[:'exclude_gateway'].nil?
2163
+
2164
+ # header parameters
2165
+ header_params = {}
2166
+
2167
+ # HTTP header 'Accept' (if needed)
2168
+ local_header_accept = []
2169
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2170
+
2171
+ # HTTP header 'Content-Type'
2172
+ local_header_content_type = []
2173
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2174
+
2175
+ # form parameters
2176
+ form_params = {}
2177
+
2178
+ # http body (model)
2179
+ post_body = nil
2180
+ auth_names = []
2181
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2182
+ :header_params => header_params,
2183
+ :query_params => query_params,
2184
+ :form_params => form_params,
2185
+ :body => post_body,
2186
+ :auth_names => auth_names,
2187
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
2188
+ if @api_client.config.debugging
2189
+ @api_client.config.logger.debug "API called: InvoicesApi#get_line_payments_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2190
+ end
2191
+ return data, status_code, headers
2192
+ end
2193
+
2194
+ # Retrieve any associated metadata.
2195
+ # {\"nickname\":\"Retrieve metadata on invoice\",\"request\":\"getInvoiceMetadataRequest.html\",\"response\":\"getInvoiceMetadataResponse.html\"}
2196
+ # @param invoice_id
2197
+ # @param [Hash] opts the optional parameters
2198
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2199
+ # @return [DynamicMetadata]
2200
+ def get_metadata_for_invoice(invoice_id, opts = {})
2201
+ data, _status_code, _headers = get_metadata_for_invoice_with_http_info(invoice_id, opts)
2202
+ return data
2203
+ end
2204
+
2205
+ # Retrieve any associated metadata.
2206
+ # {\&quot;nickname\&quot;:\&quot;Retrieve metadata on invoice\&quot;,\&quot;request\&quot;:\&quot;getInvoiceMetadataRequest.html\&quot;,\&quot;response\&quot;:\&quot;getInvoiceMetadataResponse.html\&quot;}
2207
+ # @param invoice_id
2208
+ # @param [Hash] opts the optional parameters
2209
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2210
+ # @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
2211
+ def get_metadata_for_invoice_with_http_info(invoice_id, opts = {})
2212
+ if @api_client.config.debugging
2213
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_metadata_for_invoice ..."
2214
+ end
2215
+ # verify the required parameter 'invoice_id' is set
2216
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.get_metadata_for_invoice" if invoice_id.nil?
2217
+ # resource path
2218
+ local_var_path = "/invoices/{invoice-ID}/metadata".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
2219
+
2220
+ # query parameters
2221
+ query_params = {}
2222
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2223
+
2224
+ # header parameters
2225
+ header_params = {}
2226
+
2227
+ # HTTP header 'Accept' (if needed)
2228
+ local_header_accept = ['application/json']
2229
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2230
+
2231
+ # HTTP header 'Content-Type'
2232
+ local_header_content_type = ['text/plain', 'application/json']
2233
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2234
+
2235
+ # form parameters
2236
+ form_params = {}
2237
+
2238
+ # http body (model)
2239
+ post_body = nil
2240
+ auth_names = []
2241
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2242
+ :header_params => header_params,
2243
+ :query_params => query_params,
2244
+ :form_params => form_params,
2245
+ :body => post_body,
2246
+ :auth_names => auth_names,
2247
+ :return_type => 'DynamicMetadata')
2248
+ if @api_client.config.debugging
2249
+ @api_client.config.logger.debug "API called: InvoicesApi#get_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2250
+ end
2251
+ return data, status_code, headers
2252
+ end
2253
+
2254
+ # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
2255
+ # { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"}
2256
+ # @param [Hash] opts the optional parameters
2257
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2258
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
2259
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
2260
+ # @return [InvoiceLinePaymentPagedMetadata]
2261
+ def get_refund_invoice_line_payments_from_invoices_as_csv(opts = {})
2262
+ data, _status_code, _headers = get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(opts)
2263
+ return data
2264
+ end
2265
+
2266
+ # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
2267
+ # { \&quot;nickname\&quot; : \&quot;Refund InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Refund InvoiceLinePayments.csv\&quot;}
2268
+ # @param [Hash] opts the optional parameters
2269
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2270
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
2271
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
2272
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
2273
+ def get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(opts = {})
2274
+ if @api_client.config.debugging
2275
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_refund_invoice_line_payments_from_invoices_as_csv ..."
2276
+ end
2277
+ # resource path
2278
+ local_var_path = "/invoices/refund.csv".sub('{format}','json')
2279
+
2280
+ # query parameters
2281
+ query_params = {}
2282
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2283
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2284
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2285
+
2286
+ # header parameters
2287
+ header_params = {}
2288
+
2289
+ # HTTP header 'Accept' (if needed)
2290
+ local_header_accept = ['text/csv']
2291
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2292
+
2293
+ # HTTP header 'Content-Type'
2294
+ local_header_content_type = ['text/plain', 'application/json']
2295
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2296
+
2297
+ # form parameters
2298
+ form_params = {}
2299
+
2300
+ # http body (model)
2301
+ post_body = nil
2302
+ auth_names = []
2303
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2304
+ :header_params => header_params,
2305
+ :query_params => query_params,
2306
+ :form_params => form_params,
2307
+ :body => post_body,
2308
+ :auth_names => auth_names,
2309
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
2310
+ if @api_client.config.debugging
2311
+ @api_client.config.logger.debug "API called: InvoicesApi#get_refund_invoice_line_payments_from_invoices_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2312
+ end
2313
+ return data, status_code, headers
2314
+ end
2315
+
2316
+ # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
2317
+ # { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"}
2318
+ # @param [Hash] opts the optional parameters
2319
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2320
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
2321
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
2322
+ # @return [InvoiceLinePaymentPagedMetadata]
2323
+ def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(opts = {})
2324
+ data, _status_code, _headers = get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(opts)
2325
+ return data
2326
+ end
2327
+
2328
+ # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
2329
+ # { \&quot;nickname\&quot; : \&quot;Refund InvoiceLinePayments CSV\&quot;,\&quot;response\&quot; : \&quot;Refund InvoiceLinePayments.csv\&quot;}
2330
+ # @param [Hash] opts the optional parameters
2331
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2332
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
2333
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
2334
+ # @return [Array<(InvoiceLinePaymentPagedMetadata, Fixnum, Hash)>] InvoiceLinePaymentPagedMetadata data, response status code and response headers
2335
+ def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(opts = {})
2336
+ if @api_client.config.debugging
2337
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received ..."
2338
+ end
2339
+ # resource path
2340
+ local_var_path = "/invoices/payment-received/refund.csv".sub('{format}','json')
2341
+
2342
+ # query parameters
2343
+ query_params = {}
2344
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2345
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2346
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2347
+
2348
+ # header parameters
2349
+ header_params = {}
2350
+
2351
+ # HTTP header 'Accept' (if needed)
2352
+ local_header_accept = ['text/csv']
2353
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2354
+
2355
+ # HTTP header 'Content-Type'
2356
+ local_header_content_type = ['text/plain', 'application/json']
2357
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2358
+
2359
+ # form parameters
2360
+ form_params = {}
2361
+
2362
+ # http body (model)
2363
+ post_body = nil
2364
+ auth_names = []
2365
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2366
+ :header_params => header_params,
2367
+ :query_params => query_params,
2368
+ :form_params => form_params,
2369
+ :body => post_body,
2370
+ :auth_names => auth_names,
2371
+ :return_type => 'InvoiceLinePaymentPagedMetadata')
2372
+ if @api_client.config.debugging
2373
+ @api_client.config.logger.debug "API called: InvoicesApi#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2374
+ end
2375
+ return data, status_code, headers
2376
+ end
2377
+
2378
+ # Retrieves all attributions of Invoice costs to Invoice lines.
2379
+ # { \"nickname\" : \"Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.html\"}
2380
+ # @param [Hash] opts the optional parameters
2381
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2382
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
2383
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
2384
+ # @return [RevenueAttributionPagedMetadata]
2385
+ def get_revenue_attributions(opts = {})
2386
+ data, _status_code, _headers = get_revenue_attributions_with_http_info(opts)
2387
+ return data
2388
+ end
2389
+
2390
+ # Retrieves all attributions of Invoice costs to Invoice lines.
2391
+ # { \&quot;nickname\&quot; : \&quot;Retrieve revenue attributions\&quot;,\&quot;response\&quot; : \&quot;getRevenueAttributions.html\&quot;}
2392
+ # @param [Hash] opts the optional parameters
2393
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2394
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
2395
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
2396
+ # @return [Array<(RevenueAttributionPagedMetadata, Fixnum, Hash)>] RevenueAttributionPagedMetadata data, response status code and response headers
2397
+ def get_revenue_attributions_with_http_info(opts = {})
2398
+ if @api_client.config.debugging
2399
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_revenue_attributions ..."
2400
+ end
2401
+ # resource path
2402
+ local_var_path = "/invoices/revenue-attributions".sub('{format}','json')
2403
+
2404
+ # query parameters
2405
+ query_params = {}
2406
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2407
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2408
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2409
+
2410
+ # header parameters
2411
+ header_params = {}
2412
+
2413
+ # HTTP header 'Accept' (if needed)
2414
+ local_header_accept = []
2415
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2416
+
2417
+ # HTTP header 'Content-Type'
2418
+ local_header_content_type = []
2419
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2420
+
2421
+ # form parameters
2422
+ form_params = {}
2423
+
2424
+ # http body (model)
2425
+ post_body = nil
2426
+ auth_names = []
2427
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2428
+ :header_params => header_params,
2429
+ :query_params => query_params,
2430
+ :form_params => form_params,
2431
+ :body => post_body,
2432
+ :auth_names => auth_names,
2433
+ :return_type => 'RevenueAttributionPagedMetadata')
2434
+ if @api_client.config.debugging
2435
+ @api_client.config.logger.debug "API called: InvoicesApi#get_revenue_attributions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2436
+ end
2437
+ return data, status_code, headers
2438
+ end
2439
+
2440
+ # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
2441
+ # { \"nickname\" : \"(CSV) Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.csv\"}
2442
+ # @param [Hash] opts the optional parameters
2443
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2444
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
2445
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
2446
+ # @return [String]
2447
+ def get_revenue_attributions_as_csv(opts = {})
2448
+ data, _status_code, _headers = get_revenue_attributions_as_csv_with_http_info(opts)
2449
+ return data
2450
+ end
2451
+
2452
+ # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
2453
+ # { \&quot;nickname\&quot; : \&quot;(CSV) Retrieve revenue attributions\&quot;,\&quot;response\&quot; : \&quot;getRevenueAttributions.csv\&quot;}
2454
+ # @param [Hash] opts the optional parameters
2455
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2456
+ # @option opts [String] :recognition_start The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
2457
+ # @option opts [String] :recognition_end The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
2458
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
2459
+ def get_revenue_attributions_as_csv_with_http_info(opts = {})
2460
+ if @api_client.config.debugging
2461
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_revenue_attributions_as_csv ..."
2462
+ end
2463
+ # resource path
2464
+ local_var_path = "/invoices/revenue-attributions.csv".sub('{format}','json')
2465
+
2466
+ # query parameters
2467
+ query_params = {}
2468
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2469
+ query_params[:'recognition_start'] = opts[:'recognition_start'] if !opts[:'recognition_start'].nil?
2470
+ query_params[:'recognition_end'] = opts[:'recognition_end'] if !opts[:'recognition_end'].nil?
2471
+
2472
+ # header parameters
2473
+ header_params = {}
2474
+
2475
+ # HTTP header 'Accept' (if needed)
2476
+ local_header_accept = []
2477
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2478
+
2479
+ # HTTP header 'Content-Type'
2480
+ local_header_content_type = []
2481
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2482
+
2483
+ # form parameters
2484
+ form_params = {}
2485
+
2486
+ # http body (model)
2487
+ post_body = nil
2488
+ auth_names = []
2489
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2490
+ :header_params => header_params,
2491
+ :query_params => query_params,
2492
+ :form_params => form_params,
2493
+ :body => post_body,
2494
+ :auth_names => auth_names,
2495
+ :return_type => 'String')
2496
+ if @api_client.config.debugging
2497
+ @api_client.config.logger.debug "API called: InvoicesApi#get_revenue_attributions_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2498
+ end
2499
+ return data, status_code, headers
2500
+ end
2501
+
2502
+ #
2503
+ # { \"nickname\" : \"\",\"response\" : \"\"}
2504
+ # @param query_string The query string used to search.
2505
+ # @param [Hash] opts the optional parameters
2506
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2507
+ # @option opts [Integer] :offset The starting index of the search results. (default to 0)
2508
+ # @option opts [Integer] :records The number of search results to return. (default to 10)
2509
+ # @option opts [String] :format The response format, either JSON or XML. (default to JSON)
2510
+ # @option opts [BOOLEAN] :wildcard Toggle if we search for full words or whether a wildcard is used. (default to false)
2511
+ # @option opts [BOOLEAN] :entity Is an entity returned with the search results. (default to false)
2512
+ # @return [SwaggerTypeListInv]
2513
+ def get_swagger_for_invoice(query_string, opts = {})
2514
+ data, _status_code, _headers = get_swagger_for_invoice_with_http_info(query_string, opts)
2515
+ return data
2516
+ end
2517
+
2518
+ #
2519
+ # { \&quot;nickname\&quot; : \&quot;\&quot;,\&quot;response\&quot; : \&quot;\&quot;}
2520
+ # @param query_string The query string used to search.
2521
+ # @param [Hash] opts the optional parameters
2522
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2523
+ # @option opts [Integer] :offset The starting index of the search results.
2524
+ # @option opts [Integer] :records The number of search results to return.
2525
+ # @option opts [String] :format The response format, either JSON or XML.
2526
+ # @option opts [BOOLEAN] :wildcard Toggle if we search for full words or whether a wildcard is used.
2527
+ # @option opts [BOOLEAN] :entity Is an entity returned with the search results.
2528
+ # @return [Array<(SwaggerTypeListInv, Fixnum, Hash)>] SwaggerTypeListInv data, response status code and response headers
2529
+ def get_swagger_for_invoice_with_http_info(query_string, opts = {})
2530
+ if @api_client.config.debugging
2531
+ @api_client.config.logger.debug "Calling API: InvoicesApi.get_swagger_for_invoice ..."
2532
+ end
2533
+ # verify the required parameter 'query_string' is set
2534
+ fail ArgumentError, "Missing the required parameter 'query_string' when calling InvoicesApi.get_swagger_for_invoice" if query_string.nil?
2535
+ # resource path
2536
+ local_var_path = "/invoices/swagger-end-point/{query-string}".sub('{format}','json').sub('{' + 'query-string' + '}', query_string.to_s)
2537
+
2538
+ # query parameters
2539
+ query_params = {}
2540
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2541
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
2542
+ query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
2543
+ query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
2544
+ query_params[:'wildcard'] = opts[:'wildcard'] if !opts[:'wildcard'].nil?
2545
+ query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?
2546
+
2547
+ # header parameters
2548
+ header_params = {}
2549
+
2550
+ # HTTP header 'Accept' (if needed)
2551
+ local_header_accept = ['application/json']
2552
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2553
+
2554
+ # HTTP header 'Content-Type'
2555
+ local_header_content_type = ['text/plain', 'application/json']
2556
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2557
+
2558
+ # form parameters
2559
+ form_params = {}
2560
+
2561
+ # http body (model)
2562
+ post_body = nil
2563
+ auth_names = []
2564
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2565
+ :header_params => header_params,
2566
+ :query_params => query_params,
2567
+ :form_params => form_params,
2568
+ :body => post_body,
2569
+ :auth_names => auth_names,
2570
+ :return_type => 'SwaggerTypeListInv')
2571
+ if @api_client.config.debugging
2572
+ @api_client.config.logger.debug "API called: InvoicesApi#get_swagger_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2573
+ end
2574
+ return data, status_code, headers
2575
+ end
2576
+
2577
+ # Import an invoice.
2578
+ # {\"nickname\":\"Import invoice\",\"response\":\"ImportInvoiceResponse.html\",\"request\":\"ImportInvoiceRequest.html\"}
2579
+ # @param request
2580
+ # @param [Hash] opts the optional parameters
2581
+ # @return [InvoicePagedMetadata]
2582
+ def import_invoice(request, opts = {})
2583
+ data, _status_code, _headers = import_invoice_with_http_info(request, opts)
2584
+ return data
2585
+ end
2586
+
2587
+ # Import an invoice.
2588
+ # {\&quot;nickname\&quot;:\&quot;Import invoice\&quot;,\&quot;response\&quot;:\&quot;ImportInvoiceResponse.html\&quot;,\&quot;request\&quot;:\&quot;ImportInvoiceRequest.html\&quot;}
2589
+ # @param request
2590
+ # @param [Hash] opts the optional parameters
2591
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
2592
+ def import_invoice_with_http_info(request, opts = {})
2593
+ if @api_client.config.debugging
2594
+ @api_client.config.logger.debug "Calling API: InvoicesApi.import_invoice ..."
2595
+ end
2596
+ # verify the required parameter 'request' is set
2597
+ fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.import_invoice" if request.nil?
2598
+ # resource path
2599
+ local_var_path = "/invoices/import".sub('{format}','json')
2600
+
2601
+ # query parameters
2602
+ query_params = {}
2603
+
2604
+ # header parameters
2605
+ header_params = {}
2606
+
2607
+ # HTTP header 'Accept' (if needed)
2608
+ local_header_accept = ['application/json']
2609
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2610
+
2611
+ # HTTP header 'Content-Type'
2612
+ local_header_content_type = ['application/json']
2613
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2614
+
2615
+ # form parameters
2616
+ form_params = {}
2617
+
2618
+ # http body (model)
2619
+ post_body = @api_client.object_to_http_body(request)
2620
+ auth_names = []
2621
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2622
+ :header_params => header_params,
2623
+ :query_params => query_params,
2624
+ :form_params => form_params,
2625
+ :body => post_body,
2626
+ :auth_names => auth_names,
2627
+ :return_type => 'InvoicePagedMetadata')
2628
+ if @api_client.config.debugging
2629
+ @api_client.config.logger.debug "API called: InvoicesApi#import_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2630
+ end
2631
+ return data, status_code, headers
2632
+ end
2633
+
2634
+ # Re-calculate an Invoice.
2635
+ # {\"nickname\":\"Re-calculate an invoice\",\"response\":\"recalculateInvoiceResponse.html\",\"request\":\"RecalculateInvoiceRequest.html\"}
2636
+ # @param invoice_id
2637
+ # @param request
2638
+ # @param [Hash] opts the optional parameters
2639
+ # @return [InvoicePagedMetadata]
2640
+ def recalculate_invoice(invoice_id, request, opts = {})
2641
+ data, _status_code, _headers = recalculate_invoice_with_http_info(invoice_id, request, opts)
2642
+ return data
2643
+ end
2644
+
2645
+ # Re-calculate an Invoice.
2646
+ # {\&quot;nickname\&quot;:\&quot;Re-calculate an invoice\&quot;,\&quot;response\&quot;:\&quot;recalculateInvoiceResponse.html\&quot;,\&quot;request\&quot;:\&quot;RecalculateInvoiceRequest.html\&quot;}
2647
+ # @param invoice_id
2648
+ # @param request
2649
+ # @param [Hash] opts the optional parameters
2650
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
2651
+ def recalculate_invoice_with_http_info(invoice_id, request, opts = {})
2652
+ if @api_client.config.debugging
2653
+ @api_client.config.logger.debug "Calling API: InvoicesApi.recalculate_invoice ..."
2654
+ end
2655
+ # verify the required parameter 'invoice_id' is set
2656
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.recalculate_invoice" if invoice_id.nil?
2657
+ # verify the required parameter 'request' is set
2658
+ fail ArgumentError, "Missing the required parameter 'request' when calling InvoicesApi.recalculate_invoice" if request.nil?
2659
+ # resource path
2660
+ local_var_path = "/invoices/{invoice-ID}/recalculate".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
2661
+
2662
+ # query parameters
2663
+ query_params = {}
2664
+
2665
+ # header parameters
2666
+ header_params = {}
2667
+
2668
+ # HTTP header 'Accept' (if needed)
2669
+ local_header_accept = ['application/json']
2670
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2671
+
2672
+ # HTTP header 'Content-Type'
2673
+ local_header_content_type = ['application/json']
2674
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2675
+
2676
+ # form parameters
2677
+ form_params = {}
2678
+
2679
+ # http body (model)
2680
+ post_body = @api_client.object_to_http_body(request)
2681
+ auth_names = []
2682
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2683
+ :header_params => header_params,
2684
+ :query_params => query_params,
2685
+ :form_params => form_params,
2686
+ :body => post_body,
2687
+ :auth_names => auth_names,
2688
+ :return_type => 'InvoicePagedMetadata')
2689
+ if @api_client.config.debugging
2690
+ @api_client.config.logger.debug "API called: InvoicesApi#recalculate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2691
+ end
2692
+ return data, status_code, headers
2693
+ end
2694
+
2695
+ # Removes the specified charge from the specified Invoice.
2696
+ # {\"nickname\":\"Remove from invoice\",\"response\":\"deleteChargesInvoice.html\"}
2697
+ # @param invoice_id
2698
+ # @param charge_id
2699
+ # @param [Hash] opts the optional parameters
2700
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2701
+ # @return [SubscriptionChargePagedMetadata]
2702
+ def remove_charge_from_invoice(invoice_id, charge_id, opts = {})
2703
+ data, _status_code, _headers = remove_charge_from_invoice_with_http_info(invoice_id, charge_id, opts)
2704
+ return data
2705
+ end
2706
+
2707
+ # Removes the specified charge from the specified Invoice.
2708
+ # {\&quot;nickname\&quot;:\&quot;Remove from invoice\&quot;,\&quot;response\&quot;:\&quot;deleteChargesInvoice.html\&quot;}
2709
+ # @param invoice_id
2710
+ # @param charge_id
2711
+ # @param [Hash] opts the optional parameters
2712
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2713
+ # @return [Array<(SubscriptionChargePagedMetadata, Fixnum, Hash)>] SubscriptionChargePagedMetadata data, response status code and response headers
2714
+ def remove_charge_from_invoice_with_http_info(invoice_id, charge_id, opts = {})
2715
+ if @api_client.config.debugging
2716
+ @api_client.config.logger.debug "Calling API: InvoicesApi.remove_charge_from_invoice ..."
2717
+ end
2718
+ # verify the required parameter 'invoice_id' is set
2719
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.remove_charge_from_invoice" if invoice_id.nil?
2720
+ # verify the required parameter 'charge_id' is set
2721
+ fail ArgumentError, "Missing the required parameter 'charge_id' when calling InvoicesApi.remove_charge_from_invoice" if charge_id.nil?
2722
+ # resource path
2723
+ local_var_path = "/invoices/{invoice-ID}/charges/{charge-ID}".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s).sub('{' + 'charge-ID' + '}', charge_id.to_s)
2724
+
2725
+ # query parameters
2726
+ query_params = {}
2727
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2728
+
2729
+ # header parameters
2730
+ header_params = {}
2731
+
2732
+ # HTTP header 'Accept' (if needed)
2733
+ local_header_accept = ['application/json']
2734
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2735
+
2736
+ # HTTP header 'Content-Type'
2737
+ local_header_content_type = ['text/plain', 'application/json']
2738
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2739
+
2740
+ # form parameters
2741
+ form_params = {}
2742
+
2743
+ # http body (model)
2744
+ post_body = nil
2745
+ auth_names = []
2746
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2747
+ :header_params => header_params,
2748
+ :query_params => query_params,
2749
+ :form_params => form_params,
2750
+ :body => post_body,
2751
+ :auth_names => auth_names,
2752
+ :return_type => 'SubscriptionChargePagedMetadata')
2753
+ if @api_client.config.debugging
2754
+ @api_client.config.logger.debug "API called: InvoicesApi#remove_charge_from_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2755
+ end
2756
+ return data, status_code, headers
2757
+ end
2758
+
2759
+ # Remove any associated metadata.
2760
+ # {\"nickname\":\"Clear metadata from invoice\",\"request\" :\"deleteInvoiceMetadataRequest.html\",\"response\":\"deleteInvoiceMetadataResponse.html\"}
2761
+ # @param invoice_id
2762
+ # @param [Hash] opts the optional parameters
2763
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2764
+ # @return [DynamicMetadata]
2765
+ def remove_metadata_from_invoice(invoice_id, opts = {})
2766
+ data, _status_code, _headers = remove_metadata_from_invoice_with_http_info(invoice_id, opts)
2767
+ return data
2768
+ end
2769
+
2770
+ # Remove any associated metadata.
2771
+ # {\&quot;nickname\&quot;:\&quot;Clear metadata from invoice\&quot;,\&quot;request\&quot; :\&quot;deleteInvoiceMetadataRequest.html\&quot;,\&quot;response\&quot;:\&quot;deleteInvoiceMetadataResponse.html\&quot;}
2772
+ # @param invoice_id
2773
+ # @param [Hash] opts the optional parameters
2774
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2775
+ # @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
2776
+ def remove_metadata_from_invoice_with_http_info(invoice_id, opts = {})
2777
+ if @api_client.config.debugging
2778
+ @api_client.config.logger.debug "Calling API: InvoicesApi.remove_metadata_from_invoice ..."
2779
+ end
2780
+ # verify the required parameter 'invoice_id' is set
2781
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.remove_metadata_from_invoice" if invoice_id.nil?
2782
+ # resource path
2783
+ local_var_path = "/invoices/{invoice-ID}/metadata".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
2784
+
2785
+ # query parameters
2786
+ query_params = {}
2787
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2788
+
2789
+ # header parameters
2790
+ header_params = {}
2791
+
2792
+ # HTTP header 'Accept' (if needed)
2793
+ local_header_accept = ['application/json']
2794
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2795
+
2796
+ # HTTP header 'Content-Type'
2797
+ local_header_content_type = ['text/plain', 'application/json']
2798
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2799
+
2800
+ # form parameters
2801
+ form_params = {}
2802
+
2803
+ # http body (model)
2804
+ post_body = nil
2805
+ auth_names = []
2806
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
2807
+ :header_params => header_params,
2808
+ :query_params => query_params,
2809
+ :form_params => form_params,
2810
+ :body => post_body,
2811
+ :auth_names => auth_names,
2812
+ :return_type => 'DynamicMetadata')
2813
+ if @api_client.config.debugging
2814
+ @api_client.config.logger.debug "API called: InvoicesApi#remove_metadata_from_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2815
+ end
2816
+ return data, status_code, headers
2817
+ end
2818
+
2819
+ # Remove any existing metadata keys and create the provided data.
2820
+ # {\"nickname\":\"Set metadata on invoice\",\"request\":\"setInvoiceMetadataRequest.html\",\"response\":\"setInvoiceMetadataResponse.html\"}
2821
+ # @param metadata
2822
+ # @param invoice_id
2823
+ # @param [Hash] opts the optional parameters
2824
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2825
+ # @return [DynamicMetadata]
2826
+ def set_metadata_for_invoice(metadata, invoice_id, opts = {})
2827
+ data, _status_code, _headers = set_metadata_for_invoice_with_http_info(metadata, invoice_id, opts)
2828
+ return data
2829
+ end
2830
+
2831
+ # Remove any existing metadata keys and create the provided data.
2832
+ # {\&quot;nickname\&quot;:\&quot;Set metadata on invoice\&quot;,\&quot;request\&quot;:\&quot;setInvoiceMetadataRequest.html\&quot;,\&quot;response\&quot;:\&quot;setInvoiceMetadataResponse.html\&quot;}
2833
+ # @param metadata
2834
+ # @param invoice_id
2835
+ # @param [Hash] opts the optional parameters
2836
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2837
+ # @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
2838
+ def set_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {})
2839
+ if @api_client.config.debugging
2840
+ @api_client.config.logger.debug "Calling API: InvoicesApi.set_metadata_for_invoice ..."
2841
+ end
2842
+ # verify the required parameter 'metadata' is set
2843
+ fail ArgumentError, "Missing the required parameter 'metadata' when calling InvoicesApi.set_metadata_for_invoice" if metadata.nil?
2844
+ # verify the required parameter 'invoice_id' is set
2845
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.set_metadata_for_invoice" if invoice_id.nil?
2846
+ # resource path
2847
+ local_var_path = "/invoices/{invoice-ID}/metadata".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
2848
+
2849
+ # query parameters
2850
+ query_params = {}
2851
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2852
+
2853
+ # header parameters
2854
+ header_params = {}
2855
+
2856
+ # HTTP header 'Accept' (if needed)
2857
+ local_header_accept = ['application/json']
2858
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2859
+
2860
+ # HTTP header 'Content-Type'
2861
+ local_header_content_type = ['application/json']
2862
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2863
+
2864
+ # form parameters
2865
+ form_params = {}
2866
+
2867
+ # http body (model)
2868
+ post_body = @api_client.object_to_http_body(metadata)
2869
+ auth_names = []
2870
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2871
+ :header_params => header_params,
2872
+ :query_params => query_params,
2873
+ :form_params => form_params,
2874
+ :body => post_body,
2875
+ :auth_names => auth_names,
2876
+ :return_type => 'DynamicMetadata')
2877
+ if @api_client.config.debugging
2878
+ @api_client.config.logger.debug "API called: InvoicesApi#set_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2879
+ end
2880
+ return data, status_code, headers
2881
+ end
2882
+
2883
+ # Update an Invoice.
2884
+ # {\"nickname\":\"Update an invoice\",\"response\":\"updateInvoiceResponse.html\",\"request\":\"updateInvoiceRequest.html\"}
2885
+ # @param invoice The invoice object to be updated.
2886
+ # @param [Hash] opts the optional parameters
2887
+ # @return [InvoicePagedMetadata]
2888
+ def update_invoice(invoice, opts = {})
2889
+ data, _status_code, _headers = update_invoice_with_http_info(invoice, opts)
2890
+ return data
2891
+ end
2892
+
2893
+ # Update an Invoice.
2894
+ # {\&quot;nickname\&quot;:\&quot;Update an invoice\&quot;,\&quot;response\&quot;:\&quot;updateInvoiceResponse.html\&quot;,\&quot;request\&quot;:\&quot;updateInvoiceRequest.html\&quot;}
2895
+ # @param invoice The invoice object to be updated.
2896
+ # @param [Hash] opts the optional parameters
2897
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
2898
+ def update_invoice_with_http_info(invoice, opts = {})
2899
+ if @api_client.config.debugging
2900
+ @api_client.config.logger.debug "Calling API: InvoicesApi.update_invoice ..."
2901
+ end
2902
+ # verify the required parameter 'invoice' is set
2903
+ fail ArgumentError, "Missing the required parameter 'invoice' when calling InvoicesApi.update_invoice" if invoice.nil?
2904
+ # resource path
2905
+ local_var_path = "/invoices".sub('{format}','json')
2906
+
2907
+ # query parameters
2908
+ query_params = {}
2909
+
2910
+ # header parameters
2911
+ header_params = {}
2912
+
2913
+ # HTTP header 'Accept' (if needed)
2914
+ local_header_accept = ['text/xml', 'application/xml', 'application/json']
2915
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2916
+
2917
+ # HTTP header 'Content-Type'
2918
+ local_header_content_type = ['application/json']
2919
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2920
+
2921
+ # form parameters
2922
+ form_params = {}
2923
+
2924
+ # http body (model)
2925
+ post_body = @api_client.object_to_http_body(invoice)
2926
+ auth_names = []
2927
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2928
+ :header_params => header_params,
2929
+ :query_params => query_params,
2930
+ :form_params => form_params,
2931
+ :body => post_body,
2932
+ :auth_names => auth_names,
2933
+ :return_type => 'InvoicePagedMetadata')
2934
+ if @api_client.config.debugging
2935
+ @api_client.config.logger.debug "API called: InvoicesApi#update_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2936
+ end
2937
+ return data, status_code, headers
2938
+ end
2939
+
2940
+ # Update any existing metadata key-values and insert any new key-values, no keys will be removed.
2941
+ # {\"nickname\":\"Upsert metadata on invoice\",\"request\":\"upsertInvoiceMetadataRequest.html\",\"response\":\"upsertInvoiceMetadataResponse.html\"}
2942
+ # @param metadata
2943
+ # @param invoice_id
2944
+ # @param [Hash] opts the optional parameters
2945
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2946
+ # @return [DynamicMetadata]
2947
+ def upsert_metadata_for_invoice(metadata, invoice_id, opts = {})
2948
+ data, _status_code, _headers = upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, opts)
2949
+ return data
2950
+ end
2951
+
2952
+ # Update any existing metadata key-values and insert any new key-values, no keys will be removed.
2953
+ # {\&quot;nickname\&quot;:\&quot;Upsert metadata on invoice\&quot;,\&quot;request\&quot;:\&quot;upsertInvoiceMetadataRequest.html\&quot;,\&quot;response\&quot;:\&quot;upsertInvoiceMetadataResponse.html\&quot;}
2954
+ # @param metadata
2955
+ # @param invoice_id
2956
+ # @param [Hash] opts the optional parameters
2957
+ # @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
2958
+ # @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
2959
+ def upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, opts = {})
2960
+ if @api_client.config.debugging
2961
+ @api_client.config.logger.debug "Calling API: InvoicesApi.upsert_metadata_for_invoice ..."
2962
+ end
2963
+ # verify the required parameter 'metadata' is set
2964
+ fail ArgumentError, "Missing the required parameter 'metadata' when calling InvoicesApi.upsert_metadata_for_invoice" if metadata.nil?
2965
+ # verify the required parameter 'invoice_id' is set
2966
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.upsert_metadata_for_invoice" if invoice_id.nil?
2967
+ # resource path
2968
+ local_var_path = "/invoices/{invoice-ID}/metadata".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
2969
+
2970
+ # query parameters
2971
+ query_params = {}
2972
+ query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
2973
+
2974
+ # header parameters
2975
+ header_params = {}
2976
+
2977
+ # HTTP header 'Accept' (if needed)
2978
+ local_header_accept = ['application/json']
2979
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2980
+
2981
+ # HTTP header 'Content-Type'
2982
+ local_header_content_type = ['application/json']
2983
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2984
+
2985
+ # form parameters
2986
+ form_params = {}
2987
+
2988
+ # http body (model)
2989
+ post_body = @api_client.object_to_http_body(metadata)
2990
+ auth_names = []
2991
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2992
+ :header_params => header_params,
2993
+ :query_params => query_params,
2994
+ :form_params => form_params,
2995
+ :body => post_body,
2996
+ :auth_names => auth_names,
2997
+ :return_type => 'DynamicMetadata')
2998
+ if @api_client.config.debugging
2999
+ @api_client.config.logger.debug "API called: InvoicesApi#upsert_metadata_for_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3000
+ end
3001
+ return data, status_code, headers
3002
+ end
3003
+
3004
+ # Voids the invoice specified by the invoice identifier parameter.
3005
+ # { \"nickname\" : \"Void an invoice\",\"response\" : \"voidInvoice.html\"}
3006
+ # @param invoice_id ID of the invoice.
3007
+ # @param organizations A list of organization-IDs used to restrict the scope of API calls.
3008
+ # @param [Hash] opts the optional parameters
3009
+ # @return [InvoicePagedMetadata]
3010
+ def void_invoice(invoice_id, organizations, opts = {})
3011
+ data, _status_code, _headers = void_invoice_with_http_info(invoice_id, organizations, opts)
3012
+ return data
3013
+ end
3014
+
3015
+ # Voids the invoice specified by the invoice identifier parameter.
3016
+ # { \&quot;nickname\&quot; : \&quot;Void an invoice\&quot;,\&quot;response\&quot; : \&quot;voidInvoice.html\&quot;}
3017
+ # @param invoice_id ID of the invoice.
3018
+ # @param organizations A list of organization-IDs used to restrict the scope of API calls.
3019
+ # @param [Hash] opts the optional parameters
3020
+ # @return [Array<(InvoicePagedMetadata, Fixnum, Hash)>] InvoicePagedMetadata data, response status code and response headers
3021
+ def void_invoice_with_http_info(invoice_id, organizations, opts = {})
3022
+ if @api_client.config.debugging
3023
+ @api_client.config.logger.debug "Calling API: InvoicesApi.void_invoice ..."
3024
+ end
3025
+ # verify the required parameter 'invoice_id' is set
3026
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoicesApi.void_invoice" if invoice_id.nil?
3027
+ # verify the required parameter 'organizations' is set
3028
+ fail ArgumentError, "Missing the required parameter 'organizations' when calling InvoicesApi.void_invoice" if organizations.nil?
3029
+ # resource path
3030
+ local_var_path = "/invoices/{invoice-ID}".sub('{format}','json').sub('{' + 'invoice-ID' + '}', invoice_id.to_s)
3031
+
3032
+ # query parameters
3033
+ query_params = {}
3034
+ query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)
3035
+
3036
+ # header parameters
3037
+ header_params = {}
3038
+
3039
+ # HTTP header 'Accept' (if needed)
3040
+ local_header_accept = ['application/json']
3041
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3042
+
3043
+ # HTTP header 'Content-Type'
3044
+ local_header_content_type = ['text/plain', 'application/json']
3045
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3046
+
3047
+ # form parameters
3048
+ form_params = {}
3049
+
3050
+ # http body (model)
3051
+ post_body = nil
3052
+ auth_names = []
3053
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3054
+ :header_params => header_params,
3055
+ :query_params => query_params,
3056
+ :form_params => form_params,
3057
+ :body => post_body,
3058
+ :auth_names => auth_names,
3059
+ :return_type => 'InvoicePagedMetadata')
3060
+ if @api_client.config.debugging
3061
+ @api_client.config.logger.debug "API called: InvoicesApi#void_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3062
+ end
3063
+ return data, status_code, headers
3064
+ end
3065
+ end
3066
+ end