lob 5.4.5 → 6.0.0.pre.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (481) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +6 -1
  3. data/Gemfile.lock +70 -0
  4. data/LICENSE +21 -0
  5. data/README.md +88 -91
  6. data/Rakefile +7 -5
  7. data/__tests__/Api/Address.unit.rb +210 -0
  8. data/__tests__/Api/BankAccount.unit.rb +244 -0
  9. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  10. data/__tests__/Api/Card.unit.rb +183 -0
  11. data/__tests__/Api/CardOrder.unit.rb +89 -0
  12. data/__tests__/Api/Check.unit.rb +185 -0
  13. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  14. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  15. data/__tests__/Api/Letter.unit.rb +191 -0
  16. data/__tests__/Api/Postcard.unit.rb +189 -0
  17. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  18. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  19. data/__tests__/Api/Template.unit.rb +165 -0
  20. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  21. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  22. data/__tests__/Api/UsVerification.unit.rb +71 -0
  23. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  24. data/__tests__/Integration/Address.spec.rb +200 -0
  25. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  26. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  27. data/__tests__/Integration/Card.spec.rb +198 -0
  28. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  29. data/__tests__/Integration/Check.spec.rb +361 -0
  30. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  31. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  32. data/__tests__/Integration/Letter.spec.rb +286 -0
  33. data/__tests__/Integration/Postcard.spec.rb +214 -0
  34. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  35. data/__tests__/Integration/SelfMailer.spec.rb +264 -0
  36. data/__tests__/Integration/Template.spec.rb +221 -0
  37. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  38. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  39. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  40. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  41. data/__tests__/TestFixtures.rb +36 -0
  42. data/docs/Address.md +52 -0
  43. data/docs/AddressDeletion.md +22 -0
  44. data/docs/AddressDomestic.md +40 -0
  45. data/docs/AddressDomesticExpanded.md +40 -0
  46. data/docs/AddressEditable.md +40 -0
  47. data/docs/AddressList.md +28 -0
  48. data/docs/AddressesApi.md +303 -0
  49. data/docs/BankAccount.md +44 -0
  50. data/docs/BankAccountDeletion.md +22 -0
  51. data/docs/BankAccountList.md +28 -0
  52. data/docs/BankAccountVerify.md +18 -0
  53. data/docs/BankAccountWritable.md +28 -0
  54. data/docs/BankAccountsApi.md +376 -0
  55. data/docs/BankTypeEnum.md +15 -0
  56. data/docs/BillingGroup.md +28 -0
  57. data/docs/BillingGroupEditable.md +20 -0
  58. data/docs/BillingGroupList.md +26 -0
  59. data/docs/BillingGroupsApi.md +305 -0
  60. data/docs/Buckslip.md +60 -0
  61. data/docs/BuckslipDeletion.md +20 -0
  62. data/docs/BuckslipEditable.md +24 -0
  63. data/docs/BuckslipOrder.md +42 -0
  64. data/docs/BuckslipOrderEditable.md +18 -0
  65. data/docs/BuckslipOrdersApi.md +157 -0
  66. data/docs/BuckslipOrdersList.md +26 -0
  67. data/docs/BuckslipUpdatable.md +22 -0
  68. data/docs/BuckslipsApi.md +372 -0
  69. data/docs/BuckslipsList.md +28 -0
  70. data/docs/BulkError.md +18 -0
  71. data/docs/BulkErrorProperties.md +20 -0
  72. data/docs/Campaign.md +52 -0
  73. data/docs/CampaignCreative.md +42 -0
  74. data/docs/CampaignDeletion.md +20 -0
  75. data/docs/CampaignUpdatable.md +36 -0
  76. data/docs/CampaignWritable.md +36 -0
  77. data/docs/CampaignsApi.md +376 -0
  78. data/docs/CampaignsList.md +28 -0
  79. data/docs/Card.md +54 -0
  80. data/docs/CardDeletion.md +22 -0
  81. data/docs/CardEditable.md +24 -0
  82. data/docs/CardList.md +28 -0
  83. data/docs/CardOrder.md +42 -0
  84. data/docs/CardOrderEditable.md +18 -0
  85. data/docs/CardOrderList.md +26 -0
  86. data/docs/CardOrdersApi.md +157 -0
  87. data/docs/CardUpdatable.md +22 -0
  88. data/docs/CardsApi.md +372 -0
  89. data/docs/Check.md +68 -0
  90. data/docs/CheckDeletion.md +22 -0
  91. data/docs/CheckEditable.md +48 -0
  92. data/docs/CheckList.md +28 -0
  93. data/docs/ChecksApi.md +315 -0
  94. data/docs/CmpScheduleType.md +15 -0
  95. data/docs/CmpUseType.md +15 -0
  96. data/docs/CountryExtended.md +15 -0
  97. data/docs/CountryExtendedExpanded.md +15 -0
  98. data/docs/CreativePatch.md +22 -0
  99. data/docs/CreativeResponse.md +42 -0
  100. data/docs/CreativeWritable.md +34 -0
  101. data/docs/CreativesApi.md +226 -0
  102. data/docs/CustomEnvelopeReturned.md +22 -0
  103. data/docs/DefaultApi.md +75 -0
  104. data/docs/DeliverabilityAnalysis.md +34 -0
  105. data/docs/DpvFootnote.md +15 -0
  106. data/docs/EngineHtml.md +15 -0
  107. data/docs/EventType.md +24 -0
  108. data/docs/Events.md +28 -0
  109. data/docs/Export.md +32 -0
  110. data/docs/ExportModel.md +18 -0
  111. data/docs/GeocodeAddresses.md +20 -0
  112. data/docs/GeocodeComponents.md +20 -0
  113. data/docs/HTTPValidationError.md +18 -0
  114. data/docs/IdentityValidation.md +34 -0
  115. data/docs/IdentityValidationApi.md +78 -0
  116. data/docs/InlineObject.md +18 -0
  117. data/docs/IntlAutocompletions.md +20 -0
  118. data/docs/IntlAutocompletionsApi.md +82 -0
  119. data/docs/IntlAutocompletionsWritable.md +26 -0
  120. data/docs/IntlComponents.md +26 -0
  121. data/docs/IntlSuggestions.md +30 -0
  122. data/docs/IntlVerification.md +38 -0
  123. data/docs/IntlVerificationOrError.md +40 -0
  124. data/docs/IntlVerificationWritable.md +32 -0
  125. data/docs/IntlVerifications.md +20 -0
  126. data/docs/IntlVerificationsApi.md +153 -0
  127. data/docs/IntlVerificationsPayload.md +18 -0
  128. data/docs/Letter.md +72 -0
  129. data/docs/LetterCustomEnvelope.md +22 -0
  130. data/docs/LetterDeletion.md +22 -0
  131. data/docs/LetterDetailsReturned.md +36 -0
  132. data/docs/LetterDetailsWritable.md +32 -0
  133. data/docs/LetterEditable.md +52 -0
  134. data/docs/LetterList.md +28 -0
  135. data/docs/LettersApi.md +317 -0
  136. data/docs/LobConfidenceScore.md +20 -0
  137. data/docs/LobError.md +22 -0
  138. data/docs/Location.md +20 -0
  139. data/docs/LocationAnalysis.md +22 -0
  140. data/docs/MailType.md +15 -0
  141. data/docs/MultiLineAddress.md +32 -0
  142. data/docs/MultipleComponents.md +30 -0
  143. data/docs/MultipleComponentsIntl.md +30 -0
  144. data/docs/MultipleComponentsList.md +18 -0
  145. data/docs/PlaceholderModel.md +28 -0
  146. data/docs/Postcard.md +60 -0
  147. data/docs/PostcardDeletion.md +22 -0
  148. data/docs/PostcardDetailsReturned.md +26 -0
  149. data/docs/PostcardDetailsWritable.md +20 -0
  150. data/docs/PostcardEditable.md +40 -0
  151. data/docs/PostcardList.md +28 -0
  152. data/docs/PostcardSize.md +15 -0
  153. data/docs/PostcardsApi.md +317 -0
  154. data/docs/QrCode.md +30 -0
  155. data/docs/ReturnEnvelope.md +24 -0
  156. data/docs/ReverseGeocode.md +22 -0
  157. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  158. data/docs/SelfMailer.md +48 -0
  159. data/docs/SelfMailerDeletion.md +22 -0
  160. data/docs/SelfMailerEditable.md +38 -0
  161. data/docs/SelfMailerList.md +28 -0
  162. data/docs/SelfMailerSize.md +15 -0
  163. data/docs/SelfMailersApi.md +317 -0
  164. data/docs/SortBy.md +20 -0
  165. data/docs/SortBy1.md +20 -0
  166. data/docs/SortBy2.md +20 -0
  167. data/docs/SortBy3.md +20 -0
  168. data/docs/SortByDateModified.md +20 -0
  169. data/docs/Suggestions.md +26 -0
  170. data/docs/Template.md +34 -0
  171. data/docs/TemplateDeletion.md +22 -0
  172. data/docs/TemplateList.md +28 -0
  173. data/docs/TemplateUpdate.md +20 -0
  174. data/docs/TemplateVersion.md +36 -0
  175. data/docs/TemplateVersionDeletion.md +22 -0
  176. data/docs/TemplateVersionList.md +28 -0
  177. data/docs/TemplateVersionUpdatable.md +20 -0
  178. data/docs/TemplateVersionWritable.md +22 -0
  179. data/docs/TemplateVersionsApi.md +384 -0
  180. data/docs/TemplateWritable.md +24 -0
  181. data/docs/TemplatesApi.md +376 -0
  182. data/docs/Thumbnail.md +22 -0
  183. data/docs/TrackingEventCertified.md +34 -0
  184. data/docs/TrackingEventDetails.md +24 -0
  185. data/docs/TrackingEventNormal.md +34 -0
  186. data/docs/Upload.md +44 -0
  187. data/docs/UploadCreateExport.md +20 -0
  188. data/docs/UploadFile.md +20 -0
  189. data/docs/UploadState.md +15 -0
  190. data/docs/UploadUpdatable.md +20 -0
  191. data/docs/UploadWritable.md +18 -0
  192. data/docs/UploadsApi.md +584 -0
  193. data/docs/UsAutocompletions.md +22 -0
  194. data/docs/UsAutocompletionsApi.md +78 -0
  195. data/docs/UsAutocompletionsWritable.md +26 -0
  196. data/docs/UsComponents.md +68 -0
  197. data/docs/UsVerification.md +38 -0
  198. data/docs/UsVerificationOrError.md +40 -0
  199. data/docs/UsVerifications.md +20 -0
  200. data/docs/UsVerificationsApi.md +157 -0
  201. data/docs/UsVerificationsWritable.md +32 -0
  202. data/docs/ValidationError.md +22 -0
  203. data/docs/Zip.md +26 -0
  204. data/docs/ZipCodeType.md +15 -0
  205. data/docs/ZipEditable.md +18 -0
  206. data/docs/ZipLookupCity.md +26 -0
  207. data/docs/ZipLookupsApi.md +78 -0
  208. data/git_push.sh +57 -0
  209. data/lib/openapi_client/api/addresses_api.rb +318 -0
  210. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  211. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  212. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  213. data/lib/openapi_client/api/buckslips_api.rb +382 -0
  214. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  215. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  216. data/lib/openapi_client/api/cards_api.rb +382 -0
  217. data/lib/openapi_client/api/checks_api.rb +337 -0
  218. data/lib/openapi_client/api/creatives_api.rb +244 -0
  219. data/lib/openapi_client/api/default_api.rb +79 -0
  220. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  221. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  222. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  223. data/lib/openapi_client/api/letters_api.rb +340 -0
  224. data/lib/openapi_client/api/postcards_api.rb +340 -0
  225. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  226. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  227. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  228. data/lib/openapi_client/api/templates_api.rb +397 -0
  229. data/lib/openapi_client/api/uploads_api.rb +604 -0
  230. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  231. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  232. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  233. data/lib/openapi_client/api_client.rb +392 -0
  234. data/lib/openapi_client/api_error.rb +57 -0
  235. data/lib/openapi_client/configuration.rb +279 -0
  236. data/lib/openapi_client/models/address.rb +616 -0
  237. data/lib/openapi_client/models/address_deletion.rb +303 -0
  238. data/lib/openapi_client/models/address_domestic.rb +522 -0
  239. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  240. data/lib/openapi_client/models/address_editable.rb +503 -0
  241. data/lib/openapi_client/models/address_list.rb +324 -0
  242. data/lib/openapi_client/models/bank_account.rb +576 -0
  243. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  244. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  245. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  246. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  247. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  248. data/lib/openapi_client/models/billing_group.rb +395 -0
  249. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  250. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  251. data/lib/openapi_client/models/buckslip.rb +814 -0
  252. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  253. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  254. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  255. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  256. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  257. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  258. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  259. data/lib/openapi_client/models/bulk_error.rb +229 -0
  260. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  261. data/lib/openapi_client/models/campaign.rb +549 -0
  262. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  263. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  264. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  265. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  266. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  267. data/lib/openapi_client/models/card.rb +681 -0
  268. data/lib/openapi_client/models/card_deletion.rb +303 -0
  269. data/lib/openapi_client/models/card_editable.rb +318 -0
  270. data/lib/openapi_client/models/card_list.rb +324 -0
  271. data/lib/openapi_client/models/card_order.rb +438 -0
  272. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  273. data/lib/openapi_client/models/card_order_list.rb +273 -0
  274. data/lib/openapi_client/models/card_updatable.rb +289 -0
  275. data/lib/openapi_client/models/check.rb +802 -0
  276. data/lib/openapi_client/models/check_deletion.rb +303 -0
  277. data/lib/openapi_client/models/check_editable.rb +527 -0
  278. data/lib/openapi_client/models/check_list.rb +324 -0
  279. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  280. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  281. data/lib/openapi_client/models/country_extended.rb +254 -0
  282. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  283. data/lib/openapi_client/models/creative_patch.rb +274 -0
  284. data/lib/openapi_client/models/creative_response.rb +444 -0
  285. data/lib/openapi_client/models/creative_writable.rb +400 -0
  286. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  287. data/lib/openapi_client/models/deliverability_analysis.rb +451 -0
  288. data/lib/openapi_client/models/dpv_footnote.rb +50 -0
  289. data/lib/openapi_client/models/engine_html.rb +37 -0
  290. data/lib/openapi_client/models/event_type.rb +325 -0
  291. data/lib/openapi_client/models/events.rb +365 -0
  292. data/lib/openapi_client/models/export.rb +422 -0
  293. data/lib/openapi_client/models/export_model.rb +262 -0
  294. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  295. data/lib/openapi_client/models/geocode_components.rb +291 -0
  296. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  297. data/lib/openapi_client/models/identity_validation.rb +460 -0
  298. data/lib/openapi_client/models/inline_object.rb +229 -0
  299. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  300. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  301. data/lib/openapi_client/models/intl_components.rb +314 -0
  302. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  303. data/lib/openapi_client/models/intl_verification.rb +463 -0
  304. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  305. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  306. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  307. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  308. data/lib/openapi_client/models/letter.rb +716 -0
  309. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  310. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  311. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  312. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  313. data/lib/openapi_client/models/letter_editable.rb +522 -0
  314. data/lib/openapi_client/models/letter_list.rb +324 -0
  315. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  316. data/lib/openapi_client/models/lob_error.rb +296 -0
  317. data/lib/openapi_client/models/location.rb +289 -0
  318. data/lib/openapi_client/models/location_analysis.rb +305 -0
  319. data/lib/openapi_client/models/mail_type.rb +37 -0
  320. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  321. data/lib/openapi_client/models/multiple_components.rb +405 -0
  322. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  323. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  324. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  325. data/lib/openapi_client/models/postcard.rb +646 -0
  326. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  327. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  328. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  329. data/lib/openapi_client/models/postcard_editable.rb +383 -0
  330. data/lib/openapi_client/models/postcard_list.rb +324 -0
  331. data/lib/openapi_client/models/postcard_size.rb +38 -0
  332. data/lib/openapi_client/models/qr_code.rb +339 -0
  333. data/lib/openapi_client/models/return_envelope.rb +258 -0
  334. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  335. data/lib/openapi_client/models/self_mailer.rb +574 -0
  336. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  337. data/lib/openapi_client/models/self_mailer_editable.rb +374 -0
  338. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  339. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  340. data/lib/openapi_client/models/sort_by.rb +283 -0
  341. data/lib/openapi_client/models/sort_by1.rb +283 -0
  342. data/lib/openapi_client/models/sort_by2.rb +283 -0
  343. data/lib/openapi_client/models/sort_by3.rb +283 -0
  344. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  345. data/lib/openapi_client/models/suggestions.rb +343 -0
  346. data/lib/openapi_client/models/template.rb +406 -0
  347. data/lib/openapi_client/models/template_deletion.rb +303 -0
  348. data/lib/openapi_client/models/template_list.rb +324 -0
  349. data/lib/openapi_client/models/template_update.rb +272 -0
  350. data/lib/openapi_client/models/template_version.rb +423 -0
  351. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  352. data/lib/openapi_client/models/template_version_list.rb +324 -0
  353. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  354. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  355. data/lib/openapi_client/models/template_writable.rb +309 -0
  356. data/lib/openapi_client/models/thumbnail.rb +300 -0
  357. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  358. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  359. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  360. data/lib/openapi_client/models/upload.rb +491 -0
  361. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  362. data/lib/openapi_client/models/upload_file.rb +283 -0
  363. data/lib/openapi_client/models/upload_state.rb +42 -0
  364. data/lib/openapi_client/models/upload_updatable.rb +240 -0
  365. data/lib/openapi_client/models/upload_writable.rb +255 -0
  366. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  367. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  368. data/lib/openapi_client/models/us_components.rb +761 -0
  369. data/lib/openapi_client/models/us_verification.rb +451 -0
  370. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  371. data/lib/openapi_client/models/us_verifications.rb +250 -0
  372. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  373. data/lib/openapi_client/models/validation_error.rb +263 -0
  374. data/lib/openapi_client/models/zip.rb +363 -0
  375. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  376. data/lib/openapi_client/models/zip_editable.rb +246 -0
  377. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  378. data/lib/openapi_client/version.rb +15 -0
  379. data/lib/openapi_client.rb +205 -0
  380. data/openapi_client.gemspec +37 -0
  381. data/spec/api/addresses_api_spec.rb +88 -0
  382. data/spec/api/bank_accounts_api_spec.rb +101 -0
  383. data/spec/api/billing_groups_api_spec.rb +89 -0
  384. data/spec/api/campaigns_api_spec.rb +100 -0
  385. data/spec/api/card_orders_api_spec.rb +62 -0
  386. data/spec/api/cards_api_spec.rb +99 -0
  387. data/spec/api/checks_api_spec.rb +93 -0
  388. data/spec/api/creatives_api_spec.rb +73 -0
  389. data/spec/api/default_api_spec.rb +46 -0
  390. data/spec/api/identity_validation_api_spec.rb +47 -0
  391. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  392. data/spec/api/intl_verifications_api_spec.rb +60 -0
  393. data/spec/api/letters_api_spec.rb +94 -0
  394. data/spec/api/postcards_api_spec.rb +94 -0
  395. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  396. data/spec/api/self_mailers_api_spec.rb +94 -0
  397. data/spec/api/template_versions_api_spec.rb +105 -0
  398. data/spec/api/templates_api_spec.rb +101 -0
  399. data/spec/api/uploads_api_spec.rb +135 -0
  400. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  401. data/spec/api/us_verifications_api_spec.rb +61 -0
  402. data/spec/api/zip_lookups_api_spec.rb +47 -0
  403. data/spec/api_client_spec.rb +226 -0
  404. data/spec/configuration_spec.rb +42 -0
  405. data/spec/spec_helper.rb +105 -13
  406. metadata +442 -210
  407. data/.github/workflows/run_tests_job.yml +0 -32
  408. data/.github/workflows/update_gem.yml +0 -27
  409. data/.gitignore +0 -19
  410. data/CHANGELOG.md +0 -146
  411. data/CONTRIBUTING.md +0 -19
  412. data/LICENSE.txt +0 -22
  413. data/examples/README.md +0 -111
  414. data/examples/checks.rb +0 -49
  415. data/examples/csv_checks/create_checks.rb +0 -48
  416. data/examples/csv_checks/input.csv +0 -6
  417. data/examples/csv_letters/create_letters.rb +0 -41
  418. data/examples/csv_letters/input.csv +0 -6
  419. data/examples/csv_letters/letter_template.html +0 -33
  420. data/examples/csv_postcards/create_postcards.rb +0 -46
  421. data/examples/csv_postcards/input.csv +0 -7
  422. data/examples/csv_postcards/postcard_back.html +0 -38
  423. data/examples/csv_postcards/postcard_front.html +0 -25
  424. data/examples/csv_verify/input.csv +0 -7
  425. data/examples/csv_verify/verify.rb +0 -37
  426. data/examples/letters.rb +0 -73
  427. data/examples/list_postcards_metadata.rb +0 -94
  428. data/examples/postcards.rb +0 -87
  429. data/examples/postcards_idempotent.rb +0 -92
  430. data/examples/postcards_intl.rb +0 -87
  431. data/examples/postcards_remote.rb +0 -87
  432. data/examples/postcards_send_date.rb +0 -97
  433. data/examples/postcards_template.rb +0 -98
  434. data/examples/self_mailers.rb +0 -38
  435. data/lib/lob/client.rb +0 -91
  436. data/lib/lob/errors/invalid_request_error.rb +0 -4
  437. data/lib/lob/errors/lob_error.rb +0 -20
  438. data/lib/lob/resources/address.rb +0 -14
  439. data/lib/lob/resources/bank_account.rb +0 -30
  440. data/lib/lob/resources/bulk_intl_verifications.rb +0 -26
  441. data/lib/lob/resources/bulk_us_verifications.rb +0 -27
  442. data/lib/lob/resources/check.rb +0 -14
  443. data/lib/lob/resources/group.rb +0 -14
  444. data/lib/lob/resources/groups_member.rb +0 -66
  445. data/lib/lob/resources/intl_verifications.rb +0 -26
  446. data/lib/lob/resources/letter.rb +0 -14
  447. data/lib/lob/resources/postcard.rb +0 -14
  448. data/lib/lob/resources/resource_base.rb +0 -150
  449. data/lib/lob/resources/self_mailer.rb +0 -14
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  452. data/lib/lob/resources/us_verifications.rb +0 -27
  453. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  454. data/lib/lob/version.rb +0 -3
  455. data/lib/lob.rb +0 -7
  456. data/lob.gemspec +0 -31
  457. data/spec/lob/errors/lob_error_spec.rb +0 -19
  458. data/spec/lob/resources/address_spec.rb +0 -55
  459. data/spec/lob/resources/bank_account_spec.rb +0 -60
  460. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -30
  461. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -37
  462. data/spec/lob/resources/check_spec.rb +0 -119
  463. data/spec/lob/resources/group_spec.rb +0 -50
  464. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  465. data/spec/lob/resources/letter_spec.rb +0 -114
  466. data/spec/lob/resources/member_spec.rb +0 -65
  467. data/spec/lob/resources/postcard_spec.rb +0 -160
  468. data/spec/lob/resources/resource_base_spec.rb +0 -75
  469. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  470. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  471. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  472. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  473. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  474. data/spec/lob_spec.rb +0 -48
  475. data/spec/samples/8.5x11.pdf +0 -0
  476. data/spec/samples/postcardback.pdf +2 -2287
  477. data/spec/samples/postcardfront.pdf +1 -1549
  478. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  479. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  480. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  481. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,604 @@
1
+ =begin
2
+ #Lob
3
+
4
+ #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. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
5
+
6
+ The version of the OpenAPI document: 1.3.0
7
+ Contact: lob-openapi@lob.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module OpenapiClient
16
+ class UploadsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # get_export
23
+ # Retrieves the details of an existing export. You need only supply the unique export identifier that was returned upon export creation. If you try retrieving an export immediately after creating one (i.e., before we're done processing the export), you will get back an export object with `state = in_progress`.
24
+ # @param upl_id [String] ID of the upload
25
+ # @param ex_id [String] ID of the export
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [Export]
28
+ def get_export(upl_id, ex_id, opts = {})
29
+ data, _status_code, _headers = export_retrieve_with_http_info(upl_id, ex_id, opts)
30
+ data
31
+ end
32
+
33
+ # get_export
34
+ # Retrieves the details of an existing export. You need only supply the unique export identifier that was returned upon export creation. If you try retrieving an export immediately after creating one (i.e., before we&#39;re done processing the export), you will get back an export object with &#x60;state &#x3D; in_progress&#x60;.
35
+ # @param upl_id [String] ID of the upload
36
+ # @param ex_id [String] ID of the export
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(Export, Integer, Hash)>] Export data, response status code and response headers
39
+ def export_retrieve_with_http_info(upl_id, ex_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: UploadsApi.export_retrieve ...'
42
+ end
43
+ # verify the required parameter 'upl_id' is set
44
+ if @api_client.config.client_side_validation && upl_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.export_retrieve"
46
+ end
47
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
48
+ if @api_client.config.client_side_validation && upl_id !~ pattern
49
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.export_retrieve, must conform to the pattern #{pattern}."
50
+ end
51
+
52
+ # verify the required parameter 'ex_id' is set
53
+ if @api_client.config.client_side_validation && ex_id.nil?
54
+ fail ArgumentError, "Missing the required parameter 'ex_id' when calling UploadsApi.export_retrieve"
55
+ end
56
+ pattern = Regexp.new(/^ex_[a-zA-Z0-9]+$/)
57
+ if @api_client.config.client_side_validation && ex_id !~ pattern
58
+ fail ArgumentError, "invalid value for 'ex_id' when calling UploadsApi.export_retrieve, must conform to the pattern #{pattern}."
59
+ end
60
+
61
+ # resource path
62
+ local_var_path = '/uploads/{upl_id}/exports/{ex_id}'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s)).sub('{' + 'ex_id' + '}', CGI.escape(ex_id.to_s))
63
+
64
+ # query parameters
65
+ query_params = opts[:query_params] || {}
66
+
67
+ # header parameters
68
+ header_params = opts[:header_params] || {}
69
+ # HTTP header 'Accept' (if needed)
70
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
71
+
72
+ # form parameters
73
+ form_params = opts[:form_params] || {}
74
+
75
+ # http body (model)
76
+ post_body = opts[:debug_body]
77
+
78
+ # return_type
79
+ return_type = opts[:debug_return_type] || 'Export'
80
+
81
+ # auth_names
82
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
83
+
84
+ new_options = opts.merge(
85
+ :operation => :"UploadsApi.export_retrieve",
86
+ :header_params => header_params,
87
+ :query_params => query_params,
88
+ :form_params => form_params,
89
+ :body => post_body,
90
+ :auth_names => auth_names,
91
+ :return_type => return_type
92
+ )
93
+
94
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
95
+ if @api_client.config.debugging
96
+ @api_client.config.logger.debug "API called: UploadsApi#export_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
97
+ end
98
+ return data, status_code, headers
99
+ end
100
+
101
+ # create_upload
102
+ # Creates a new upload with the provided properties.
103
+ # @param upload_writable [UploadWritable]
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [Upload]
106
+ def create_upload(upload_writable, opts = {})
107
+ data, _status_code, _headers = upload_create_with_http_info(upload_writable, opts)
108
+ data
109
+ end
110
+
111
+ # create_upload
112
+ # Creates a new upload with the provided properties.
113
+ # @param upload_writable [UploadWritable]
114
+ # @param [Hash] opts the optional parameters
115
+ # @return [Array<(Upload, Integer, Hash)>] Upload data, response status code and response headers
116
+ def upload_create_with_http_info(upload_writable, opts = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_create ...'
119
+ end
120
+ # verify the required parameter 'upload_writable' is set
121
+ if @api_client.config.client_side_validation && upload_writable.nil?
122
+ fail ArgumentError, "Missing the required parameter 'upload_writable' when calling UploadsApi.upload_create"
123
+ end
124
+ # resource path
125
+ local_var_path = '/uploads'
126
+
127
+ # query parameters
128
+ query_params = opts[:query_params] || {}
129
+
130
+ # header parameters
131
+ header_params = opts[:header_params] || {}
132
+ # HTTP header 'Accept' (if needed)
133
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
134
+ # HTTP header 'Content-Type'
135
+ content_type = @api_client.select_header_content_type(['application/json'])
136
+ if !content_type.nil?
137
+ header_params['Content-Type'] = content_type
138
+ end
139
+
140
+ # form parameters
141
+ form_params = opts[:form_params] || {}
142
+
143
+ # http body (model)
144
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_writable)
145
+
146
+ # return_type
147
+ return_type = opts[:debug_return_type] || 'Upload'
148
+
149
+ # auth_names
150
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
151
+
152
+ new_options = opts.merge(
153
+ :operation => :"UploadsApi.upload_create",
154
+ :header_params => header_params,
155
+ :query_params => query_params,
156
+ :form_params => form_params,
157
+ :body => post_body,
158
+ :auth_names => auth_names,
159
+ :return_type => return_type
160
+ )
161
+
162
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
163
+ if @api_client.config.debugging
164
+ @api_client.config.logger.debug "API called: UploadsApi#upload_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
165
+ end
166
+ return data, status_code, headers
167
+ end
168
+
169
+ # delete_upload
170
+ # Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.
171
+ # @param upl_id [String] id of the upload
172
+ # @param [Hash] opts the optional parameters
173
+ # @return [nil]
174
+ def delete_upload(upl_id, opts = {})
175
+ upload_delete_with_http_info(upl_id, opts)
176
+ nil
177
+ end
178
+
179
+ # delete_upload
180
+ # Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.
181
+ # @param upl_id [String] id of the upload
182
+ # @param [Hash] opts the optional parameters
183
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
184
+ def upload_delete_with_http_info(upl_id, opts = {})
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_delete ...'
187
+ end
188
+ # verify the required parameter 'upl_id' is set
189
+ if @api_client.config.client_side_validation && upl_id.nil?
190
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.upload_delete"
191
+ end
192
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
193
+ if @api_client.config.client_side_validation && upl_id !~ pattern
194
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.upload_delete, must conform to the pattern #{pattern}."
195
+ end
196
+
197
+ # resource path
198
+ local_var_path = '/uploads/{upl_id}'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s))
199
+
200
+ # query parameters
201
+ query_params = opts[:query_params] || {}
202
+
203
+ # header parameters
204
+ header_params = opts[:header_params] || {}
205
+ # HTTP header 'Accept' (if needed)
206
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
207
+
208
+ # form parameters
209
+ form_params = opts[:form_params] || {}
210
+
211
+ # http body (model)
212
+ post_body = opts[:debug_body]
213
+
214
+ # return_type
215
+ return_type = opts[:debug_return_type]
216
+
217
+ # auth_names
218
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
219
+
220
+ new_options = opts.merge(
221
+ :operation => :"UploadsApi.upload_delete",
222
+ :header_params => header_params,
223
+ :query_params => query_params,
224
+ :form_params => form_params,
225
+ :body => post_body,
226
+ :auth_names => auth_names,
227
+ :return_type => return_type
228
+ )
229
+
230
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: UploadsApi#upload_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+
237
+ # create_export
238
+ # Campaign Exports can help you understand exactly which records in a campaign could not be created. By initiating and retrieving an export, you will get row-by-row errors for your campaign. For a step-by-step walkthrough of creating a campaign and exporting failures, see our [Campaigns Guide](https://help.lob.com/best-practices/launching-your-first-campaign). Create an export file associated with an upload.
239
+ # @param upl_id [String] ID of the upload
240
+ # @param export_model [ExportModel]
241
+ # @param [Hash] opts the optional parameters
242
+ # @return [UploadCreateExport]
243
+ def create_export(upl_id, export_model, opts = {})
244
+ data, _status_code, _headers = upload_export_create_with_http_info(upl_id, export_model, opts)
245
+ data
246
+ end
247
+
248
+ # create_export
249
+ # Campaign Exports can help you understand exactly which records in a campaign could not be created. By initiating and retrieving an export, you will get row-by-row errors for your campaign. For a step-by-step walkthrough of creating a campaign and exporting failures, see our [Campaigns Guide](https://help.lob.com/best-practices/launching-your-first-campaign). Create an export file associated with an upload.
250
+ # @param upl_id [String] ID of the upload
251
+ # @param export_model [ExportModel]
252
+ # @param [Hash] opts the optional parameters
253
+ # @return [Array<(UploadCreateExport, Integer, Hash)>] UploadCreateExport data, response status code and response headers
254
+ def upload_export_create_with_http_info(upl_id, export_model, opts = {})
255
+ if @api_client.config.debugging
256
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_export_create ...'
257
+ end
258
+ # verify the required parameter 'upl_id' is set
259
+ if @api_client.config.client_side_validation && upl_id.nil?
260
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.upload_export_create"
261
+ end
262
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
263
+ if @api_client.config.client_side_validation && upl_id !~ pattern
264
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.upload_export_create, must conform to the pattern #{pattern}."
265
+ end
266
+
267
+ # verify the required parameter 'export_model' is set
268
+ if @api_client.config.client_side_validation && export_model.nil?
269
+ fail ArgumentError, "Missing the required parameter 'export_model' when calling UploadsApi.upload_export_create"
270
+ end
271
+ # resource path
272
+ local_var_path = '/uploads/{upl_id}/exports'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s))
273
+
274
+ # query parameters
275
+ query_params = opts[:query_params] || {}
276
+
277
+ # header parameters
278
+ header_params = opts[:header_params] || {}
279
+ # HTTP header 'Accept' (if needed)
280
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
281
+ # HTTP header 'Content-Type'
282
+ content_type = @api_client.select_header_content_type(['application/json'])
283
+ if !content_type.nil?
284
+ header_params['Content-Type'] = content_type
285
+ end
286
+
287
+ # form parameters
288
+ form_params = opts[:form_params] || {}
289
+
290
+ # http body (model)
291
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(export_model)
292
+
293
+ # return_type
294
+ return_type = opts[:debug_return_type] || 'UploadCreateExport'
295
+
296
+ # auth_names
297
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
298
+
299
+ new_options = opts.merge(
300
+ :operation => :"UploadsApi.upload_export_create",
301
+ :header_params => header_params,
302
+ :query_params => query_params,
303
+ :form_params => form_params,
304
+ :body => post_body,
305
+ :auth_names => auth_names,
306
+ :return_type => return_type
307
+ )
308
+
309
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "API called: UploadsApi#upload_export_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ end
313
+ return data, status_code, headers
314
+ end
315
+
316
+ # upload_file
317
+ # Upload an [audience file](https://help.lob.com/best-practices/campaign-audience-guide) and associate it with an upload.
318
+ # @param upl_id [String] ID of the upload
319
+ # @param file [AnyType]
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [UploadFile]
322
+ def upload_file(upl_id, file, opts = {})
323
+ data, _status_code, _headers = upload_file_create_with_http_info(upl_id, file, opts)
324
+ data
325
+ end
326
+
327
+ # upload_file
328
+ # Upload an [audience file](https://help.lob.com/best-practices/campaign-audience-guide) and associate it with an upload.
329
+ # @param upl_id [String] ID of the upload
330
+ # @param file [AnyType]
331
+ # @param [Hash] opts the optional parameters
332
+ # @return [Array<(UploadFile, Integer, Hash)>] UploadFile data, response status code and response headers
333
+ def upload_file_create_with_http_info(upl_id, file, opts = {})
334
+ if @api_client.config.debugging
335
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_file_create ...'
336
+ end
337
+ # verify the required parameter 'upl_id' is set
338
+ if @api_client.config.client_side_validation && upl_id.nil?
339
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.upload_file_create"
340
+ end
341
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
342
+ if @api_client.config.client_side_validation && upl_id !~ pattern
343
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.upload_file_create, must conform to the pattern #{pattern}."
344
+ end
345
+
346
+ # resource path
347
+ local_var_path = '/uploads/{upl_id}/file'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s))
348
+
349
+ # query parameters
350
+ query_params = opts[:query_params] || {}
351
+
352
+ # header parameters
353
+ header_params = opts[:header_params] || {}
354
+ # HTTP header 'Accept' (if needed)
355
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
356
+ # HTTP header 'Content-Type'
357
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
358
+ if !content_type.nil?
359
+ header_params['Content-Type'] = content_type
360
+ end
361
+
362
+ # form parameters
363
+ form_params = opts[:form_params] || {}
364
+ form_params['file'] = file
365
+
366
+ # http body (model)
367
+ post_body = opts[:debug_body]
368
+
369
+ # return_type
370
+ return_type = opts[:debug_return_type] || 'UploadFile'
371
+
372
+ # auth_names
373
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
374
+
375
+ new_options = opts.merge(
376
+ :operation => :"UploadsApi.upload_file_create",
377
+ :header_params => header_params,
378
+ :query_params => query_params,
379
+ :form_params => form_params,
380
+ :body => post_body,
381
+ :auth_names => auth_names,
382
+ :return_type => return_type
383
+ )
384
+
385
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
386
+ if @api_client.config.debugging
387
+ @api_client.config.logger.debug "API called: UploadsApi#upload_file_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
388
+ end
389
+ return data, status_code, headers
390
+ end
391
+
392
+ # get_upload
393
+ # Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
394
+ # @param upl_id [String] id of the upload
395
+ # @param [Hash] opts the optional parameters
396
+ # @return [Upload]
397
+ def get_upload(upl_id, opts = {})
398
+ data, _status_code, _headers = upload_retrieve_with_http_info(upl_id, opts)
399
+ data
400
+ end
401
+
402
+ # get_upload
403
+ # Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
404
+ # @param upl_id [String] id of the upload
405
+ # @param [Hash] opts the optional parameters
406
+ # @return [Array<(Upload, Integer, Hash)>] Upload data, response status code and response headers
407
+ def upload_retrieve_with_http_info(upl_id, opts = {})
408
+ if @api_client.config.debugging
409
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_retrieve ...'
410
+ end
411
+ # verify the required parameter 'upl_id' is set
412
+ if @api_client.config.client_side_validation && upl_id.nil?
413
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.upload_retrieve"
414
+ end
415
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
416
+ if @api_client.config.client_side_validation && upl_id !~ pattern
417
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.upload_retrieve, must conform to the pattern #{pattern}."
418
+ end
419
+
420
+ # resource path
421
+ local_var_path = '/uploads/{upl_id}'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s))
422
+
423
+ # query parameters
424
+ query_params = opts[:query_params] || {}
425
+
426
+ # header parameters
427
+ header_params = opts[:header_params] || {}
428
+ # HTTP header 'Accept' (if needed)
429
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
430
+
431
+ # form parameters
432
+ form_params = opts[:form_params] || {}
433
+
434
+ # http body (model)
435
+ post_body = opts[:debug_body]
436
+
437
+ # return_type
438
+ return_type = opts[:debug_return_type] || 'Upload'
439
+
440
+ # auth_names
441
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
442
+
443
+ new_options = opts.merge(
444
+ :operation => :"UploadsApi.upload_retrieve",
445
+ :header_params => header_params,
446
+ :query_params => query_params,
447
+ :form_params => form_params,
448
+ :body => post_body,
449
+ :auth_names => auth_names,
450
+ :return_type => return_type
451
+ )
452
+
453
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
454
+ if @api_client.config.debugging
455
+ @api_client.config.logger.debug "API called: UploadsApi#upload_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
456
+ end
457
+ return data, status_code, headers
458
+ end
459
+
460
+ # update_upload
461
+ # Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.
462
+ # @param upl_id [String] id of the upload
463
+ # @param upload_updatable [UploadUpdatable]
464
+ # @param [Hash] opts the optional parameters
465
+ # @return [Upload]
466
+ def update_upload(upl_id, upload_updatable, opts = {})
467
+ data, _status_code, _headers = upload_update_with_http_info(upl_id, upload_updatable, opts)
468
+ data
469
+ end
470
+
471
+ # update_upload
472
+ # Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.
473
+ # @param upl_id [String] id of the upload
474
+ # @param upload_updatable [UploadUpdatable]
475
+ # @param [Hash] opts the optional parameters
476
+ # @return [Array<(Upload, Integer, Hash)>] Upload data, response status code and response headers
477
+ def upload_update_with_http_info(upl_id, upload_updatable, opts = {})
478
+ if @api_client.config.debugging
479
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_update ...'
480
+ end
481
+ # verify the required parameter 'upl_id' is set
482
+ if @api_client.config.client_side_validation && upl_id.nil?
483
+ fail ArgumentError, "Missing the required parameter 'upl_id' when calling UploadsApi.upload_update"
484
+ end
485
+ pattern = Regexp.new(/^upl_[a-zA-Z0-9]+$/)
486
+ if @api_client.config.client_side_validation && upl_id !~ pattern
487
+ fail ArgumentError, "invalid value for 'upl_id' when calling UploadsApi.upload_update, must conform to the pattern #{pattern}."
488
+ end
489
+
490
+ # verify the required parameter 'upload_updatable' is set
491
+ if @api_client.config.client_side_validation && upload_updatable.nil?
492
+ fail ArgumentError, "Missing the required parameter 'upload_updatable' when calling UploadsApi.upload_update"
493
+ end
494
+ # resource path
495
+ local_var_path = '/uploads/{upl_id}'.sub('{' + 'upl_id' + '}', CGI.escape(upl_id.to_s))
496
+
497
+ # query parameters
498
+ query_params = opts[:query_params] || {}
499
+
500
+ # header parameters
501
+ header_params = opts[:header_params] || {}
502
+ # HTTP header 'Accept' (if needed)
503
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
504
+ # HTTP header 'Content-Type'
505
+ content_type = @api_client.select_header_content_type(['application/json'])
506
+ if !content_type.nil?
507
+ header_params['Content-Type'] = content_type
508
+ end
509
+
510
+ # form parameters
511
+ form_params = opts[:form_params] || {}
512
+
513
+ # http body (model)
514
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_updatable)
515
+
516
+ # return_type
517
+ return_type = opts[:debug_return_type] || 'Upload'
518
+
519
+ # auth_names
520
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
521
+
522
+ new_options = opts.merge(
523
+ :operation => :"UploadsApi.upload_update",
524
+ :header_params => header_params,
525
+ :query_params => query_params,
526
+ :form_params => form_params,
527
+ :body => post_body,
528
+ :auth_names => auth_names,
529
+ :return_type => return_type
530
+ )
531
+
532
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
533
+ if @api_client.config.debugging
534
+ @api_client.config.logger.debug "API called: UploadsApi#upload_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
535
+ end
536
+ return data, status_code, headers
537
+ end
538
+
539
+ # list_upload
540
+ # Returns a list of your uploads. Optionally, filter uploads by campaign.
541
+ # @param [Hash] opts the optional parameters
542
+ # @option opts [String] :campaign_id id of the campaign
543
+ # @return [Array<Upload>]
544
+ def list_upload(opts = {})
545
+ data, _status_code, _headers = uploads_list_with_http_info(opts)
546
+ data
547
+ end
548
+
549
+ # list_upload
550
+ # Returns a list of your uploads. Optionally, filter uploads by campaign.
551
+ # @param [Hash] opts the optional parameters
552
+ # @option opts [String] :campaign_id id of the campaign
553
+ # @return [Array<(Array<Upload>, Integer, Hash)>] Array<Upload> data, response status code and response headers
554
+ def uploads_list_with_http_info(opts = {})
555
+ if @api_client.config.debugging
556
+ @api_client.config.logger.debug 'Calling API: UploadsApi.uploads_list ...'
557
+ end
558
+ pattern = Regexp.new(/^cmp_[a-zA-Z0-9]+$/)
559
+ if @api_client.config.client_side_validation && !opts[:'campaign_id'].nil? && opts[:'campaign_id'] !~ pattern
560
+ fail ArgumentError, "invalid value for 'opts[:\"campaign_id\"]' when calling UploadsApi.uploads_list, must conform to the pattern #{pattern}."
561
+ end
562
+
563
+ # resource path
564
+ local_var_path = '/uploads'
565
+
566
+ # query parameters
567
+ query_params = opts[:query_params] || {}
568
+ query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
569
+
570
+ # header parameters
571
+ header_params = opts[:header_params] || {}
572
+ # HTTP header 'Accept' (if needed)
573
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
574
+
575
+ # form parameters
576
+ form_params = opts[:form_params] || {}
577
+
578
+ # http body (model)
579
+ post_body = opts[:debug_body]
580
+
581
+ # return_type
582
+ return_type = opts[:debug_return_type] || 'Array<Upload>'
583
+
584
+ # auth_names
585
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
586
+
587
+ new_options = opts.merge(
588
+ :operation => :"UploadsApi.uploads_list",
589
+ :header_params => header_params,
590
+ :query_params => query_params,
591
+ :form_params => form_params,
592
+ :body => post_body,
593
+ :auth_names => auth_names,
594
+ :return_type => return_type
595
+ )
596
+
597
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
598
+ if @api_client.config.debugging
599
+ @api_client.config.logger.debug "API called: UploadsApi#uploads_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
600
+ end
601
+ return data, status_code, headers
602
+ end
603
+ end
604
+ end
@@ -0,0 +1,90 @@
1
+ =begin
2
+ #Lob
3
+
4
+ #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. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
5
+
6
+ The version of the OpenAPI document: 1.3.0
7
+ Contact: lob-openapi@lob.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module OpenapiClient
16
+ class UsAutocompletionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # autocomplete
23
+ # Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us).
24
+ # @param us_autocompletions_writable [UsAutocompletionsWritable]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [UsAutocompletions]
27
+ def autocomplete(us_autocompletions_writable, opts = {})
28
+ data, _status_code, _headers = us_autocompletion_with_http_info(us_autocompletions_writable, opts)
29
+ data
30
+ end
31
+
32
+ # autocomplete
33
+ # Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they&#39;ll need to be [verified](#operation/verification_us).
34
+ # @param us_autocompletions_writable [UsAutocompletionsWritable]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(UsAutocompletions, Integer, Hash)>] UsAutocompletions data, response status code and response headers
37
+ def us_autocompletion_with_http_info(us_autocompletions_writable, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: UsAutocompletionsApi.us_autocompletion ...'
40
+ end
41
+ # verify the required parameter 'us_autocompletions_writable' is set
42
+ if @api_client.config.client_side_validation && us_autocompletions_writable.nil?
43
+ fail ArgumentError, "Missing the required parameter 'us_autocompletions_writable' when calling UsAutocompletionsApi.us_autocompletion"
44
+ end
45
+ # resource path
46
+ local_var_path = '/us_autocompletions'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(us_autocompletions_writable)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'UsAutocompletions'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"UsAutocompletionsApi.us_autocompletion",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: UsAutocompletionsApi#us_autocompletion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+ end
90
+ end