lob 5.4.6 → 6.0.0.pre.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (486) 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 -217
  407. data/.github/workflows/forked_tests_job.yml +0 -36
  408. data/.github/workflows/run_tests_job.yml +0 -32
  409. data/.github/workflows/update_gem.yml +0 -27
  410. data/.gitignore +0 -19
  411. data/CHANGELOG.md +0 -148
  412. data/CONTRIBUTING.md +0 -19
  413. data/LICENSE.txt +0 -22
  414. data/examples/README.md +0 -119
  415. data/examples/cards.rb +0 -51
  416. data/examples/checks.rb +0 -49
  417. data/examples/csv_checks/create_checks.rb +0 -48
  418. data/examples/csv_checks/input.csv +0 -6
  419. data/examples/csv_letters/create_letters.rb +0 -41
  420. data/examples/csv_letters/input.csv +0 -6
  421. data/examples/csv_letters/letter_template.html +0 -33
  422. data/examples/csv_postcards/create_postcards.rb +0 -46
  423. data/examples/csv_postcards/input.csv +0 -7
  424. data/examples/csv_postcards/postcard_back.html +0 -38
  425. data/examples/csv_postcards/postcard_front.html +0 -25
  426. data/examples/csv_verify/input.csv +0 -7
  427. data/examples/csv_verify/verify.rb +0 -37
  428. data/examples/letters.rb +0 -73
  429. data/examples/list_postcards_metadata.rb +0 -94
  430. data/examples/postcards.rb +0 -87
  431. data/examples/postcards_idempotent.rb +0 -92
  432. data/examples/postcards_intl.rb +0 -87
  433. data/examples/postcards_remote.rb +0 -87
  434. data/examples/postcards_send_date.rb +0 -97
  435. data/examples/postcards_template.rb +0 -98
  436. data/examples/self_mailers.rb +0 -38
  437. data/lib/lob/client.rb +0 -96
  438. data/lib/lob/errors/invalid_request_error.rb +0 -4
  439. data/lib/lob/errors/lob_error.rb +0 -20
  440. data/lib/lob/resources/address.rb +0 -14
  441. data/lib/lob/resources/bank_account.rb +0 -30
  442. data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
  443. data/lib/lob/resources/bulk_us_verifications.rb +0 -28
  444. data/lib/lob/resources/card.rb +0 -46
  445. data/lib/lob/resources/check.rb +0 -14
  446. data/lib/lob/resources/group.rb +0 -14
  447. data/lib/lob/resources/groups_member.rb +0 -66
  448. data/lib/lob/resources/intl_verifications.rb +0 -26
  449. data/lib/lob/resources/letter.rb +0 -14
  450. data/lib/lob/resources/postcard.rb +0 -14
  451. data/lib/lob/resources/resource_base.rb +0 -150
  452. data/lib/lob/resources/self_mailer.rb +0 -14
  453. data/lib/lob/resources/us_autocompletions.rb +0 -26
  454. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  455. data/lib/lob/resources/us_verifications.rb +0 -27
  456. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  457. data/lib/lob/version.rb +0 -3
  458. data/lib/lob.rb +0 -7
  459. data/lob.gemspec +0 -31
  460. data/spec/lob/errors/lob_error_spec.rb +0 -19
  461. data/spec/lob/resources/address_spec.rb +0 -55
  462. data/spec/lob/resources/bank_account_spec.rb +0 -60
  463. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
  464. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
  465. data/spec/lob/resources/card_spec.rb +0 -145
  466. data/spec/lob/resources/check_spec.rb +0 -119
  467. data/spec/lob/resources/group_spec.rb +0 -50
  468. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  469. data/spec/lob/resources/letter_spec.rb +0 -114
  470. data/spec/lob/resources/member_spec.rb +0 -65
  471. data/spec/lob/resources/postcard_spec.rb +0 -160
  472. data/spec/lob/resources/resource_base_spec.rb +0 -75
  473. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  474. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  475. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  476. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  477. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  478. data/spec/lob_spec.rb +0 -48
  479. data/spec/samples/8.5x11.pdf +0 -0
  480. data/spec/samples/card.pdf +1 -743
  481. data/spec/samples/postcardback.pdf +2 -2287
  482. data/spec/samples/postcardfront.pdf +1 -1549
  483. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  484. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  485. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  486. data/spec/samples/sfm-6x18-outside.pdf +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ba5df9cb717ab1c37b9ee4741304e8d5afa77d2e78c323d25f6d81e541f463ae
4
- data.tar.gz: f0b0e80db2cfafa53427676ff2ff66edf02f85f1e7b1c98acaeb7f5e5426de84
3
+ metadata.gz: 47b698e7d8180eb422b48f533ecfb7ae2371a6d8d4367a669e3d1c28b28dcbc9
4
+ data.tar.gz: 28c4f1e8d45c9d035cca90a0569760c0a17a1ff13ed73eb14ed4c65838550c9e
5
5
  SHA512:
6
- metadata.gz: 40ad0b305524f54b28a1a08c83108aed912e6c23c096fb55be0d8f713bb6a2a1108f334c0d8949e88aa0139ab0e0fed71077b4e9af140829ab41643c9d0cc235
7
- data.tar.gz: 7e9cbf18e676c609a09ff2bc32c60931c69c5fd5334ef82b905d2f7bc62c36086121ccd48e67e4b3a3f1cf5b64e87c5237f6ccd5bbcaaa36ef0d680bbccbd070
6
+ metadata.gz: a44faa61acce18b83c6f747ac5d577d1f45205affba3d37ac39d960392676c0f7c614224962016d693b2df6ef65ac900a3bbcdb1829551e4845baf50b6280ca1
7
+ data.tar.gz: b2b02327af966724a28f6167cfe742b53b4a6eac1fc1f04938d49d560ca2d4d322787c95ea2e433e7e12f422b3d408e1080e9854a68ef7361bb8e80619ace9c9
data/Gemfile CHANGED
@@ -1,4 +1,9 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
- # Specify your gem's dependencies in lob.gemspec
4
3
  gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 13.0.1'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,70 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ lob (6.0.0.pre.rc)
5
+ typhoeus (~> 1.0, >= 1.0.1)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ ast (2.4.2)
11
+ byebug (11.1.3)
12
+ coderay (1.1.3)
13
+ diff-lcs (1.5.0)
14
+ ethon (0.16.0)
15
+ ffi (>= 1.15.0)
16
+ ffi (1.15.5)
17
+ jaro_winkler (1.5.4)
18
+ method_source (1.0.0)
19
+ parallel (1.22.1)
20
+ parser (3.1.3.0)
21
+ ast (~> 2.4.1)
22
+ pry (0.14.1)
23
+ coderay (~> 1.1)
24
+ method_source (~> 1.0)
25
+ pry-byebug (3.10.1)
26
+ byebug (~> 11.0)
27
+ pry (>= 0.13, < 0.15)
28
+ psych (5.0.1)
29
+ stringio
30
+ rainbow (3.1.1)
31
+ rake (13.0.6)
32
+ rspec (3.12.0)
33
+ rspec-core (~> 3.12.0)
34
+ rspec-expectations (~> 3.12.0)
35
+ rspec-mocks (~> 3.12.0)
36
+ rspec-core (3.12.0)
37
+ rspec-support (~> 3.12.0)
38
+ rspec-expectations (3.12.1)
39
+ diff-lcs (>= 1.2.0, < 2.0)
40
+ rspec-support (~> 3.12.0)
41
+ rspec-mocks (3.12.1)
42
+ diff-lcs (>= 1.2.0, < 2.0)
43
+ rspec-support (~> 3.12.0)
44
+ rspec-support (3.12.0)
45
+ rubocop (0.66.0)
46
+ jaro_winkler (~> 1.5.1)
47
+ parallel (~> 1.10)
48
+ parser (>= 2.5, != 2.5.1.1)
49
+ psych (>= 3.1.0)
50
+ rainbow (>= 2.2.2, < 4.0)
51
+ ruby-progressbar (~> 1.7)
52
+ unicode-display_width (>= 1.4.0, < 1.6)
53
+ ruby-progressbar (1.11.0)
54
+ stringio (3.0.4)
55
+ typhoeus (1.4.0)
56
+ ethon (>= 0.9.0)
57
+ unicode-display_width (1.5.0)
58
+
59
+ PLATFORMS
60
+ x86_64-linux
61
+
62
+ DEPENDENCIES
63
+ lob!
64
+ pry-byebug
65
+ rake (~> 13.0.1)
66
+ rspec (~> 3.6, >= 3.6.0)
67
+ rubocop (~> 0.66.0)
68
+
69
+ BUNDLED WITH
70
+ 2.3.26
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Lob
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,139 +1,136 @@
1
- # lob-ruby
1
+ # lob-ruby-sdk
2
+ The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
2
3
 
3
- [![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby)
4
- [![Gem Version](https://badge.fury.io/rb/lob.svg)](https://badge.fury.io/rb/lob)
5
- [![Coverage Status](https://coveralls.io/repos/lob/lob-ruby/badge.svg?branch=master)](https://coveralls.io/r/lob/lob-ruby?branch=master)
6
- [![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/lob?color=green&type=total)](https://rubygems.org/gems/lob)
4
+ This Ruby package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
7
5
 
8
- Ruby wrapper for the [Lob.com](https://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby). For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
6
+ - API version: 1.3.0
7
+ - Package version: 1.0.0
8
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
9
+ For more information, please visit [https://support.lob.com/](https://support.lob.com/)
9
10
 
10
- Supports Ruby 2.0.0 and greater.
11
+ ## Requirements
11
12
 
12
- ## Table of Contents
13
-
14
- - [Table of Contents](#table-of-contents)
15
- - [Getting Started](#getting-started)
16
- - [Registration](#registration)
17
- - [Installation](#installation)
18
- - [Usage](#usage)
19
- - [Initialization and Configuration](#initialization-and-configuration)
20
- - [Caution: Pass zero-prefixed zip codes as strings](#caution-pass-zero-prefixed-zip-codes-as-strings)
21
- - [Accessing Response Headers](#accessing-response-headers)
22
- - [Examples](#examples)
23
- - [API Documentation](#api-documentation)
24
- - [Contributing](#contributing)
25
- - [Testing](#testing)
13
+ Ruby
26
14
 
27
15
  ## Getting Started
28
16
 
29
- Here's a general overview of the Lob services available, click through to read more.
30
-
31
- - [Postcards API](https://lob.com/products/print-mail/postcards)
32
- - [Letters API](https://lob.com/products/print-mail/letters)
33
- - [Checks API](https://lob.com/products/print-mail/checks)
34
- - [Address Verification API](https://lob.com/products/address-verification)
35
-
36
- Please read through the official [API Documentation](#api-documentation) to get a complete sense of what to expect from each endpoint.
37
-
38
17
  ### Registration
39
18
 
40
19
  First, you will need to first create an account at [Lob.com](https://dashboard.lob.com/#/register) and obtain your Test and Live API Keys.
41
20
 
42
21
  Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).
43
22
 
44
- ### Installation
45
-
46
- Add this line to your application's `Gemfile`:
47
-
48
- gem 'lob'
49
-
50
- And then execute:
51
-
52
- $ bundle
53
-
54
- Or manually install it yourself:
23
+ ### Installation & Usage
55
24
 
56
- $ gem install lob
25
+ Install with the appropriate [package manager](https://www.ruby-lang.org/en/documentation/installation/#winget).
57
26
 
58
- ### Usage
59
-
60
- The library uses an ActiveRecord-style interface. You'll feel right at home.
27
+ Then add Lob's Ruby SDK to your Gemfile
28
+ ```ruby
29
+ gem 'openapi_client'
30
+ ```
61
31
 
62
- For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
32
+ If you're using [Bundler](https://bundler.io/) to manage your dependencies, then you can install our SDK by running this on the command line
33
+ ```shell
34
+ $ bundle add openapi_client
35
+ ```
63
36
 
64
- #### Initialization and Configuration
37
+ If you're not using Bundler, then you can install our SDK by running the following instead
38
+ ```shell
39
+ $ gem install openapi_client
40
+ ```
65
41
 
42
+ And finally import the package in your `.rb` file
66
43
  ```ruby
67
- # To initialize a Lob object
68
- lob = Lob::Client.new(api_key: "your-api-key")
69
-
70
- # To initialize a Lob object with an older API version
71
- lob = Lob::Client.new(api_key: "your-api-key", api_version: "2014-12-18")
72
-
73
- # To initialize a Lob object that needs to communicate via a proxy
74
- lob = Lob::Client.new(api_key: "your-api-key", proxy: "http://proxy.example.com)
44
+ require 'openapi_client'
75
45
  ```
76
46
 
77
- #### Caution: Pass zero-prefixed zip codes as strings
47
+ ## First API Call
48
+
49
+ ```ruby
50
+ # Load the gem
51
+ require 'openapi_client'
78
52
 
79
- When using zip codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
53
+ # Setup authorization
54
+ OpenapiClient.configure do |config|
55
+ # Configure HTTP basic authorization: basicAuth
56
+ config.username = '<YOUR_LOB_API_KEY>'
57
+ end
80
58
 
81
- The Ruby interpreter interprets a number with a leading zero as an octal (i.e., base-8) number and converts it to a base-10 number. Thus `01000` is converted to the base-10 value `512` (since `8*8*8=512`). So not quoting might result in an entirely different zip-code than intended.
59
+ apiInstance = OpenapiClient::AddressesApi.new
60
+ addressEditable = OpenapiClient::AddressEditable.new({
61
+ description: "Harry - Office",
62
+ name: "Harry Zhang",
63
+ company: "Lob",
64
+ email: "harry@lob.com",
65
+ phone: "5555555555",
66
+ address_line1: "210 King St",
67
+ address_line2: "# 6100",
68
+ address_city: "San Francisco",
69
+ address_state: "CA",
70
+ address_zip: "94107",
71
+ address_country: "US",
72
+ });
82
73
 
83
- #### Accessing Response Headers
74
+ begin
75
+ #create
76
+ result = apiInstance.create(addressEditable)
77
+ p result
78
+ rescue OpenapiClient::ApiError => e
79
+ puts "Exception when calling AddressesApi->create: #{e}"
80
+ end
81
+ ```
84
82
 
85
- You can access response headers via a hidden `headers` method on the response hash.
83
+ ## API Documentation
86
84
 
87
- ```ruby
88
- addresses = lob.addresses.list
85
+ The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
89
86
 
90
- addresses._response.headers[:content_type]
91
- # => "application/json; charset=utf-8"
87
+ ## Testing
92
88
 
93
- addresses._response.headers[:rate_limit_window]
94
- # => "60"
89
+ First, install [RSpec](https://rspec.info/) to run the tests. This can be done by running either of the following lines on your command line depending on whether you use Bundler:
90
+ ```shell
91
+ $ bundle add rspec # with Bundler
95
92
 
96
- addresses._response.headers[:rate_limit_remaining]
97
- # => "1234"
93
+ $ gem install rspec # without Bundler
98
94
  ```
99
95
 
100
- You can also access headers from `Lob::InvalidRequestError`s.
96
+ ### Unit Tests
101
97
 
102
- ```ruby
103
- begin
104
- lob.objects.create(name: "Test", file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/incorrect_size.pdf", bad_param: "bad_value")
105
- rescue Lob::InvalidRequestError => e
106
- e._response.headers[:content_type]
107
- # => "application/json; charset=utf-8"
108
- end
98
+ ```bash
99
+ $ rspec -P __tests__/Api/* --color --format doc
109
100
  ```
110
101
 
111
- ## Examples
102
+ ### Integration Tests
112
103
 
113
- We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).
104
+ Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.
114
105
 
115
- There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files.
106
+ To run integration tests:
116
107
 
117
- ## API Documentation
108
+ ```bash
109
+ $ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> rspec -P __tests__/Integration/* --color --format doc
110
+ ```
118
111
 
119
- The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
112
+ #### A cleaner alternative if you are going to run integration tests frequently
120
113
 
121
- ## Contributing
114
+ Run this the first time:
122
115
 
123
- To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
116
+ ```bash
117
+ $ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env
118
+ ```
124
119
 
125
- ## Testing
120
+ Then, to run the integration tests:
121
+
122
+ ```bash
123
+ $ env $(cat LOCAL.env) rspec -P __tests__/Integration/* --color --format doc
124
+ ```
126
125
 
127
- Tests are written using MiniTest, a testing library that comes with Ruby stdlib.
126
+ ## Documentation For Authorization
128
127
 
129
- Here's how you can run the tests:
130
128
 
131
- bundle exec rake test
129
+ ## basicAuth
132
130
 
133
- You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
131
+ - **Type**: HTTP basic authentication
134
132
 
135
- =======================
136
133
 
137
- Copyright &copy; 2016 Lob.com
134
+ ## Author
138
135
 
139
- Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
136
+ lob-openapi@lob.com
data/Rakefile CHANGED
@@ -1,8 +1,10 @@
1
1
  require "bundler/gem_tasks"
2
- require "rake/testtask"
3
2
 
4
- Rake::TestTask.new do |t|
5
- t.libs.push "lib", "spec"
6
- t.test_files = FileList['spec/**/*_spec.rb']
7
- t.verbose = true
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
8
10
  end
@@ -0,0 +1,210 @@
1
+ # Address.unit.rb
2
+
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
+
10
+ RSpec.describe "AddressesApi" do
11
+
12
+ it "can be instantiated" do
13
+ addressApiMock = double("ApiClient")
14
+ addressApi = AddressesApi.new(addressApiMock)
15
+
16
+ expect(addressApi).not_to be_nil
17
+ expect(addressApi).to be_a_kind_of(AddressesApi)
18
+ end
19
+
20
+ describe "Create" do
21
+ it "handles errors returned by the api" do
22
+ addressApiMock = double("ApiClient")
23
+ addressApi = AddressesApi.new(addressApiMock)
24
+ addressEditable = AddressEditable.new
25
+
26
+ allow(addressApi).to receive(:create).and_raise("exception thrown in create test")
27
+ begin
28
+ response = addressApi.create(addressEditable)
29
+ rescue => err
30
+ expect(err.message).to eq("exception thrown in create test")
31
+ end
32
+ end
33
+
34
+ it "creates a new address" do
35
+ addressApiMock = double("ApiClient")
36
+ addressApi = AddressesApi.new(addressApiMock)
37
+ addressEditable = AddressEditable.new
38
+ fakeAddress = Address.new
39
+
40
+ fakeAddress.id = "adr_fakeid"
41
+ allow(addressApi).to receive(:create) { fakeAddress }
42
+ response = addressApi.create(addressEditable)
43
+
44
+ expect(response).to eq(fakeAddress)
45
+ expect(response.id).to eq(fakeAddress.id)
46
+ end
47
+ end
48
+
49
+ describe "Get" do
50
+ it "handles errors returned by the api" do
51
+ addressApiMock = double("ApiClient")
52
+ addressApi = AddressesApi.new(addressApiMock)
53
+
54
+ allow(addressApi).to receive(:get).and_raise("exception thrown in get test")
55
+ begin
56
+ response = addressApi.get("adr_fakeId")
57
+ rescue => err
58
+ expect(err.message).to eq("exception thrown in get test")
59
+ end
60
+ end
61
+
62
+ it "retrieves an address" do
63
+ addressApiMock = double("ApiClient")
64
+ addressApi = AddressesApi.new(addressApiMock)
65
+ fakeAddress = Address.new
66
+
67
+ fakeAddress.id = "adr_fakeid"
68
+ allow(addressApi).to receive(:get) { fakeAddress }
69
+ response = addressApi.get(fakeAddress.id)
70
+
71
+ expect(response).to eq(fakeAddress)
72
+ expect(response.id).to eq(fakeAddress.id)
73
+ end
74
+ end
75
+
76
+ describe "List" do
77
+ it "handles errors returned by the api" do
78
+ addressApiMock = double("ApiClient")
79
+ addressApi = AddressesApi.new(addressApiMock)
80
+ addressEditable = AddressEditable.new
81
+
82
+ allow(addressApi).to receive(:list).and_raise("exception thrown in get test")
83
+ begin
84
+ response = addressApi.list()
85
+ rescue => err
86
+ expect(err.message).to eq("exception thrown in get test")
87
+ end
88
+ end
89
+
90
+ it "lists addresses" do
91
+ addressApiMock = double("ApiClient")
92
+ addressApi = AddressesApi.new(addressApiMock)
93
+ addressEditable = AddressEditable.new
94
+ fakeAddresses = Array.new(2) { Address.new }
95
+
96
+ fakeAddresses[0].id = "adr_fakeid"
97
+ allow(addressApi).to receive(:list) { fakeAddresses }
98
+ response = addressApi.list()
99
+
100
+ expect(response.length()).to eq(2)
101
+ expect(response).to eq(fakeAddresses)
102
+ expect(response[0].id).to eq(fakeAddresses[0].id)
103
+ end
104
+
105
+ it "lists addresses with a limit parameter" do
106
+ addressApiMock = double("ApiClient")
107
+ addressApi = AddressesApi.new(addressApiMock)
108
+ addressEditable = AddressEditable.new
109
+ fakeAddresses = Array.new(2) { Address.new }
110
+
111
+ fakeAddresses[0].id = "adr_fakeid"
112
+ allow(addressApi).to receive(:list) { fakeAddresses }
113
+ response = addressApi.list(limit: 10)
114
+
115
+ expect(response.length()).to eq(2)
116
+ expect(response).to eq(fakeAddresses)
117
+ expect(response[0].id).to eq(fakeAddresses[0].id)
118
+ end
119
+
120
+ it "lists addresses with a before parameter" do
121
+ addressApiMock = double("ApiClient")
122
+ addressApi = AddressesApi.new(addressApiMock)
123
+ addressEditable = AddressEditable.new
124
+ fakeAddresses = Array.new(2) { Address.new }
125
+
126
+ fakeAddresses[0].id = "adr_fakeid"
127
+ allow(addressApi).to receive(:list) { fakeAddresses }
128
+ response = addressApi.list(before: 'before')
129
+
130
+ expect(response.length()).to eq(2)
131
+ expect(response).to eq(fakeAddresses)
132
+ expect(response[0].id).to eq(fakeAddresses[0].id)
133
+ end
134
+
135
+ it "lists addresses with a after parameter" do
136
+ addressApiMock = double("ApiClient")
137
+ addressApi = AddressesApi.new(addressApiMock)
138
+ addressEditable = AddressEditable.new
139
+ fakeAddresses = Array.new(2) { Address.new }
140
+
141
+ fakeAddresses[0].id = "adr_fakeid"
142
+ allow(addressApi).to receive(:list) { fakeAddresses }
143
+ response = addressApi.list(after: 'after')
144
+
145
+ expect(response.length()).to eq(2)
146
+ expect(response).to eq(fakeAddresses)
147
+ expect(response[0].id).to eq(fakeAddresses[0].id)
148
+ end
149
+
150
+ it "lists addresses with a date created parameter" do
151
+ addressApiMock = double("ApiClient")
152
+ addressApi = AddressesApi.new(addressApiMock)
153
+ addressEditable = AddressEditable.new
154
+ fakeAddresses = Array.new(2) { Address.new }
155
+
156
+ DATE_FILTER = { gt: "2020-01-01", lt: "2020-01-31T12" };
157
+ fakeAddresses[0].id = "adr_fakeid"
158
+ allow(addressApi).to receive(:list) { fakeAddresses }
159
+ response = addressApi.list(date_created: DATE_FILTER)
160
+
161
+ expect(response.length()).to eq(2)
162
+ expect(response).to eq(fakeAddresses)
163
+ expect(response[0].id).to eq(fakeAddresses[0].id)
164
+ end
165
+
166
+ it "lists addresses with a metadata parameter" do
167
+ addressApiMock = double("ApiClient")
168
+ addressApi = AddressesApi.new(addressApiMock)
169
+ addressEditable = AddressEditable.new
170
+ fakeAddresses = Array.new(2) { Address.new }
171
+
172
+ METADATA = { fakeMetadata: "fakemetadata" }
173
+ fakeAddresses[0].id = "adr_fakeid"
174
+ allow(addressApi).to receive(:list) { fakeAddresses }
175
+ response = addressApi.list(metadata: METADATA)
176
+
177
+ expect(response.length()).to eq(2)
178
+ expect(response).to eq(fakeAddresses)
179
+ expect(response[0].id).to eq(fakeAddresses[0].id)
180
+ end
181
+ end
182
+
183
+ describe "Delete" do
184
+ it "handles errors returned by the api" do
185
+ addressApiMock = double("ApiClient")
186
+ addressApi = AddressesApi.new(addressApiMock)
187
+ addressEditable = AddressEditable.new
188
+
189
+ allow(addressApi).to receive(:delete).and_raise("exception thrown in delete test")
190
+ begin
191
+ response = addressApi.delete(addressEditable)
192
+ rescue => err
193
+ expect(err.message).to eq("exception thrown in delete test")
194
+ end
195
+ end
196
+
197
+ it "deletes an address" do
198
+ addressApiMock = double("ApiClient")
199
+ addressApi = AddressesApi.new(addressApiMock)
200
+ fakeAddressDeletion = AddressDeletion.new
201
+
202
+ fakeAddressDeletion.deleted = true
203
+ allow(addressApi).to receive(:delete) { fakeAddressDeletion }
204
+ response = addressApi.delete("adr_fakeId")
205
+
206
+ expect(response).to eq(fakeAddressDeletion)
207
+ expect(response.deleted).to eq(true)
208
+ end
209
+ end
210
+ end