lob 5.1.0 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +5 -5
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -154
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +46 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +70 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +385 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +343 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +788 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +107 -13
  417. metadata +452 -140
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -16
  420. data/CHANGELOG.md +0 -114
  421. data/CONTRIBUTING.md +0 -19
  422. data/LICENSE.txt +0 -22
  423. data/examples/README.md +0 -33
  424. data/examples/checks.rb +0 -48
  425. data/examples/csv_checks/create_checks.rb +0 -47
  426. data/examples/csv_checks/input.csv +0 -6
  427. data/examples/csv_letters/create_letters.rb +0 -40
  428. data/examples/csv_letters/input.csv +0 -6
  429. data/examples/csv_letters/letter_template.html +0 -33
  430. data/examples/csv_postcards/create_postcards.rb +0 -45
  431. data/examples/csv_postcards/input.csv +0 -7
  432. data/examples/csv_postcards/postcard_back.html +0 -38
  433. data/examples/csv_postcards/postcard_front.html +0 -25
  434. data/examples/csv_verify/input.csv +0 -7
  435. data/examples/csv_verify/verify.rb +0 -36
  436. data/examples/letters.rb +0 -72
  437. data/examples/postcards.rb +0 -86
  438. data/lib/lob/client.rb +0 -71
  439. data/lib/lob/errors/invalid_request_error.rb +0 -4
  440. data/lib/lob/errors/lob_error.rb +0 -20
  441. data/lib/lob/resources/address.rb +0 -14
  442. data/lib/lob/resources/bank_account.rb +0 -30
  443. data/lib/lob/resources/check.rb +0 -14
  444. data/lib/lob/resources/group.rb +0 -14
  445. data/lib/lob/resources/groups_member.rb +0 -66
  446. data/lib/lob/resources/intl_verifications.rb +0 -26
  447. data/lib/lob/resources/letter.rb +0 -14
  448. data/lib/lob/resources/postcard.rb +0 -14
  449. data/lib/lob/resources/resource_base.rb +0 -139
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_verifications.rb +0 -27
  452. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  453. data/lib/lob/version.rb +0 -3
  454. data/lob.gemspec +0 -28
  455. data/spec/lob/errors/lob_error_spec.rb +0 -19
  456. data/spec/lob/resources/address_spec.rb +0 -55
  457. data/spec/lob/resources/bank_account_spec.rb +0 -60
  458. data/spec/lob/resources/check_spec.rb +0 -98
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -28
  461. data/spec/lob/resources/letter_spec.rb +0 -94
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -135
  464. data/spec/lob/resources/resource_base_spec.rb +0 -75
  465. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  466. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  467. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  468. data/spec/lob_spec.rb +0 -48
  469. data/spec/samples/8.5x11.pdf +0 -0
  470. data/spec/samples/postcardback.pdf +2 -2287
  471. data/spec/samples/postcardfront.pdf +1 -1549
@@ -0,0 +1,275 @@
1
+ # TemplateVersion.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'uri'
6
+
7
+ RSpec.describe "TemplateVersionsApi" do
8
+ it "can be instantiated" do
9
+ templateVersionApi = TemplateVersionsApi.new()
10
+
11
+ expect(templateVersionApi).not_to be_nil
12
+ expect(templateVersionApi).to be_a_kind_of(TemplateVersionsApi)
13
+ end
14
+
15
+ describe "Create" do
16
+ before(:all) do
17
+ api = TestFixtures.api_client_with_test_key()
18
+ @templateVersionApi = TemplateVersionsApi.new(api)
19
+ @templateApi = TemplatesApi.new(api)
20
+
21
+ templateWritable = TemplateWritable.new({
22
+ description: "Ruby Integration Test",
23
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
24
+ })
25
+
26
+ createdTemplate = @templateApi.create(templateWritable)
27
+ @tmplId = createdTemplate.id
28
+
29
+ @templateVersionWritable = TemplateVersionWritable.new({
30
+ description: "Ruby Integration Test Template Version 1",
31
+ html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
32
+ })
33
+ end
34
+
35
+ it "creates a new template version" do
36
+ createdTemplateVersion = @templateVersionApi.create(@tmplId, @templateVersionWritable)
37
+ expect(createdTemplateVersion.id).not_to be_nil
38
+
39
+ # delete it in the end
40
+ @templateVersionApi.delete(@tmplId, createdTemplateVersion.id)
41
+ @templateApi.delete(@tmplId)
42
+ end
43
+
44
+ it "handles errors returned by the api" do
45
+ templateVersionWritable = TemplateVersionWritable.new()
46
+ begin
47
+ response = @templateVersionApi.create(@tmplId, templateVersionWritable)
48
+ rescue => err
49
+ expect(err.message.include? "html is required").to be(true)
50
+ end
51
+ end
52
+
53
+ it "does not allow creation with invalid key" do
54
+ config = Lob::Configuration.default
55
+ config.username = "fake key"
56
+ badapi = Lob::ApiClient.new(config)
57
+
58
+ templateVersionApi = TemplateVersionsApi.new(badapi)
59
+
60
+ begin
61
+ response = templateVersionApi.create(@tmplId, @templateVersionWritable)
62
+ rescue => err
63
+ expect(err.message.include? "Your API key is not valid.").to be(true)
64
+ end
65
+ end
66
+ end
67
+
68
+ describe "Get" do
69
+ before(:all) do
70
+ api = TestFixtures.api_client_with_test_key()
71
+ @templateVersionApi = TemplateVersionsApi.new(api)
72
+
73
+ @templateApi = TemplatesApi.new(api)
74
+
75
+ templateWritable = TemplateWritable.new({
76
+ description: "Ruby Integration Test",
77
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
78
+ })
79
+
80
+ createdTemplate = @templateApi.create(templateWritable)
81
+ @tmplId = createdTemplate.id
82
+
83
+ templateVersionWritable = TemplateVersionWritable.new({
84
+ description: "Ruby Integration Test Template Version 1",
85
+ html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
86
+ })
87
+
88
+ response = @templateVersionApi.create(@tmplId, templateVersionWritable)
89
+ @vrsnId = response.id
90
+ end
91
+
92
+ it "retrieves a template version" do
93
+ response = @templateVersionApi.get(@tmplId, @vrsnId)
94
+
95
+ expect(response).not_to be_nil()
96
+ expect(response.id).to eq(@vrsnId)
97
+ end
98
+
99
+ after(:all) do
100
+ @templateVersionApi.delete(@tmplId, @vrsnId)
101
+ @templateApi.delete(@tmplId)
102
+ end
103
+ end
104
+
105
+ describe "List" do
106
+ before(:all) do
107
+ api = TestFixtures.api_client_with_test_key()
108
+ @templateVersionApi = TemplateVersionsApi.new(api)
109
+
110
+ @templateApi = TemplatesApi.new(api)
111
+
112
+ templateWritable = TemplateWritable.new({
113
+ description: "Ruby Integration Test",
114
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
115
+ })
116
+
117
+ createdTemplate = @templateApi.create(templateWritable)
118
+ @tmplId = createdTemplate.id
119
+
120
+ templateVersionWritable1 = TemplateVersionWritable.new({
121
+ description: "Ruby Integration Test Template Version 1",
122
+ html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
123
+ })
124
+
125
+ templateVersionWritable2 = TemplateVersionWritable.new({
126
+ description: "Ruby Integration Test Template Version 2",
127
+ html: "<html>Updated HTML for Ruby Integration Test template version 2</html>"
128
+ })
129
+
130
+ templateVersionWritable3 = TemplateVersionWritable.new({
131
+ description: "Ruby Integration Test Template Version 3",
132
+ html: "<html>Updated HTML for Ruby Integration Test template version 3</html>"
133
+ })
134
+
135
+ response1 = @templateVersionApi.create(@tmplId, templateVersionWritable1)
136
+ response2 = @templateVersionApi.create(@tmplId, templateVersionWritable2)
137
+ response3 = @templateVersionApi.create(@tmplId, templateVersionWritable3)
138
+
139
+ @vrsnId1 = response1.id
140
+ @vrsnId2 = response2.id
141
+ @vrsnId3 = response3.id
142
+ end
143
+
144
+ it "lists templates with limit, before, and after params" do
145
+ response = @templateVersionApi.list(@tmplId, { :"limit" => 2 })
146
+
147
+ expect(response.data.length()).to be == 2
148
+ first_tmpl_id = response.data[0].id
149
+
150
+ uri = URI.parse(response.next_url)
151
+ params = CGI.parse(uri.query)
152
+
153
+ response = @templateVersionApi.list(@tmplId, { :"limit" => 2, :"after" => params["after"][0] })
154
+
155
+ expect(response.data[0].id).not_to eq(first_tmpl_id)
156
+
157
+ uri = URI.parse(response.previous_url)
158
+ params = CGI.parse(uri.query)
159
+
160
+ response = @templateVersionApi.list(@tmplId, { :"limit" => 2, :"before" => params["before"][0] })
161
+ expect(response.data[0].id).to eq(first_tmpl_id)
162
+
163
+ end
164
+
165
+ [
166
+ [nil, nil, nil],
167
+ ["include", Array.new(1, "total_count"), nil],
168
+ ["date_created", nil, { "gt" => "2020-01-01" }],
169
+ ].each do |which_param, include_param, date_created|
170
+ it "lists templates #{which_param && ("with " + which_param + " param")}" do
171
+ args = {}
172
+
173
+ if include_param then
174
+ args[:"include"] = include_param
175
+ end
176
+
177
+ if date_created then
178
+ args[:"date_created"] = date_created
179
+ end
180
+
181
+ response = @templateVersionApi.list(@tmplId, args)
182
+
183
+ expect(response.data.length()).to be > 0
184
+
185
+ if include_param
186
+ expect(response.total_count).to be
187
+ end
188
+ end
189
+ end
190
+
191
+ after(:all) do
192
+ @templateVersionApi.delete(@tmplId, @vrsnId1)
193
+ @templateVersionApi.delete(@tmplId, @vrsnId2)
194
+ @templateVersionApi.delete(@tmplId, @vrsnId3)
195
+ @templateApi.delete(@tmplId)
196
+ end
197
+ end
198
+
199
+ describe "Update" do
200
+ before(:all) do
201
+ api = TestFixtures.api_client_with_test_key()
202
+ @templateVersionApi = TemplateVersionsApi.new(api)
203
+
204
+ @templateApi = TemplatesApi.new(api)
205
+
206
+ templateWritable = TemplateWritable.new({
207
+ description: "Ruby Integration Test",
208
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
209
+ })
210
+
211
+ createdTemplate = @templateApi.create(templateWritable)
212
+ @tmplId = createdTemplate.id
213
+
214
+ templateVersionWritable = TemplateVersionWritable.new({
215
+ description: "Ruby Integration Test",
216
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
217
+ })
218
+
219
+ response = @templateVersionApi.create(@tmplId, templateVersionWritable)
220
+ @vrsnId = response.id
221
+ end
222
+
223
+ it "updates a template version" do
224
+ updatableTemplateVersion = TemplateVersionUpdatable.new({
225
+ description: "Updated template version for Ruby Integration Test"
226
+ })
227
+
228
+ updatedTemplateVersion = @templateVersionApi.update(@tmplId, @vrsnId, updatableTemplateVersion)
229
+ expect(updatedTemplateVersion.id).not_to be_nil
230
+ expect(updatedTemplateVersion.description).to eq("Updated template version for Ruby Integration Test")
231
+
232
+ # delete it in the end
233
+ @templateVersionApi.delete(@tmplId, @vrsnId)
234
+ @templateApi.delete(@tmplId)
235
+ end
236
+ end
237
+
238
+ describe "Delete" do
239
+ before(:all) do
240
+ api = TestFixtures.api_client_with_test_key()
241
+ @templateVersionApi = TemplateVersionsApi.new(api)
242
+
243
+ @templateApi = TemplatesApi.new(api)
244
+
245
+ templateWritable = TemplateWritable.new({
246
+ description: "Ruby Integration Test",
247
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
248
+ })
249
+
250
+ createdTemplate = @templateApi.create(templateWritable)
251
+ @tmplId = createdTemplate.id
252
+
253
+ templateVersionWritable = TemplateVersionWritable.new({
254
+ description: "Ruby Integration Test",
255
+ html: "<html>Updated HTML for Ruby Integration Test</html>"
256
+ })
257
+
258
+ response = @templateVersionApi.create(@tmplId, templateVersionWritable)
259
+ @vrsnId = response.id
260
+ end
261
+
262
+ it "deletes a template version" do
263
+ response = @templateVersionApi.delete(@tmplId, @vrsnId)
264
+
265
+ expect(response.id).to eq(@vrsnId)
266
+ expect(response.deleted).to eq(true)
267
+ end
268
+
269
+ after(:all) do
270
+ api = TestFixtures.api_client_with_test_key()
271
+ templateApi = TemplatesApi.new(api)
272
+ templateApi.delete(@tmplId)
273
+ end
274
+ end
275
+ end
@@ -0,0 +1,54 @@
1
+ # UsAutocompletion.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "UsAutocompletionsApi" do
7
+ it "can be instantiated" do
8
+ usAutocompletionApi = UsAutocompletionsApi.new()
9
+
10
+ expect(usAutocompletionApi).not_to be_nil
11
+ expect(usAutocompletionApi).to be_a_kind_of(UsAutocompletionsApi)
12
+ end
13
+
14
+ describe "Autocomplete" do
15
+ before(:all) do
16
+ api = TestFixtures.api_client_with_test_key()
17
+ @usAutocompletionApi = UsAutocompletionsApi.new(api)
18
+
19
+ @validAddress = UsAutocompletionsWritable.new({
20
+ address_prefix: "1 suggestion",
21
+ city: "SAN FRANCISCO",
22
+ })
23
+ end
24
+
25
+ it "Autocompletes US address (with test key)" do
26
+ autocompletedAddr = @usAutocompletionApi.autocomplete(@validAddress)
27
+ puts autocompletedAddr.suggestions[0].primary_line
28
+ expect(autocompletedAddr.suggestions[0].primary_line).to eq("1 TELEGRAPH HILL BLVD")
29
+ end
30
+
31
+ it "handles errors returned by the api" do
32
+ validAddress = UsAutocompletionsWritable.new()
33
+ begin
34
+ response = @usAutocompletionApi.autocomplete(validAddress)
35
+ rescue => err
36
+ expect(err.message.include? "address_prefix is required").to be(true)
37
+ end
38
+ end
39
+
40
+ it "does not allow creation with invalid key" do
41
+ config = Lob::Configuration.default
42
+ config.username = "fake key"
43
+ badapi = Lob::ApiClient.new(config)
44
+
45
+ usAutocompletionApi = UsAutocompletionsApi.new(badapi)
46
+
47
+ begin
48
+ response = usAutocompletionApi.autocomplete(@validAddress)
49
+ rescue => err
50
+ expect(err.message.include? "Your API key is not valid.").to be(true)
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,102 @@
1
+ # UsVerification.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "UsVerificationsApi" do
7
+ it "can be instantiated" do
8
+ usVerificationApi = UsVerificationsApi.new()
9
+
10
+ expect(usVerificationApi).not_to be_nil
11
+ expect(usVerificationApi).to be_a_kind_of(UsVerificationsApi)
12
+ end
13
+
14
+ describe "verifySingle" do
15
+ before(:all) do
16
+ api = TestFixtures.api_client_with_live_key()
17
+ @usVerificationApi = UsVerificationsApi.new(api)
18
+
19
+ @validAddress = UsVerificationsWritable.new({
20
+ primary_line: "210 KING ST",
21
+ city: "SAN FRANCISCO",
22
+ state: "CA",
23
+ zip_code: "94107"
24
+ })
25
+ @invalidAddress = UsVerificationsWritable.new({
26
+ primary_line: "1 CEMETERY ST",
27
+ city: "POTATOFIELD",
28
+ state: "NJ",
29
+ zip_code: "07000"
30
+ })
31
+ mc1 = MultipleComponents.new({
32
+ primary_line: "210 KING ST",
33
+ city: "SAN FRANCISCO",
34
+ state: "CA",
35
+ zip_code: "94107"
36
+ })
37
+ mc2 = MultipleComponents.new({
38
+ primary_line: "001 CEMETERY LN",
39
+ secondary_line: "SUITE 666",
40
+ city: "WESTFIELD",
41
+ state: "NJ",
42
+ zip_code: "07000"
43
+ })
44
+ mcError = MultipleComponents.new({
45
+ })
46
+ @addressList = MultipleComponentsList.new({
47
+ addresses: [mc1, mc2]
48
+ })
49
+
50
+ @errorAddressList = MultipleComponentsList.new({
51
+ addresses: [mc1, mcError]
52
+ })
53
+ end
54
+
55
+ it "Verifies valid addresses in bulk" do
56
+ verifiedList = @usVerificationApi.verifyBulk(@addressList)
57
+ expect(verifiedList.addresses.length()).to be(2)
58
+ expect(verifiedList.addresses[0].deliverability).to eq("deliverable")
59
+ expect(verifiedList.addresses[1].deliverability).to eq("undeliverable")
60
+ end
61
+
62
+ it "Handles errors while verifying addresses in bulk" do
63
+ verifiedList = @usVerificationApi.verifyBulk(@errorAddressList)
64
+ expect(verifiedList.addresses.length()).to be(2)
65
+ expect(verifiedList.addresses[1].error).not_to be_nil
66
+ expect(verifiedList.errors).to be(true)
67
+ end
68
+
69
+ it "Verifies single deliverable address" do
70
+ verifiedAddr = @usVerificationApi.verifySingle(@validAddress)
71
+ expect(verifiedAddr.deliverability).to eq("deliverable")
72
+ end
73
+
74
+ it "Verifies single undeliverable address" do
75
+ verifiedAddr = @usVerificationApi.verifySingle(@invalidAddress)
76
+ expect(verifiedAddr.deliverability).to eq("undeliverable")
77
+ end
78
+
79
+ it "handles errors returned by the api" do
80
+ invalidAddress = UsVerificationsWritable.new()
81
+ begin
82
+ response = @usVerificationApi.verifySingle(invalidAddress)
83
+ rescue => err
84
+ expect(err.message.include? "primary_line is required").to be(true)
85
+ end
86
+ end
87
+
88
+ it "does not allow creation with invalid key" do
89
+ config = Lob::Configuration.default
90
+ config.username = "fake key"
91
+ badapi = Lob::ApiClient.new(config)
92
+
93
+ usVerificationApi = UsVerificationsApi.new(badapi)
94
+
95
+ begin
96
+ response = usVerificationApi.verifySingle(@validAddress)
97
+ rescue => err
98
+ expect(err.message.include? "Your API key is not valid.").to be(true)
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,29 @@
1
+ # UsAutocompletion.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "ZipLookupsApi" do
7
+ it "can be instantiated" do
8
+ zipLookupsApi = ZipLookupsApi.new()
9
+
10
+ expect(zipLookupsApi).not_to be_nil
11
+ expect(zipLookupsApi).to be_a_kind_of(ZipLookupsApi)
12
+ end
13
+
14
+ describe "Lookup" do
15
+ before(:all) do
16
+ api = TestFixtures.api_client_with_test_key()
17
+ @zipLookupsApi = ZipLookupsApi.new(api)
18
+
19
+ @zipEditable = ZipEditable.new({
20
+ zip_code: "94107"
21
+ });
22
+ end
23
+
24
+ it "looks up given input" do
25
+ response = @zipLookupsApi.lookup(@zipEditable)
26
+ expect(response.cities.length()).to be > 0
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,36 @@
1
+ module Lob
2
+ class TestFixtures
3
+
4
+ def self.api_client_with_test_key()
5
+ config = Lob::Configuration.default
6
+ config.username = ENV["LOB_API_TEST_KEY"]
7
+ apiClient = Lob::ApiClient.new(config)
8
+ return apiClient
9
+ end
10
+
11
+ def self.api_client_with_live_key()
12
+ config = Lob::Configuration.default
13
+ config.username = ENV["LOB_API_LIVE_KEY"]
14
+ apiClient = Lob::ApiClient.new(config)
15
+ return apiClient
16
+ end
17
+
18
+ def self.FILE_LOCATION()
19
+ return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf"
20
+ end
21
+
22
+ def self.FILE_LOCATION_4x6()
23
+ return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/4x6_pc_template.pdf";
24
+ end
25
+
26
+ def self.FILE_LOCATION_6X18()
27
+ return "https://s3.us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf"
28
+ end
29
+
30
+ def self.FILE_LOCATION_8X11()
31
+ return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/us_letter_1pg.pdf"
32
+ end
33
+
34
+
35
+ end
36
+ end
data/docs/Address.md ADDED
@@ -0,0 +1,52 @@
1
+ # Lob::Address
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier prefixed with &#x60;adr_&#x60;. | [optional] |
8
+ | **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
9
+ | **name** | **String** | name associated with address | [optional] |
10
+ | **company** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. | [optional] |
11
+ | **phone** | **String** | Must be no longer than 40 characters. | [optional] |
12
+ | **email** | **String** | Must be no longer than 100 characters. | [optional] |
13
+ | **metadata** | **Hash&lt;String, String&gt;** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
14
+ | **address_line1** | **String** | | [optional] |
15
+ | **address_line2** | **String** | | [optional] |
16
+ | **address_city** | **String** | | [optional] |
17
+ | **address_state** | **String** | 2 letter state short-name code | [optional] |
18
+ | **address_zip** | **String** | Must follow the ZIP format of &#x60;12345&#x60; or ZIP+4 format of &#x60;12345-1234&#x60;. | [optional] |
19
+ | **address_country** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) | | [optional] |
20
+ | **object** | **String** | | [optional][default to &#39;address&#39;] |
21
+ | **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
22
+ | **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
23
+ | **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
24
+ | **recipient_moved** | **Boolean** | Only returned for accounts on certain &lt;a href&#x3D;\&quot;https://dashboard.lob.com/#/settings/editions\&quot;&gt;Print &amp;amp; Mail Editions&lt;/a&gt;. Value is &#x60;true&#x60; if the address was altered because the recipient filed for a &lt;a href&#x3D;\&quot;#ncoa\&quot;&gt;National Change of Address (NCOA)&lt;/a&gt;, &#x60;false&#x60; if the NCOA check was run but no altered address was found, and &#x60;null&#x60; if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'openapi_client'
30
+
31
+ instance = Lob::Address.new(
32
+ id: null,
33
+ description: null,
34
+ name: null,
35
+ company: null,
36
+ phone: null,
37
+ email: null,
38
+ metadata: null,
39
+ address_line1: null,
40
+ address_line2: null,
41
+ address_city: null,
42
+ address_state: null,
43
+ address_zip: null,
44
+ address_country: null,
45
+ object: null,
46
+ date_created: null,
47
+ date_modified: null,
48
+ deleted: null,
49
+ recipient_moved: null
50
+ )
51
+ ```
52
+
@@ -0,0 +1,22 @@
1
+ # Lob::AddressDeletion
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier prefixed with &#x60;adr_&#x60;. | [optional] |
8
+ | **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
9
+ | **object** | **String** | Value is type of resource. | [optional][default to &#39;address_deleted&#39;] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'openapi_client'
15
+
16
+ instance = Lob::AddressDeletion.new(
17
+ id: null,
18
+ deleted: null,
19
+ object: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,40 @@
1
+ # Lob::AddressDomestic
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address_line1** | **String** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] |
8
+ | **address_line2** | **String** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] |
9
+ | **address_city** | **String** | | [optional] |
10
+ | **address_state** | **String** | | [optional] |
11
+ | **address_zip** | **String** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] |
12
+ | **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
13
+ | **name** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. Must be no longer than 40 characters. If both &#x60;name&#x60; and &#x60;company&#x60; are provided, they will be printed on two separate lines above the rest of the address. | [optional] |
14
+ | **company** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. | [optional] |
15
+ | **phone** | **String** | Must be no longer than 40 characters. | [optional] |
16
+ | **email** | **String** | Must be no longer than 100 characters. | [optional] |
17
+ | **address_country** | **String** | The country associated with this address. | [optional] |
18
+ | **metadata** | **Hash&lt;String, String&gt;** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'openapi_client'
24
+
25
+ instance = Lob::AddressDomestic.new(
26
+ address_line1: null,
27
+ address_line2: null,
28
+ address_city: null,
29
+ address_state: null,
30
+ address_zip: null,
31
+ description: null,
32
+ name: null,
33
+ company: null,
34
+ phone: null,
35
+ email: null,
36
+ address_country: null,
37
+ metadata: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,40 @@
1
+ # Lob::AddressDomesticExpanded
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address_line1** | **String** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] |
8
+ | **address_line2** | **String** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] |
9
+ | **address_city** | **String** | | [optional] |
10
+ | **address_state** | **String** | | [optional] |
11
+ | **address_zip** | **String** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] |
12
+ | **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
13
+ | **name** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. Must be no longer than 40 characters. If both &#x60;name&#x60; and &#x60;company&#x60; are provided, they will be printed on two separate lines above the rest of the address. | [optional] |
14
+ | **company** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. | [optional] |
15
+ | **phone** | **String** | Must be no longer than 40 characters. | [optional] |
16
+ | **email** | **String** | Must be no longer than 100 characters. | [optional] |
17
+ | **address_country** | **String** | The country associated with this address. | [optional] |
18
+ | **metadata** | **Hash&lt;String, String&gt;** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'openapi_client'
24
+
25
+ instance = Lob::AddressDomesticExpanded.new(
26
+ address_line1: null,
27
+ address_line2: null,
28
+ address_city: null,
29
+ address_state: null,
30
+ address_zip: null,
31
+ description: null,
32
+ name: null,
33
+ company: null,
34
+ phone: null,
35
+ email: null,
36
+ address_country: null,
37
+ metadata: null
38
+ )
39
+ ```
40
+