lob 5.4.5 → 6.0.0.pre.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (481) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +6 -1
  3. data/Gemfile.lock +70 -0
  4. data/LICENSE +21 -0
  5. data/README.md +88 -91
  6. data/Rakefile +7 -5
  7. data/__tests__/Api/Address.unit.rb +210 -0
  8. data/__tests__/Api/BankAccount.unit.rb +244 -0
  9. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  10. data/__tests__/Api/Card.unit.rb +183 -0
  11. data/__tests__/Api/CardOrder.unit.rb +89 -0
  12. data/__tests__/Api/Check.unit.rb +185 -0
  13. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  14. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  15. data/__tests__/Api/Letter.unit.rb +191 -0
  16. data/__tests__/Api/Postcard.unit.rb +189 -0
  17. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  18. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  19. data/__tests__/Api/Template.unit.rb +165 -0
  20. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  21. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  22. data/__tests__/Api/UsVerification.unit.rb +71 -0
  23. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  24. data/__tests__/Integration/Address.spec.rb +200 -0
  25. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  26. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  27. data/__tests__/Integration/Card.spec.rb +198 -0
  28. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  29. data/__tests__/Integration/Check.spec.rb +361 -0
  30. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  31. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  32. data/__tests__/Integration/Letter.spec.rb +286 -0
  33. data/__tests__/Integration/Postcard.spec.rb +214 -0
  34. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  35. data/__tests__/Integration/SelfMailer.spec.rb +264 -0
  36. data/__tests__/Integration/Template.spec.rb +221 -0
  37. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  38. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  39. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  40. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  41. data/__tests__/TestFixtures.rb +36 -0
  42. data/docs/Address.md +52 -0
  43. data/docs/AddressDeletion.md +22 -0
  44. data/docs/AddressDomestic.md +40 -0
  45. data/docs/AddressDomesticExpanded.md +40 -0
  46. data/docs/AddressEditable.md +40 -0
  47. data/docs/AddressList.md +28 -0
  48. data/docs/AddressesApi.md +303 -0
  49. data/docs/BankAccount.md +44 -0
  50. data/docs/BankAccountDeletion.md +22 -0
  51. data/docs/BankAccountList.md +28 -0
  52. data/docs/BankAccountVerify.md +18 -0
  53. data/docs/BankAccountWritable.md +28 -0
  54. data/docs/BankAccountsApi.md +376 -0
  55. data/docs/BankTypeEnum.md +15 -0
  56. data/docs/BillingGroup.md +28 -0
  57. data/docs/BillingGroupEditable.md +20 -0
  58. data/docs/BillingGroupList.md +26 -0
  59. data/docs/BillingGroupsApi.md +305 -0
  60. data/docs/Buckslip.md +60 -0
  61. data/docs/BuckslipDeletion.md +20 -0
  62. data/docs/BuckslipEditable.md +24 -0
  63. data/docs/BuckslipOrder.md +42 -0
  64. data/docs/BuckslipOrderEditable.md +18 -0
  65. data/docs/BuckslipOrdersApi.md +157 -0
  66. data/docs/BuckslipOrdersList.md +26 -0
  67. data/docs/BuckslipUpdatable.md +22 -0
  68. data/docs/BuckslipsApi.md +372 -0
  69. data/docs/BuckslipsList.md +28 -0
  70. data/docs/BulkError.md +18 -0
  71. data/docs/BulkErrorProperties.md +20 -0
  72. data/docs/Campaign.md +52 -0
  73. data/docs/CampaignCreative.md +42 -0
  74. data/docs/CampaignDeletion.md +20 -0
  75. data/docs/CampaignUpdatable.md +36 -0
  76. data/docs/CampaignWritable.md +36 -0
  77. data/docs/CampaignsApi.md +376 -0
  78. data/docs/CampaignsList.md +28 -0
  79. data/docs/Card.md +54 -0
  80. data/docs/CardDeletion.md +22 -0
  81. data/docs/CardEditable.md +24 -0
  82. data/docs/CardList.md +28 -0
  83. data/docs/CardOrder.md +42 -0
  84. data/docs/CardOrderEditable.md +18 -0
  85. data/docs/CardOrderList.md +26 -0
  86. data/docs/CardOrdersApi.md +157 -0
  87. data/docs/CardUpdatable.md +22 -0
  88. data/docs/CardsApi.md +372 -0
  89. data/docs/Check.md +68 -0
  90. data/docs/CheckDeletion.md +22 -0
  91. data/docs/CheckEditable.md +48 -0
  92. data/docs/CheckList.md +28 -0
  93. data/docs/ChecksApi.md +315 -0
  94. data/docs/CmpScheduleType.md +15 -0
  95. data/docs/CmpUseType.md +15 -0
  96. data/docs/CountryExtended.md +15 -0
  97. data/docs/CountryExtendedExpanded.md +15 -0
  98. data/docs/CreativePatch.md +22 -0
  99. data/docs/CreativeResponse.md +42 -0
  100. data/docs/CreativeWritable.md +34 -0
  101. data/docs/CreativesApi.md +226 -0
  102. data/docs/CustomEnvelopeReturned.md +22 -0
  103. data/docs/DefaultApi.md +75 -0
  104. data/docs/DeliverabilityAnalysis.md +34 -0
  105. data/docs/DpvFootnote.md +15 -0
  106. data/docs/EngineHtml.md +15 -0
  107. data/docs/EventType.md +24 -0
  108. data/docs/Events.md +28 -0
  109. data/docs/Export.md +32 -0
  110. data/docs/ExportModel.md +18 -0
  111. data/docs/GeocodeAddresses.md +20 -0
  112. data/docs/GeocodeComponents.md +20 -0
  113. data/docs/HTTPValidationError.md +18 -0
  114. data/docs/IdentityValidation.md +34 -0
  115. data/docs/IdentityValidationApi.md +78 -0
  116. data/docs/InlineObject.md +18 -0
  117. data/docs/IntlAutocompletions.md +20 -0
  118. data/docs/IntlAutocompletionsApi.md +82 -0
  119. data/docs/IntlAutocompletionsWritable.md +26 -0
  120. data/docs/IntlComponents.md +26 -0
  121. data/docs/IntlSuggestions.md +30 -0
  122. data/docs/IntlVerification.md +38 -0
  123. data/docs/IntlVerificationOrError.md +40 -0
  124. data/docs/IntlVerificationWritable.md +32 -0
  125. data/docs/IntlVerifications.md +20 -0
  126. data/docs/IntlVerificationsApi.md +153 -0
  127. data/docs/IntlVerificationsPayload.md +18 -0
  128. data/docs/Letter.md +72 -0
  129. data/docs/LetterCustomEnvelope.md +22 -0
  130. data/docs/LetterDeletion.md +22 -0
  131. data/docs/LetterDetailsReturned.md +36 -0
  132. data/docs/LetterDetailsWritable.md +32 -0
  133. data/docs/LetterEditable.md +52 -0
  134. data/docs/LetterList.md +28 -0
  135. data/docs/LettersApi.md +317 -0
  136. data/docs/LobConfidenceScore.md +20 -0
  137. data/docs/LobError.md +22 -0
  138. data/docs/Location.md +20 -0
  139. data/docs/LocationAnalysis.md +22 -0
  140. data/docs/MailType.md +15 -0
  141. data/docs/MultiLineAddress.md +32 -0
  142. data/docs/MultipleComponents.md +30 -0
  143. data/docs/MultipleComponentsIntl.md +30 -0
  144. data/docs/MultipleComponentsList.md +18 -0
  145. data/docs/PlaceholderModel.md +28 -0
  146. data/docs/Postcard.md +60 -0
  147. data/docs/PostcardDeletion.md +22 -0
  148. data/docs/PostcardDetailsReturned.md +26 -0
  149. data/docs/PostcardDetailsWritable.md +20 -0
  150. data/docs/PostcardEditable.md +40 -0
  151. data/docs/PostcardList.md +28 -0
  152. data/docs/PostcardSize.md +15 -0
  153. data/docs/PostcardsApi.md +317 -0
  154. data/docs/QrCode.md +30 -0
  155. data/docs/ReturnEnvelope.md +24 -0
  156. data/docs/ReverseGeocode.md +22 -0
  157. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  158. data/docs/SelfMailer.md +48 -0
  159. data/docs/SelfMailerDeletion.md +22 -0
  160. data/docs/SelfMailerEditable.md +38 -0
  161. data/docs/SelfMailerList.md +28 -0
  162. data/docs/SelfMailerSize.md +15 -0
  163. data/docs/SelfMailersApi.md +317 -0
  164. data/docs/SortBy.md +20 -0
  165. data/docs/SortBy1.md +20 -0
  166. data/docs/SortBy2.md +20 -0
  167. data/docs/SortBy3.md +20 -0
  168. data/docs/SortByDateModified.md +20 -0
  169. data/docs/Suggestions.md +26 -0
  170. data/docs/Template.md +34 -0
  171. data/docs/TemplateDeletion.md +22 -0
  172. data/docs/TemplateList.md +28 -0
  173. data/docs/TemplateUpdate.md +20 -0
  174. data/docs/TemplateVersion.md +36 -0
  175. data/docs/TemplateVersionDeletion.md +22 -0
  176. data/docs/TemplateVersionList.md +28 -0
  177. data/docs/TemplateVersionUpdatable.md +20 -0
  178. data/docs/TemplateVersionWritable.md +22 -0
  179. data/docs/TemplateVersionsApi.md +384 -0
  180. data/docs/TemplateWritable.md +24 -0
  181. data/docs/TemplatesApi.md +376 -0
  182. data/docs/Thumbnail.md +22 -0
  183. data/docs/TrackingEventCertified.md +34 -0
  184. data/docs/TrackingEventDetails.md +24 -0
  185. data/docs/TrackingEventNormal.md +34 -0
  186. data/docs/Upload.md +44 -0
  187. data/docs/UploadCreateExport.md +20 -0
  188. data/docs/UploadFile.md +20 -0
  189. data/docs/UploadState.md +15 -0
  190. data/docs/UploadUpdatable.md +20 -0
  191. data/docs/UploadWritable.md +18 -0
  192. data/docs/UploadsApi.md +584 -0
  193. data/docs/UsAutocompletions.md +22 -0
  194. data/docs/UsAutocompletionsApi.md +78 -0
  195. data/docs/UsAutocompletionsWritable.md +26 -0
  196. data/docs/UsComponents.md +68 -0
  197. data/docs/UsVerification.md +38 -0
  198. data/docs/UsVerificationOrError.md +40 -0
  199. data/docs/UsVerifications.md +20 -0
  200. data/docs/UsVerificationsApi.md +157 -0
  201. data/docs/UsVerificationsWritable.md +32 -0
  202. data/docs/ValidationError.md +22 -0
  203. data/docs/Zip.md +26 -0
  204. data/docs/ZipCodeType.md +15 -0
  205. data/docs/ZipEditable.md +18 -0
  206. data/docs/ZipLookupCity.md +26 -0
  207. data/docs/ZipLookupsApi.md +78 -0
  208. data/git_push.sh +57 -0
  209. data/lib/openapi_client/api/addresses_api.rb +318 -0
  210. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  211. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  212. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  213. data/lib/openapi_client/api/buckslips_api.rb +382 -0
  214. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  215. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  216. data/lib/openapi_client/api/cards_api.rb +382 -0
  217. data/lib/openapi_client/api/checks_api.rb +337 -0
  218. data/lib/openapi_client/api/creatives_api.rb +244 -0
  219. data/lib/openapi_client/api/default_api.rb +79 -0
  220. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  221. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  222. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  223. data/lib/openapi_client/api/letters_api.rb +340 -0
  224. data/lib/openapi_client/api/postcards_api.rb +340 -0
  225. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  226. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  227. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  228. data/lib/openapi_client/api/templates_api.rb +397 -0
  229. data/lib/openapi_client/api/uploads_api.rb +604 -0
  230. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  231. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  232. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  233. data/lib/openapi_client/api_client.rb +392 -0
  234. data/lib/openapi_client/api_error.rb +57 -0
  235. data/lib/openapi_client/configuration.rb +279 -0
  236. data/lib/openapi_client/models/address.rb +616 -0
  237. data/lib/openapi_client/models/address_deletion.rb +303 -0
  238. data/lib/openapi_client/models/address_domestic.rb +522 -0
  239. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  240. data/lib/openapi_client/models/address_editable.rb +503 -0
  241. data/lib/openapi_client/models/address_list.rb +324 -0
  242. data/lib/openapi_client/models/bank_account.rb +576 -0
  243. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  244. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  245. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  246. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  247. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  248. data/lib/openapi_client/models/billing_group.rb +395 -0
  249. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  250. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  251. data/lib/openapi_client/models/buckslip.rb +814 -0
  252. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  253. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  254. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  255. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  256. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  257. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  258. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  259. data/lib/openapi_client/models/bulk_error.rb +229 -0
  260. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  261. data/lib/openapi_client/models/campaign.rb +549 -0
  262. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  263. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  264. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  265. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  266. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  267. data/lib/openapi_client/models/card.rb +681 -0
  268. data/lib/openapi_client/models/card_deletion.rb +303 -0
  269. data/lib/openapi_client/models/card_editable.rb +318 -0
  270. data/lib/openapi_client/models/card_list.rb +324 -0
  271. data/lib/openapi_client/models/card_order.rb +438 -0
  272. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  273. data/lib/openapi_client/models/card_order_list.rb +273 -0
  274. data/lib/openapi_client/models/card_updatable.rb +289 -0
  275. data/lib/openapi_client/models/check.rb +802 -0
  276. data/lib/openapi_client/models/check_deletion.rb +303 -0
  277. data/lib/openapi_client/models/check_editable.rb +527 -0
  278. data/lib/openapi_client/models/check_list.rb +324 -0
  279. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  280. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  281. data/lib/openapi_client/models/country_extended.rb +254 -0
  282. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  283. data/lib/openapi_client/models/creative_patch.rb +274 -0
  284. data/lib/openapi_client/models/creative_response.rb +444 -0
  285. data/lib/openapi_client/models/creative_writable.rb +400 -0
  286. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  287. data/lib/openapi_client/models/deliverability_analysis.rb +451 -0
  288. data/lib/openapi_client/models/dpv_footnote.rb +50 -0
  289. data/lib/openapi_client/models/engine_html.rb +37 -0
  290. data/lib/openapi_client/models/event_type.rb +325 -0
  291. data/lib/openapi_client/models/events.rb +365 -0
  292. data/lib/openapi_client/models/export.rb +422 -0
  293. data/lib/openapi_client/models/export_model.rb +262 -0
  294. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  295. data/lib/openapi_client/models/geocode_components.rb +291 -0
  296. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  297. data/lib/openapi_client/models/identity_validation.rb +460 -0
  298. data/lib/openapi_client/models/inline_object.rb +229 -0
  299. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  300. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  301. data/lib/openapi_client/models/intl_components.rb +314 -0
  302. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  303. data/lib/openapi_client/models/intl_verification.rb +463 -0
  304. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  305. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  306. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  307. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  308. data/lib/openapi_client/models/letter.rb +716 -0
  309. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  310. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  311. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  312. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  313. data/lib/openapi_client/models/letter_editable.rb +522 -0
  314. data/lib/openapi_client/models/letter_list.rb +324 -0
  315. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  316. data/lib/openapi_client/models/lob_error.rb +296 -0
  317. data/lib/openapi_client/models/location.rb +289 -0
  318. data/lib/openapi_client/models/location_analysis.rb +305 -0
  319. data/lib/openapi_client/models/mail_type.rb +37 -0
  320. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  321. data/lib/openapi_client/models/multiple_components.rb +405 -0
  322. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  323. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  324. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  325. data/lib/openapi_client/models/postcard.rb +646 -0
  326. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  327. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  328. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  329. data/lib/openapi_client/models/postcard_editable.rb +383 -0
  330. data/lib/openapi_client/models/postcard_list.rb +324 -0
  331. data/lib/openapi_client/models/postcard_size.rb +38 -0
  332. data/lib/openapi_client/models/qr_code.rb +339 -0
  333. data/lib/openapi_client/models/return_envelope.rb +258 -0
  334. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  335. data/lib/openapi_client/models/self_mailer.rb +574 -0
  336. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  337. data/lib/openapi_client/models/self_mailer_editable.rb +374 -0
  338. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  339. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  340. data/lib/openapi_client/models/sort_by.rb +283 -0
  341. data/lib/openapi_client/models/sort_by1.rb +283 -0
  342. data/lib/openapi_client/models/sort_by2.rb +283 -0
  343. data/lib/openapi_client/models/sort_by3.rb +283 -0
  344. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  345. data/lib/openapi_client/models/suggestions.rb +343 -0
  346. data/lib/openapi_client/models/template.rb +406 -0
  347. data/lib/openapi_client/models/template_deletion.rb +303 -0
  348. data/lib/openapi_client/models/template_list.rb +324 -0
  349. data/lib/openapi_client/models/template_update.rb +272 -0
  350. data/lib/openapi_client/models/template_version.rb +423 -0
  351. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  352. data/lib/openapi_client/models/template_version_list.rb +324 -0
  353. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  354. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  355. data/lib/openapi_client/models/template_writable.rb +309 -0
  356. data/lib/openapi_client/models/thumbnail.rb +300 -0
  357. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  358. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  359. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  360. data/lib/openapi_client/models/upload.rb +491 -0
  361. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  362. data/lib/openapi_client/models/upload_file.rb +283 -0
  363. data/lib/openapi_client/models/upload_state.rb +42 -0
  364. data/lib/openapi_client/models/upload_updatable.rb +240 -0
  365. data/lib/openapi_client/models/upload_writable.rb +255 -0
  366. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  367. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  368. data/lib/openapi_client/models/us_components.rb +761 -0
  369. data/lib/openapi_client/models/us_verification.rb +451 -0
  370. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  371. data/lib/openapi_client/models/us_verifications.rb +250 -0
  372. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  373. data/lib/openapi_client/models/validation_error.rb +263 -0
  374. data/lib/openapi_client/models/zip.rb +363 -0
  375. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  376. data/lib/openapi_client/models/zip_editable.rb +246 -0
  377. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  378. data/lib/openapi_client/version.rb +15 -0
  379. data/lib/openapi_client.rb +205 -0
  380. data/openapi_client.gemspec +37 -0
  381. data/spec/api/addresses_api_spec.rb +88 -0
  382. data/spec/api/bank_accounts_api_spec.rb +101 -0
  383. data/spec/api/billing_groups_api_spec.rb +89 -0
  384. data/spec/api/campaigns_api_spec.rb +100 -0
  385. data/spec/api/card_orders_api_spec.rb +62 -0
  386. data/spec/api/cards_api_spec.rb +99 -0
  387. data/spec/api/checks_api_spec.rb +93 -0
  388. data/spec/api/creatives_api_spec.rb +73 -0
  389. data/spec/api/default_api_spec.rb +46 -0
  390. data/spec/api/identity_validation_api_spec.rb +47 -0
  391. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  392. data/spec/api/intl_verifications_api_spec.rb +60 -0
  393. data/spec/api/letters_api_spec.rb +94 -0
  394. data/spec/api/postcards_api_spec.rb +94 -0
  395. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  396. data/spec/api/self_mailers_api_spec.rb +94 -0
  397. data/spec/api/template_versions_api_spec.rb +105 -0
  398. data/spec/api/templates_api_spec.rb +101 -0
  399. data/spec/api/uploads_api_spec.rb +135 -0
  400. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  401. data/spec/api/us_verifications_api_spec.rb +61 -0
  402. data/spec/api/zip_lookups_api_spec.rb +47 -0
  403. data/spec/api_client_spec.rb +226 -0
  404. data/spec/configuration_spec.rb +42 -0
  405. data/spec/spec_helper.rb +105 -13
  406. metadata +442 -210
  407. data/.github/workflows/run_tests_job.yml +0 -32
  408. data/.github/workflows/update_gem.yml +0 -27
  409. data/.gitignore +0 -19
  410. data/CHANGELOG.md +0 -146
  411. data/CONTRIBUTING.md +0 -19
  412. data/LICENSE.txt +0 -22
  413. data/examples/README.md +0 -111
  414. data/examples/checks.rb +0 -49
  415. data/examples/csv_checks/create_checks.rb +0 -48
  416. data/examples/csv_checks/input.csv +0 -6
  417. data/examples/csv_letters/create_letters.rb +0 -41
  418. data/examples/csv_letters/input.csv +0 -6
  419. data/examples/csv_letters/letter_template.html +0 -33
  420. data/examples/csv_postcards/create_postcards.rb +0 -46
  421. data/examples/csv_postcards/input.csv +0 -7
  422. data/examples/csv_postcards/postcard_back.html +0 -38
  423. data/examples/csv_postcards/postcard_front.html +0 -25
  424. data/examples/csv_verify/input.csv +0 -7
  425. data/examples/csv_verify/verify.rb +0 -37
  426. data/examples/letters.rb +0 -73
  427. data/examples/list_postcards_metadata.rb +0 -94
  428. data/examples/postcards.rb +0 -87
  429. data/examples/postcards_idempotent.rb +0 -92
  430. data/examples/postcards_intl.rb +0 -87
  431. data/examples/postcards_remote.rb +0 -87
  432. data/examples/postcards_send_date.rb +0 -97
  433. data/examples/postcards_template.rb +0 -98
  434. data/examples/self_mailers.rb +0 -38
  435. data/lib/lob/client.rb +0 -91
  436. data/lib/lob/errors/invalid_request_error.rb +0 -4
  437. data/lib/lob/errors/lob_error.rb +0 -20
  438. data/lib/lob/resources/address.rb +0 -14
  439. data/lib/lob/resources/bank_account.rb +0 -30
  440. data/lib/lob/resources/bulk_intl_verifications.rb +0 -26
  441. data/lib/lob/resources/bulk_us_verifications.rb +0 -27
  442. data/lib/lob/resources/check.rb +0 -14
  443. data/lib/lob/resources/group.rb +0 -14
  444. data/lib/lob/resources/groups_member.rb +0 -66
  445. data/lib/lob/resources/intl_verifications.rb +0 -26
  446. data/lib/lob/resources/letter.rb +0 -14
  447. data/lib/lob/resources/postcard.rb +0 -14
  448. data/lib/lob/resources/resource_base.rb +0 -150
  449. data/lib/lob/resources/self_mailer.rb +0 -14
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  452. data/lib/lob/resources/us_verifications.rb +0 -27
  453. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  454. data/lib/lob/version.rb +0 -3
  455. data/lib/lob.rb +0 -7
  456. data/lob.gemspec +0 -31
  457. data/spec/lob/errors/lob_error_spec.rb +0 -19
  458. data/spec/lob/resources/address_spec.rb +0 -55
  459. data/spec/lob/resources/bank_account_spec.rb +0 -60
  460. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -30
  461. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -37
  462. data/spec/lob/resources/check_spec.rb +0 -119
  463. data/spec/lob/resources/group_spec.rb +0 -50
  464. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  465. data/spec/lob/resources/letter_spec.rb +0 -114
  466. data/spec/lob/resources/member_spec.rb +0 -65
  467. data/spec/lob/resources/postcard_spec.rb +0 -160
  468. data/spec/lob/resources/resource_base_spec.rb +0 -75
  469. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  470. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  471. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  472. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  473. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  474. data/spec/lob_spec.rb +0 -48
  475. data/spec/samples/8.5x11.pdf +0 -0
  476. data/spec/samples/postcardback.pdf +2 -2287
  477. data/spec/samples/postcardfront.pdf +1 -1549
  478. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  479. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  480. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  481. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,42 @@
1
+ # ZipLookup.unit.rb
2
+
3
+ include OpenapiClient
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "ZipLookupsApi" do
7
+
8
+ it "can be instantiated" do
9
+ zipLookupApiMock = double("ApiClient")
10
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
11
+
12
+ expect(zipLookupApi).not_to be_nil
13
+ expect(zipLookupApi).to be_a_kind_of(ZipLookupsApi)
14
+ end
15
+
16
+ describe "Lookup" do
17
+ it "handles errors returned by the api" do
18
+ zipLookupApiMock = double("ApiClient")
19
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
20
+ zip = Zip.new
21
+
22
+ allow(zipLookupApi).to receive(:lookup).and_raise("exception thrown in lookup test")
23
+ begin
24
+ response = zipLookupApi.lookup(zip)
25
+ rescue => err
26
+ expect(err.message).to eq("exception thrown in lookup test")
27
+ end
28
+ end
29
+
30
+ it "lookup a zip code" do
31
+ zipLookupApiMock = double("ApiClient")
32
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
33
+ zip = Zip.new
34
+ zip.id = "us_zip_fakeId"
35
+
36
+ allow(zipLookupApi).to receive(:lookup) { zip }
37
+ response = zipLookupApi.lookup("12345")
38
+
39
+ expect(response.id).to eq("us_zip_fakeId")
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,200 @@
1
+ # Address.unit.rb
2
+ require_relative '../TestFixtures'
3
+ include OpenapiClient
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'api/addresses_api'
6
+ require 'models/address'
7
+ require 'models/address_editable'
8
+
9
+ RSpec.describe "AddressesApi" do
10
+ it "can be instantiated" do
11
+ addressApi = AddressesApi.new()
12
+
13
+ expect(addressApi).not_to be_nil
14
+ expect(addressApi).to be_a_kind_of(AddressesApi)
15
+ end
16
+
17
+ describe "Create" do
18
+ before(:all) do
19
+ @api = TestFixtures.api_client_with_test_key()
20
+ end
21
+
22
+ it "creates a new address" do
23
+ addressApi = AddressesApi.new(@api)
24
+ addressEditable = AddressEditable.new({
25
+ name: "Thing T. Thing",
26
+ address_line1: "1313 CEMETERY LN",
27
+ address_city: "WESTFIELD",
28
+ address_state: "NJ",
29
+ address_zip: "07000",
30
+ })
31
+
32
+ response = addressApi.create(addressEditable)
33
+ adrId = response.id
34
+
35
+ expect(response.address_line1).to eq(addressEditable.address_line1)
36
+
37
+ # delete it afterwards
38
+ addressApi.delete(adrId)
39
+ end
40
+
41
+ it "handles errors returned by the api" do
42
+ addressApi = AddressesApi.new(@api)
43
+ addressEditable = AddressEditable.new()
44
+ begin
45
+ response = addressApi.create(addressEditable)
46
+ rescue => err
47
+ expect(err.message.include? "address_line1 is required").to be(true)
48
+ end
49
+ end
50
+
51
+ it "does not allow creation with invalid key" do
52
+ config = OpenapiClient::Configuration.default
53
+ config.username = "fake key"
54
+ badapi = OpenapiClient::ApiClient.new(config)
55
+
56
+ addressApi = AddressesApi.new(badapi)
57
+ addressEditable = AddressEditable.new({
58
+ name: "Thing T. Thing",
59
+ address_line1: "1313 CEMETERY LN",
60
+ address_city: "WESTFIELD",
61
+ address_state: "NJ",
62
+ address_zip: "07000",
63
+ })
64
+
65
+ begin
66
+ response = addressApi.create(addressEditable)
67
+ rescue => err
68
+ expect(err.message.include? "Your API key is not valid.").to be(true)
69
+ end
70
+ end
71
+ end
72
+
73
+ describe "Get" do
74
+ before(:all) do
75
+ @api = TestFixtures.api_client_with_test_key()
76
+
77
+ @addressApi = AddressesApi.new(@api)
78
+ addressEditable = AddressEditable.new({
79
+ name: "Thing T. Thing",
80
+ address_line1: "1313 CEMETERY LN",
81
+ address_city: "WESTFIELD",
82
+ address_state: "NJ",
83
+ address_zip: "07000",
84
+ })
85
+
86
+ response = @addressApi.create(addressEditable)
87
+ @addressId = response.id
88
+ end
89
+
90
+ it "retrieves an address" do
91
+ response = @addressApi.get(@addressId)
92
+
93
+ expect(response).not_to be_nil()
94
+ expect(response.id).to eq(@addressId)
95
+ end
96
+
97
+ after(:all) do
98
+ api = TestFixtures.api_client_with_test_key()
99
+ addressApi = AddressesApi.new(api)
100
+ addressApi.delete(@addressId)
101
+ end
102
+ end
103
+
104
+ describe "List" do
105
+ before(:all) do
106
+ @api = TestFixtures.api_client_with_test_key()
107
+ @addressApi = AddressesApi.new(@api)
108
+
109
+ addressEditable1 = AddressEditable.new({
110
+ name: "Thing T. Thing",
111
+ address_line1: "1313 CEMETERY LN",
112
+ address_city: "WESTFIELD",
113
+ address_state: "NJ",
114
+ address_zip: "07000",
115
+ })
116
+
117
+ addressEditable2 = AddressEditable.new({
118
+ name: "FESTER",
119
+ address_line1: "001 CEMETERY LN",
120
+ address_line2: "SUITE 666",
121
+ address_city: "WESTFIELD ",
122
+ address_state: "NJ",
123
+ address_zip: "07000",
124
+ })
125
+
126
+ addressEditable3 = AddressEditable.new({
127
+ name: "MORTICIA ADDAMS",
128
+ address_line1: "1212 CEMETERY LANE",
129
+ address_city: "WESTFIELD",
130
+ address_state: "NJ",
131
+ address_zip: "07000",
132
+ })
133
+
134
+ response1 = @addressApi.create(addressEditable1)
135
+ response2 = @addressApi.create(addressEditable2)
136
+ response3 = @addressApi.create(addressEditable3)
137
+
138
+ @address1Id = response1.id
139
+ @address2Id = response2.id
140
+ @address3Id = response3.id
141
+ end
142
+
143
+ it "lists addresses" do
144
+ response = @addressApi.list()
145
+
146
+ expect(response.data.length()).to be > 0
147
+ end
148
+
149
+ it "lists addresses with after param" do
150
+ response = @addressApi.list()
151
+ responseAfter = @addressApi.list(after: response.getNextPageToken())
152
+ expect(responseAfter.data.length()).to be > 0
153
+ end
154
+
155
+ it "lists addresses with before param" do
156
+ response = @addressApi.list()
157
+ responseAfter = @addressApi.list(before: response.getNextPageToken())
158
+ expect(responseAfter.data.length()).to be > 0
159
+ end
160
+
161
+ it "lists addresses with a limit parameter" do
162
+ response = @addressApi.list(limit: 2)
163
+
164
+ expect(response.data.length()).to be(2)
165
+ end
166
+
167
+ after(:all) do
168
+ api = TestFixtures.api_client_with_test_key()
169
+ addressApi = AddressesApi.new(api)
170
+ addressApi.delete(@address1Id)
171
+ addressApi.delete(@address2Id)
172
+ addressApi.delete(@address3Id)
173
+ end
174
+ end
175
+
176
+ describe "Delete" do
177
+ before(:all) do
178
+ @api = TestFixtures.api_client_with_test_key()
179
+
180
+ @addressApi = AddressesApi.new(@api)
181
+ addressEditable = AddressEditable.new({
182
+ name: "Thing T. Thing",
183
+ address_line1: "1313 CEMETERY LN",
184
+ address_city: "WESTFIELD",
185
+ address_state: "NJ",
186
+ address_zip: "07000",
187
+ })
188
+
189
+ response = @addressApi.create(addressEditable)
190
+ @addressId = response.id
191
+ end
192
+
193
+ it "deletes an address" do
194
+ response = @addressApi.delete(@addressId)
195
+
196
+ expect(response.id).to eq(@addressId)
197
+ expect(response.deleted).to eq(true)
198
+ end
199
+ end
200
+ end
@@ -0,0 +1,243 @@
1
+ # BankAccount.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include OpenapiClient
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'uri'
6
+
7
+ RSpec.describe "BankAccountsApi" do
8
+ it "can be instantiated" do
9
+ bankAccountApi = BankAccountsApi.new()
10
+
11
+ expect(bankAccountApi).not_to be_nil
12
+ expect(bankAccountApi).to be_a_kind_of(BankAccountsApi)
13
+ end
14
+
15
+ describe "Create" do
16
+ before(:all) do
17
+ api = TestFixtures.api_client_with_test_key()
18
+ @bankAccountApi = BankAccountsApi.new(api)
19
+
20
+ @bankAccountWritable = BankAccountWritable.new({
21
+ routing_number: "322271627",
22
+ account_number: "123456789",
23
+ signatory: "Sigourney Lobster",
24
+ account_type: BankTypeEnum::INDIVIDUAL
25
+ })
26
+ end
27
+
28
+ it "creates a new bank account" do
29
+ createdBankAccount = @bankAccountApi.create(@bankAccountWritable)
30
+ expect(createdBankAccount.id).not_to be_nil
31
+
32
+ # delete it in the end
33
+ @bankAccountApi.delete(createdBankAccount.id)
34
+ end
35
+
36
+ it "handles errors returned by the api" do
37
+ bankAccountWritable = BankAccountWritable.new()
38
+ begin
39
+ response = @bankAccountApi.create(bankAccountWritable)
40
+ rescue => err
41
+ expect(err.message.include? "routing_number is required").to be(true)
42
+ end
43
+ end
44
+
45
+ it "does not allow creation with invalid key" do
46
+ config = OpenapiClient::Configuration.default
47
+ config.username = "fake key"
48
+ badapi = OpenapiClient::ApiClient.new(config)
49
+
50
+ bankAccountApi = BankAccountsApi.new(badapi)
51
+
52
+ begin
53
+ response = bankAccountApi.create(@bankAccountWritable)
54
+ rescue => err
55
+ expect(err.message.include? "Your API key is not valid.").to be(true)
56
+ end
57
+ end
58
+ end
59
+
60
+ describe "Verify" do
61
+ before(:all) do
62
+ api = TestFixtures.api_client_with_test_key()
63
+ @bankAccountApi = BankAccountsApi.new(api)
64
+
65
+ bankAccountWritable = BankAccountWritable.new({
66
+ routing_number: "322271627",
67
+ account_number: "123456789",
68
+ signatory: "Sigourney Lobster",
69
+ account_type: BankTypeEnum::INDIVIDUAL
70
+ })
71
+
72
+ response = @bankAccountApi.create(bankAccountWritable)
73
+ @bankAccountId = response.id
74
+ end
75
+
76
+ it "verifies a bank account" do
77
+ bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
78
+ response = @bankAccountApi.verify(@bankAccountId, bankVerify)
79
+
80
+ expect(response).not_to be_nil()
81
+ expect(response.id).to eq(@bankAccountId)
82
+ end
83
+
84
+ it "handles errors returned by the api" do
85
+ bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
86
+ begin
87
+ response = @bankAccountApi.verify("bank_fakeId", bankVerify)
88
+ rescue => err
89
+ expect(err.message.include? "bank account not found").to be(true)
90
+ end
91
+ end
92
+
93
+ after(:all) do
94
+ @bankAccountApi.delete(@bankAccountId)
95
+ end
96
+ end
97
+
98
+ describe "Get" do
99
+ before(:all) do
100
+ api = TestFixtures.api_client_with_test_key()
101
+ @bankAccountApi = BankAccountsApi.new(api)
102
+
103
+ bankAccountWritable = BankAccountWritable.new({
104
+ routing_number: "322271627",
105
+ account_number: "123456789",
106
+ signatory: "Sigourney Lobster",
107
+ account_type: BankTypeEnum::INDIVIDUAL
108
+ })
109
+
110
+ response = @bankAccountApi.create(bankAccountWritable)
111
+ @bankAccountId = response.id
112
+ end
113
+
114
+ it "retrieves a bank account" do
115
+ response = @bankAccountApi.get(@bankAccountId)
116
+
117
+ expect(response).not_to be_nil()
118
+ expect(response.id).to eq(@bankAccountId)
119
+ end
120
+
121
+ after(:all) do
122
+ @bankAccountApi.delete(@bankAccountId)
123
+ end
124
+ end
125
+
126
+ describe "List" do
127
+ before(:all) do
128
+ api = TestFixtures.api_client_with_test_key()
129
+ @bankAccountApi = BankAccountsApi.new(api)
130
+
131
+ bankAccountWritable1 = BankAccountWritable.new({
132
+ routing_number: "322271627",
133
+ account_number: "123456789",
134
+ signatory: "Sigourney Lobster",
135
+ account_type: BankTypeEnum::INDIVIDUAL
136
+ })
137
+
138
+ bankAccountWritable2 = BankAccountWritable.new({
139
+ routing_number: "322271627",
140
+ account_number: "123456789",
141
+ signatory: "Sigourney Lobster",
142
+ account_type: BankTypeEnum::INDIVIDUAL
143
+ })
144
+
145
+ bankAccountWritable3 = BankAccountWritable.new({
146
+ routing_number: "322271627",
147
+ account_number: "123456789",
148
+ signatory: "Sigourney Lobster",
149
+ account_type: BankTypeEnum::INDIVIDUAL
150
+ })
151
+
152
+ response1 = @bankAccountApi.create(bankAccountWritable1)
153
+ response2 = @bankAccountApi.create(bankAccountWritable2)
154
+ response3 = @bankAccountApi.create(bankAccountWritable3)
155
+
156
+ @bankAccount1Id = response1.id
157
+ @bankAccount2Id = response2.id
158
+ @bankAccount3Id = response3.id
159
+ end
160
+
161
+ it "lists bank accounts with limit, before, and after params" do
162
+ response = @bankAccountApi.list({ :"limit" => 2 })
163
+
164
+ expect(response.data.length()).to be == 2
165
+ first_bank_id = response.data[0].id
166
+
167
+ uri = URI.parse(response.next_url)
168
+ params = CGI.parse(uri.query)
169
+
170
+ response = @bankAccountApi.list({ :"limit" => 2, :"after" => params["after"][0] })
171
+
172
+ expect(response.data[0].id).not_to eq(first_bank_id)
173
+
174
+ uri = URI.parse(response.previous_url)
175
+ params = CGI.parse(uri.query)
176
+
177
+ response = @bankAccountApi.list({ :"limit" => 2, :"before" => params["before"][0] })
178
+ expect(response.data[0].id).not_to be_nil
179
+
180
+ end
181
+
182
+ [
183
+ [nil, nil, nil, nil],
184
+ ["include", Array.new(1, "total_count"), nil, nil],
185
+ ["date_created", nil, { "gt" => "2020-01-01" }, nil],
186
+ ["metadata", nil, nil, '{ "name": "Harry" }'],
187
+ ].each do |which_param, include_param, date_created, metadata|
188
+ it "lists bank accounts #{which_param && ("with " + which_param + " param")}" do
189
+ args = {}
190
+
191
+ if include_param then
192
+ args[:"include"] = include_param
193
+ end
194
+
195
+ if date_created then
196
+ args[:"date_created"] = date_created
197
+ end
198
+
199
+ if metadata then
200
+ args[:"metadata"] = metadata
201
+ end
202
+
203
+ response = @bankAccountApi.list(args)
204
+
205
+ expect(response.data.length()).to be > 0
206
+
207
+ if include_param
208
+ expect(response.total_count).to be
209
+ end
210
+ end
211
+ end
212
+
213
+ after(:all) do
214
+ @bankAccountApi.delete(@bankAccount1Id)
215
+ @bankAccountApi.delete(@bankAccount2Id)
216
+ @bankAccountApi.delete(@bankAccount3Id)
217
+ end
218
+ end
219
+
220
+ describe "Delete" do
221
+ before(:all) do
222
+ api = TestFixtures.api_client_with_test_key()
223
+ @bankAccountApi = BankAccountsApi.new(api)
224
+
225
+ bankAccountWritable = BankAccountWritable.new({
226
+ routing_number: "322271627",
227
+ account_number: "123456789",
228
+ signatory: "Sigourney Lobster",
229
+ account_type: BankTypeEnum::INDIVIDUAL
230
+ })
231
+
232
+ response = @bankAccountApi.create(bankAccountWritable)
233
+ @bankAccountId = response.id
234
+ end
235
+
236
+ it "deletes a bank account" do
237
+ response = @bankAccountApi.delete(@bankAccountId)
238
+
239
+ expect(response.id).to eq(@bankAccountId)
240
+ expect(response.deleted).to eq(true)
241
+ end
242
+ end
243
+ end
@@ -0,0 +1,163 @@
1
+ # BillingGroup.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include OpenapiClient
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'uri'
6
+
7
+ RSpec.describe "BillingGroupsApi" do
8
+ it "can be instantiated" do
9
+ billingGroupApi = BillingGroupsApi.new()
10
+
11
+ expect(billingGroupApi).not_to be_nil
12
+ expect(billingGroupApi).to be_a_kind_of(BillingGroupsApi)
13
+ end
14
+
15
+ describe "Create" do
16
+ before(:all) do
17
+ api = TestFixtures.api_client_with_test_key()
18
+ @billingGroupApi = BillingGroupsApi.new(api)
19
+
20
+ @billingGroupEditable = BillingGroupEditable.new({
21
+ name: "Ruby Integration Test BG"
22
+ })
23
+ end
24
+
25
+ it "creates a new billing group" do
26
+ createdBillingGroup = @billingGroupApi.create(@billingGroupEditable)
27
+ expect(createdBillingGroup.id).not_to be_nil
28
+ end
29
+
30
+ it "handles errors returned by the api" do
31
+ billingGroupEditable = BillingGroupEditable.new()
32
+ begin
33
+ response = @billingGroupApi.create(billingGroupEditable)
34
+ rescue => err
35
+ expect(err.message.include? "name is required").to be(true)
36
+ end
37
+ end
38
+
39
+ it "does not allow creation with invalid key" do
40
+ config = OpenapiClient::Configuration.default
41
+ config.username = "fake key"
42
+ badapi = OpenapiClient::ApiClient.new(config)
43
+
44
+ billingGroupApi = BillingGroupsApi.new(badapi)
45
+
46
+ begin
47
+ response = billingGroupApi.create(@billingGroupEditable)
48
+ rescue => err
49
+ expect(err.message.include? "Your API key is not valid.").to be(true)
50
+ end
51
+ end
52
+ end
53
+
54
+ describe "Update" do
55
+ before(:all) do
56
+ api = TestFixtures.api_client_with_test_key()
57
+ @billingGroupApi = BillingGroupsApi.new(api)
58
+
59
+ billingGroupEditable = BillingGroupEditable.new({
60
+ name: "Ruby Integration Test BG"
61
+ })
62
+
63
+ response = @billingGroupApi.create(billingGroupEditable)
64
+ @billingGroupId = response.id
65
+ end
66
+
67
+ it "updates a billing group" do
68
+ bgUpdatable = BillingGroupEditable.new({ name: "Updated Test Billing Group" })
69
+ response = @billingGroupApi.update(@billingGroupId, bgUpdatable)
70
+
71
+ expect(response.name).to eq("Updated Test Billing Group")
72
+ expect(response.id).to eq(@billingGroupId)
73
+ end
74
+
75
+ it "handles errors returned by the api" do
76
+ bgUpdatable = BillingGroupEditable.new({ name: "Updated Test Billing Group" })
77
+ begin
78
+ response = @billingGroupApi.update("bg_fakeId", bgUpdatable)
79
+ rescue => err
80
+ expect(err.message.include? "billing_group not found").to be(true)
81
+ end
82
+ end
83
+ end
84
+
85
+ describe "Get" do
86
+ before(:all) do
87
+ api = TestFixtures.api_client_with_test_key()
88
+ @billingGroupApi = BillingGroupsApi.new(api)
89
+
90
+ billingGroupEditable = BillingGroupEditable.new({
91
+ name: "Ruby Integration Test BG"
92
+ })
93
+
94
+ response = @billingGroupApi.create(billingGroupEditable)
95
+ @billingGroupId = response.id
96
+ end
97
+
98
+ it "retrieves a billing group" do
99
+ response = @billingGroupApi.get(@billingGroupId)
100
+
101
+ expect(response).not_to be_nil()
102
+ expect(response.id).to eq(@billingGroupId)
103
+ end
104
+ end
105
+
106
+ describe "List" do
107
+ before(:all) do
108
+ api = TestFixtures.api_client_with_test_key()
109
+ @billingGroupApi = BillingGroupsApi.new(api)
110
+ end
111
+
112
+ [
113
+ [nil, nil, nil, nil, nil, nil, nil],
114
+ ["limit", 2, nil, nil, nil, nil, nil],
115
+ ["offset", nil, 1, nil, nil, nil, nil],
116
+ ["include", nil, nil, Array.new(1, "total_count"), nil, nil, nil],
117
+ ["date_created", nil, nil, nil, { "gt" => "2020-01-01" }, nil, nil],
118
+ ["date_modified", nil, nil, nil, nil, { "gt" => "2020-01-01" }, nil],
119
+ ["sort_by", nil, nil, nil, nil, nil, { "date_modified": "asc" }]
120
+ ].each do |which_param, limit, offset, include_param, date_created, date_modified, sort_by|
121
+ it "lists billing groups #{which_param && ("with " + which_param + " param")}" do
122
+ args = {}
123
+
124
+ if limit then
125
+ args[:"limit"] = limit
126
+ end
127
+
128
+ if offset then
129
+ args[:"offset"] = offset
130
+ end
131
+
132
+ if include_param then
133
+ args[:"include"] = include_param
134
+ end
135
+
136
+ if date_created then
137
+ args[:"date_created"] = date_created
138
+ end
139
+
140
+ if date_modified then
141
+ args[:"date_modified"] = date_modified
142
+ end
143
+
144
+ if sort_by then
145
+ args[:"sort_by"] = sort_by
146
+ end
147
+
148
+ response = @billingGroupApi.list(args)
149
+
150
+ expect(response.data.length()).to be > 0
151
+
152
+ if limit then
153
+ expect(response.data.length()).to be == limit
154
+ end
155
+
156
+ # seems to be broken
157
+ # if include_param
158
+ # expect(response.total_count).to be
159
+ # end
160
+ end
161
+ end
162
+ end
163
+ end