lob 5.4.6 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (496) hide show
  1. checksums.yaml +4 -4
  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 -97
  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 +105 -13
  417. metadata +450 -214
  418. data/.github/workflows/forked_tests_job.yml +0 -36
  419. data/.github/workflows/run_tests_job.yml +0 -32
  420. data/.github/workflows/update_gem.yml +0 -27
  421. data/.gitignore +0 -19
  422. data/CHANGELOG.md +0 -148
  423. data/CONTRIBUTING.md +0 -19
  424. data/LICENSE.txt +0 -22
  425. data/examples/README.md +0 -119
  426. data/examples/cards.rb +0 -51
  427. data/examples/checks.rb +0 -49
  428. data/examples/csv_checks/create_checks.rb +0 -48
  429. data/examples/csv_checks/input.csv +0 -6
  430. data/examples/csv_letters/create_letters.rb +0 -41
  431. data/examples/csv_letters/input.csv +0 -6
  432. data/examples/csv_letters/letter_template.html +0 -33
  433. data/examples/csv_postcards/create_postcards.rb +0 -46
  434. data/examples/csv_postcards/input.csv +0 -7
  435. data/examples/csv_postcards/postcard_back.html +0 -38
  436. data/examples/csv_postcards/postcard_front.html +0 -25
  437. data/examples/csv_verify/input.csv +0 -7
  438. data/examples/csv_verify/verify.rb +0 -37
  439. data/examples/letters.rb +0 -73
  440. data/examples/list_postcards_metadata.rb +0 -94
  441. data/examples/postcards.rb +0 -87
  442. data/examples/postcards_idempotent.rb +0 -92
  443. data/examples/postcards_intl.rb +0 -87
  444. data/examples/postcards_remote.rb +0 -87
  445. data/examples/postcards_send_date.rb +0 -97
  446. data/examples/postcards_template.rb +0 -98
  447. data/examples/self_mailers.rb +0 -38
  448. data/lib/lob/client.rb +0 -96
  449. data/lib/lob/errors/invalid_request_error.rb +0 -4
  450. data/lib/lob/errors/lob_error.rb +0 -20
  451. data/lib/lob/resources/address.rb +0 -14
  452. data/lib/lob/resources/bank_account.rb +0 -30
  453. data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
  454. data/lib/lob/resources/bulk_us_verifications.rb +0 -28
  455. data/lib/lob/resources/card.rb +0 -46
  456. data/lib/lob/resources/check.rb +0 -14
  457. data/lib/lob/resources/group.rb +0 -14
  458. data/lib/lob/resources/groups_member.rb +0 -66
  459. data/lib/lob/resources/intl_verifications.rb +0 -26
  460. data/lib/lob/resources/letter.rb +0 -14
  461. data/lib/lob/resources/postcard.rb +0 -14
  462. data/lib/lob/resources/resource_base.rb +0 -150
  463. data/lib/lob/resources/self_mailer.rb +0 -14
  464. data/lib/lob/resources/us_autocompletions.rb +0 -26
  465. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  466. data/lib/lob/resources/us_verifications.rb +0 -27
  467. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  468. data/lib/lob/version.rb +0 -3
  469. data/lob.gemspec +0 -31
  470. data/spec/lob/errors/lob_error_spec.rb +0 -19
  471. data/spec/lob/resources/address_spec.rb +0 -55
  472. data/spec/lob/resources/bank_account_spec.rb +0 -60
  473. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
  474. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
  475. data/spec/lob/resources/card_spec.rb +0 -145
  476. data/spec/lob/resources/check_spec.rb +0 -119
  477. data/spec/lob/resources/group_spec.rb +0 -50
  478. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  479. data/spec/lob/resources/letter_spec.rb +0 -114
  480. data/spec/lob/resources/member_spec.rb +0 -65
  481. data/spec/lob/resources/postcard_spec.rb +0 -160
  482. data/spec/lob/resources/resource_base_spec.rb +0 -75
  483. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  484. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  485. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  486. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  487. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  488. data/spec/lob_spec.rb +0 -48
  489. data/spec/samples/8.5x11.pdf +0 -0
  490. data/spec/samples/card.pdf +1 -743
  491. data/spec/samples/postcardback.pdf +2 -2287
  492. data/spec/samples/postcardfront.pdf +1 -1549
  493. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  494. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  495. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  496. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,814 @@
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 'date'
14
+ require 'time'
15
+
16
+ module Lob
17
+ class Buckslip
18
+ # Unique identifier prefixed with `bck_`.
19
+ attr_accessor :id
20
+
21
+ # True if the buckslips should be auto-reordered.
22
+ attr_accessor :auto_reorder
23
+
24
+ # The number of buckslips to be reordered.
25
+ attr_accessor :reorder_quantity
26
+
27
+ # The threshold amount of the buckslip
28
+ attr_accessor :threshold_amount
29
+
30
+ # The signed link for the buckslip.
31
+ attr_accessor :url
32
+
33
+ # The raw URL of the buckslip.
34
+ attr_accessor :raw_url
35
+
36
+ # The original URL of the front template.
37
+ attr_accessor :front_original_url
38
+
39
+ # The original URL of the back template.
40
+ attr_accessor :back_original_url
41
+
42
+ attr_accessor :thumbnails
43
+
44
+ # The available quantity of buckslips.
45
+ attr_accessor :available_quantity
46
+
47
+ # The allocated quantity of buckslips.
48
+ attr_accessor :allocated_quantity
49
+
50
+ # The onhand quantity of buckslips.
51
+ attr_accessor :onhand_quantity
52
+
53
+ # The pending quantity of buckslips.
54
+ attr_accessor :pending_quantity
55
+
56
+ # The sum of pending and onhand quantities of buckslips.
57
+ attr_accessor :projected_quantity
58
+
59
+ # An array of buckslip orders that are associated with the buckslip.
60
+ attr_accessor :buckslip_orders
61
+
62
+ attr_accessor :stock
63
+
64
+ attr_accessor :weight
65
+
66
+ attr_accessor :finish
67
+
68
+ attr_accessor :status
69
+
70
+ # object
71
+ attr_accessor :object
72
+
73
+ # Description of the buckslip.
74
+ attr_accessor :description
75
+
76
+ # The size of the buckslip
77
+ attr_accessor :size
78
+
79
+ class EnumAttributeValidator
80
+ attr_reader :datatype
81
+ attr_reader :allowable_values
82
+
83
+ def initialize(datatype, allowable_values)
84
+ @allowable_values = allowable_values.map do |value|
85
+ case datatype.to_s
86
+ when /Integer/i
87
+ value.to_i
88
+ when /Float/i
89
+ value.to_f
90
+ else
91
+ value
92
+ end
93
+ end
94
+ end
95
+
96
+ def valid?(value)
97
+ !value || allowable_values.include?(value)
98
+ end
99
+ end
100
+
101
+ # Attribute mapping from ruby-style variable name to JSON key.
102
+ def self.attribute_map
103
+ {
104
+ :'id' => :'id',
105
+ :'auto_reorder' => :'auto_reorder',
106
+ :'reorder_quantity' => :'reorder_quantity',
107
+ :'threshold_amount' => :'threshold_amount',
108
+ :'url' => :'url',
109
+ :'raw_url' => :'raw_url',
110
+ :'front_original_url' => :'front_original_url',
111
+ :'back_original_url' => :'back_original_url',
112
+ :'thumbnails' => :'thumbnails',
113
+ :'available_quantity' => :'available_quantity',
114
+ :'allocated_quantity' => :'allocated_quantity',
115
+ :'onhand_quantity' => :'onhand_quantity',
116
+ :'pending_quantity' => :'pending_quantity',
117
+ :'projected_quantity' => :'projected_quantity',
118
+ :'buckslip_orders' => :'buckslip_orders',
119
+ :'stock' => :'stock',
120
+ :'weight' => :'weight',
121
+ :'finish' => :'finish',
122
+ :'status' => :'status',
123
+ :'object' => :'object',
124
+ :'description' => :'description',
125
+ :'size' => :'size'
126
+ }
127
+ end
128
+
129
+ # Returns all the JSON keys this model knows about
130
+ def self.acceptable_attributes
131
+ attribute_map.values
132
+ end
133
+
134
+ # Attribute type mapping.
135
+ def self.openapi_types
136
+ {
137
+ :'id' => :'String',
138
+ :'auto_reorder' => :'Boolean',
139
+ :'reorder_quantity' => :'Integer',
140
+ :'threshold_amount' => :'Integer',
141
+ :'url' => :'String',
142
+ :'raw_url' => :'String',
143
+ :'front_original_url' => :'String',
144
+ :'back_original_url' => :'String',
145
+ :'thumbnails' => :'Array<Thumbnail>',
146
+ :'available_quantity' => :'Float',
147
+ :'allocated_quantity' => :'Float',
148
+ :'onhand_quantity' => :'Float',
149
+ :'pending_quantity' => :'Float',
150
+ :'projected_quantity' => :'Float',
151
+ :'buckslip_orders' => :'Array<BuckslipOrder>',
152
+ :'stock' => :'String',
153
+ :'weight' => :'String',
154
+ :'finish' => :'String',
155
+ :'status' => :'String',
156
+ :'object' => :'String',
157
+ :'description' => :'String',
158
+ :'size' => :'String'
159
+ }
160
+ end
161
+
162
+ # List of attributes with nullable: true
163
+ def self.openapi_nullable
164
+ Set.new([
165
+ :'reorder_quantity',
166
+ :'description',
167
+ ])
168
+ end
169
+
170
+ # Initializes the object
171
+ # @param [Hash] attributes Model attributes in the form of hash
172
+ def initialize(attributes = {})
173
+ if (!attributes.is_a?(Hash))
174
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::Buckslip` initialize method"
175
+ end
176
+
177
+ # check to see if the attribute exists and convert string to symbol for hash key
178
+ attributes = attributes.each_with_object({}) { |(k, v), h|
179
+ if (!self.class.attribute_map.key?(k.to_sym))
180
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::Buckslip`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
181
+ end
182
+ h[k.to_sym] = v
183
+ }
184
+
185
+ if attributes.key?(:'id')
186
+ self.id = attributes[:'id']
187
+ end
188
+
189
+ if attributes.key?(:'auto_reorder')
190
+ self.auto_reorder = attributes[:'auto_reorder']
191
+ else
192
+ self.auto_reorder = false
193
+ end
194
+
195
+ if attributes.key?(:'reorder_quantity')
196
+ self.reorder_quantity = attributes[:'reorder_quantity']
197
+ end
198
+
199
+ if attributes.key?(:'threshold_amount')
200
+ self.threshold_amount = attributes[:'threshold_amount']
201
+ else
202
+ self.threshold_amount = 0
203
+ end
204
+
205
+ if attributes.key?(:'url')
206
+ self.url = attributes[:'url']
207
+ end
208
+
209
+ if attributes.key?(:'raw_url')
210
+ self.raw_url = attributes[:'raw_url']
211
+ end
212
+
213
+ if attributes.key?(:'front_original_url')
214
+ self.front_original_url = attributes[:'front_original_url']
215
+ end
216
+
217
+ if attributes.key?(:'back_original_url')
218
+ self.back_original_url = attributes[:'back_original_url']
219
+ end
220
+
221
+ if attributes.key?(:'thumbnails')
222
+ if (value = attributes[:'thumbnails']).is_a?(Array)
223
+ self.thumbnails = value
224
+ end
225
+ end
226
+
227
+ if attributes.key?(:'available_quantity')
228
+ self.available_quantity = attributes[:'available_quantity']
229
+ else
230
+ self.available_quantity = 0
231
+ end
232
+
233
+ if attributes.key?(:'allocated_quantity')
234
+ self.allocated_quantity = attributes[:'allocated_quantity']
235
+ else
236
+ self.allocated_quantity = 0
237
+ end
238
+
239
+ if attributes.key?(:'onhand_quantity')
240
+ self.onhand_quantity = attributes[:'onhand_quantity']
241
+ else
242
+ self.onhand_quantity = 0
243
+ end
244
+
245
+ if attributes.key?(:'pending_quantity')
246
+ self.pending_quantity = attributes[:'pending_quantity']
247
+ else
248
+ self.pending_quantity = 0
249
+ end
250
+
251
+ if attributes.key?(:'projected_quantity')
252
+ self.projected_quantity = attributes[:'projected_quantity']
253
+ else
254
+ self.projected_quantity = 0
255
+ end
256
+
257
+ if attributes.key?(:'buckslip_orders')
258
+ if (value = attributes[:'buckslip_orders']).is_a?(Array)
259
+ self.buckslip_orders = value
260
+ end
261
+ end
262
+
263
+ if attributes.key?(:'stock')
264
+ self.stock = attributes[:'stock']
265
+ end
266
+
267
+ if attributes.key?(:'weight')
268
+ self.weight = attributes[:'weight']
269
+ end
270
+
271
+ if attributes.key?(:'finish')
272
+ self.finish = attributes[:'finish']
273
+ end
274
+
275
+ if attributes.key?(:'status')
276
+ self.status = attributes[:'status']
277
+ end
278
+
279
+ if attributes.key?(:'object')
280
+ self.object = attributes[:'object']
281
+ else
282
+ self.object = 'buckslip'
283
+ end
284
+
285
+ if attributes.key?(:'description')
286
+ self.description = attributes[:'description']
287
+ end
288
+
289
+ if attributes.key?(:'size')
290
+ self.size = attributes[:'size']
291
+ else
292
+ self.size = '8.75x3.75'
293
+ end
294
+ end
295
+
296
+ # Show invalid properties with the reasons. Usually used together with valid?
297
+ # @return Array for valid properties with the reasons
298
+ def list_invalid_properties
299
+ invalid_properties = Array.new
300
+ if @id.nil?
301
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
302
+ end
303
+
304
+ pattern = Regexp.new(/^bck_[a-zA-Z0-9]+$/)
305
+ if @id !~ pattern
306
+ invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
307
+ end
308
+
309
+ if @auto_reorder.nil?
310
+ invalid_properties.push('invalid value for "auto_reorder", auto_reorder cannot be nil.')
311
+ end
312
+
313
+ if @threshold_amount.nil?
314
+ invalid_properties.push('invalid value for "threshold_amount", threshold_amount cannot be nil.')
315
+ end
316
+
317
+ if @url.nil?
318
+ invalid_properties.push('invalid value for "url", url cannot be nil.')
319
+ end
320
+
321
+ if @url.to_s.length > 2083
322
+ invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 2083.')
323
+ end
324
+
325
+ if @url.to_s.length < 1
326
+ invalid_properties.push('invalid value for "url", the character length must be great than or equal to 1.')
327
+ end
328
+
329
+ if @raw_url.nil?
330
+ invalid_properties.push('invalid value for "raw_url", raw_url cannot be nil.')
331
+ end
332
+
333
+ if @raw_url.to_s.length > 2083
334
+ invalid_properties.push('invalid value for "raw_url", the character length must be smaller than or equal to 2083.')
335
+ end
336
+
337
+ if @raw_url.to_s.length < 1
338
+ invalid_properties.push('invalid value for "raw_url", the character length must be great than or equal to 1.')
339
+ end
340
+
341
+ if @front_original_url.nil?
342
+ invalid_properties.push('invalid value for "front_original_url", front_original_url cannot be nil.')
343
+ end
344
+
345
+ if @front_original_url.to_s.length > 2083
346
+ invalid_properties.push('invalid value for "front_original_url", the character length must be smaller than or equal to 2083.')
347
+ end
348
+
349
+ if @front_original_url.to_s.length < 1
350
+ invalid_properties.push('invalid value for "front_original_url", the character length must be great than or equal to 1.')
351
+ end
352
+
353
+ if @back_original_url.nil?
354
+ invalid_properties.push('invalid value for "back_original_url", back_original_url cannot be nil.')
355
+ end
356
+
357
+ if @back_original_url.to_s.length > 2083
358
+ invalid_properties.push('invalid value for "back_original_url", the character length must be smaller than or equal to 2083.')
359
+ end
360
+
361
+ if @back_original_url.to_s.length < 1
362
+ invalid_properties.push('invalid value for "back_original_url", the character length must be great than or equal to 1.')
363
+ end
364
+
365
+ if @thumbnails.nil?
366
+ invalid_properties.push('invalid value for "thumbnails", thumbnails cannot be nil.')
367
+ end
368
+
369
+ if @available_quantity.nil?
370
+ invalid_properties.push('invalid value for "available_quantity", available_quantity cannot be nil.')
371
+ end
372
+
373
+ if @allocated_quantity.nil?
374
+ invalid_properties.push('invalid value for "allocated_quantity", allocated_quantity cannot be nil.')
375
+ end
376
+
377
+ if @onhand_quantity.nil?
378
+ invalid_properties.push('invalid value for "onhand_quantity", onhand_quantity cannot be nil.')
379
+ end
380
+
381
+ if @pending_quantity.nil?
382
+ invalid_properties.push('invalid value for "pending_quantity", pending_quantity cannot be nil.')
383
+ end
384
+
385
+ if @projected_quantity.nil?
386
+ invalid_properties.push('invalid value for "projected_quantity", projected_quantity cannot be nil.')
387
+ end
388
+
389
+ if @buckslip_orders.nil?
390
+ invalid_properties.push('invalid value for "buckslip_orders", buckslip_orders cannot be nil.')
391
+ end
392
+
393
+ if @buckslip_orders.length < 0
394
+ invalid_properties.push('invalid value for "buckslip_orders", number of items must be greater than or equal to 0.')
395
+ end
396
+
397
+ if @stock.nil?
398
+ invalid_properties.push('invalid value for "stock", stock cannot be nil.')
399
+ end
400
+
401
+ if @weight.nil?
402
+ invalid_properties.push('invalid value for "weight", weight cannot be nil.')
403
+ end
404
+
405
+ if @finish.nil?
406
+ invalid_properties.push('invalid value for "finish", finish cannot be nil.')
407
+ end
408
+
409
+ if @status.nil?
410
+ invalid_properties.push('invalid value for "status", status cannot be nil.')
411
+ end
412
+
413
+ if @object.nil?
414
+ invalid_properties.push('invalid value for "object", object cannot be nil.')
415
+ end
416
+
417
+ if @description.to_s.length > 255
418
+ invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
419
+ end
420
+
421
+ invalid_properties
422
+ end
423
+
424
+ # Check to see if the all the properties in the model are valid
425
+ # @return true if the model is valid
426
+ def valid?
427
+ return false if @id.nil?
428
+ return false if @id !~ Regexp.new(/^bck_[a-zA-Z0-9]+$/)
429
+ return false if @auto_reorder.nil?
430
+ return false if @threshold_amount.nil?
431
+ return false if @url.nil?
432
+ return false if @url.to_s.length > 2083
433
+ return false if @url.to_s.length < 1
434
+ return false if @raw_url.nil?
435
+ return false if @raw_url.to_s.length > 2083
436
+ return false if @raw_url.to_s.length < 1
437
+ return false if @front_original_url.nil?
438
+ return false if @front_original_url.to_s.length > 2083
439
+ return false if @front_original_url.to_s.length < 1
440
+ return false if @back_original_url.nil?
441
+ return false if @back_original_url.to_s.length > 2083
442
+ return false if @back_original_url.to_s.length < 1
443
+ return false if @thumbnails.nil?
444
+ return false if @available_quantity.nil?
445
+ return false if @allocated_quantity.nil?
446
+ return false if @onhand_quantity.nil?
447
+ return false if @pending_quantity.nil?
448
+ return false if @projected_quantity.nil?
449
+ return false if @buckslip_orders.nil?
450
+ return false if @buckslip_orders.length < 0
451
+ return false if @stock.nil?
452
+ stock_validator = EnumAttributeValidator.new('String', ["text", "cover"])
453
+ return false unless stock_validator.valid?(@stock)
454
+ return false if @weight.nil?
455
+ weight_validator = EnumAttributeValidator.new('String', ["80#"])
456
+ return false unless weight_validator.valid?(@weight)
457
+ return false if @finish.nil?
458
+ finish_validator = EnumAttributeValidator.new('String', ["gloss", "matte"])
459
+ return false unless finish_validator.valid?(@finish)
460
+ return false if @status.nil?
461
+ status_validator = EnumAttributeValidator.new('String', ["processed", "rendered"])
462
+ return false unless status_validator.valid?(@status)
463
+ return false if @object.nil?
464
+ object_validator = EnumAttributeValidator.new('String', ["buckslip"])
465
+ return false unless object_validator.valid?(@object)
466
+ return false if @description.to_s.length > 255
467
+ size_validator = EnumAttributeValidator.new('String', ["8.75x3.75"])
468
+ return false unless size_validator.valid?(@size)
469
+ true
470
+ end
471
+
472
+ # Custom attribute writer method with validation
473
+ # @param [Object] id Value to be assigned
474
+ def id=(id)
475
+ if id.nil?
476
+ fail ArgumentError, 'id cannot be nil'
477
+ end
478
+
479
+ pattern = Regexp.new(/^bck_[a-zA-Z0-9]+$/)
480
+ if id !~ pattern
481
+ fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
482
+ end
483
+
484
+ @id = id
485
+ end
486
+
487
+ # Custom attribute writer method with validation
488
+ # @param [Object] url Value to be assigned
489
+ def url=(url)
490
+ if url.nil?
491
+ fail ArgumentError, 'url cannot be nil'
492
+ end
493
+
494
+ if url.to_s.length > 2083
495
+ fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 2083.'
496
+ end
497
+
498
+ if url.to_s.length < 1
499
+ fail ArgumentError, 'invalid value for "url", the character length must be great than or equal to 1.'
500
+ end
501
+
502
+ @url = url
503
+ end
504
+
505
+ # Custom attribute writer method with validation
506
+ # @param [Object] raw_url Value to be assigned
507
+ def raw_url=(raw_url)
508
+ if raw_url.nil?
509
+ fail ArgumentError, 'raw_url cannot be nil'
510
+ end
511
+
512
+ if raw_url.to_s.length > 2083
513
+ fail ArgumentError, 'invalid value for "raw_url", the character length must be smaller than or equal to 2083.'
514
+ end
515
+
516
+ if raw_url.to_s.length < 1
517
+ fail ArgumentError, 'invalid value for "raw_url", the character length must be great than or equal to 1.'
518
+ end
519
+
520
+ @raw_url = raw_url
521
+ end
522
+
523
+ # Custom attribute writer method with validation
524
+ # @param [Object] front_original_url Value to be assigned
525
+ def front_original_url=(front_original_url)
526
+ if front_original_url.nil?
527
+ fail ArgumentError, 'front_original_url cannot be nil'
528
+ end
529
+
530
+ if front_original_url.to_s.length > 2083
531
+ fail ArgumentError, 'invalid value for "front_original_url", the character length must be smaller than or equal to 2083.'
532
+ end
533
+
534
+ if front_original_url.to_s.length < 1
535
+ fail ArgumentError, 'invalid value for "front_original_url", the character length must be great than or equal to 1.'
536
+ end
537
+
538
+ @front_original_url = front_original_url
539
+ end
540
+
541
+ # Custom attribute writer method with validation
542
+ # @param [Object] back_original_url Value to be assigned
543
+ def back_original_url=(back_original_url)
544
+ if back_original_url.nil?
545
+ fail ArgumentError, 'back_original_url cannot be nil'
546
+ end
547
+
548
+ if back_original_url.to_s.length > 2083
549
+ fail ArgumentError, 'invalid value for "back_original_url", the character length must be smaller than or equal to 2083.'
550
+ end
551
+
552
+ if back_original_url.to_s.length < 1
553
+ fail ArgumentError, 'invalid value for "back_original_url", the character length must be great than or equal to 1.'
554
+ end
555
+
556
+ @back_original_url = back_original_url
557
+ end
558
+
559
+ # Custom attribute writer method with validation
560
+ # @param [Object] buckslip_orders Value to be assigned
561
+ def buckslip_orders=(buckslip_orders)
562
+ if buckslip_orders.nil?
563
+ fail ArgumentError, 'buckslip_orders cannot be nil'
564
+ end
565
+
566
+ if buckslip_orders.length < 0
567
+ fail ArgumentError, 'invalid value for "buckslip_orders", number of items must be greater than or equal to 0.'
568
+ end
569
+
570
+ @buckslip_orders = buckslip_orders
571
+ end
572
+
573
+ # Custom attribute writer method checking allowed values (enum).
574
+ # @param [Object] stock Object to be assigned
575
+ def stock=(stock)
576
+ validator = EnumAttributeValidator.new('String', ["text", "cover"])
577
+ unless validator.valid?(stock)
578
+ fail ArgumentError, "invalid value for \"stock\", must be one of #{validator.allowable_values}."
579
+ end
580
+ @stock = stock
581
+ end
582
+
583
+ # Custom attribute writer method checking allowed values (enum).
584
+ # @param [Object] weight Object to be assigned
585
+ def weight=(weight)
586
+ validator = EnumAttributeValidator.new('String', ["80#"])
587
+ unless validator.valid?(weight)
588
+ fail ArgumentError, "invalid value for \"weight\", must be one of #{validator.allowable_values}."
589
+ end
590
+ @weight = weight
591
+ end
592
+
593
+ # Custom attribute writer method checking allowed values (enum).
594
+ # @param [Object] finish Object to be assigned
595
+ def finish=(finish)
596
+ validator = EnumAttributeValidator.new('String', ["gloss", "matte"])
597
+ unless validator.valid?(finish)
598
+ fail ArgumentError, "invalid value for \"finish\", must be one of #{validator.allowable_values}."
599
+ end
600
+ @finish = finish
601
+ end
602
+
603
+ # Custom attribute writer method checking allowed values (enum).
604
+ # @param [Object] status Object to be assigned
605
+ def status=(status)
606
+ validator = EnumAttributeValidator.new('String', ["processed", "rendered"])
607
+ unless validator.valid?(status)
608
+ fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
609
+ end
610
+ @status = status
611
+ end
612
+
613
+ # Custom attribute writer method checking allowed values (enum).
614
+ # @param [Object] object Object to be assigned
615
+ def object=(object)
616
+ validator = EnumAttributeValidator.new('String', ["buckslip"])
617
+ unless validator.valid?(object)
618
+ fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
619
+ end
620
+ @object = object
621
+ end
622
+
623
+ # Custom attribute writer method with validation
624
+ # @param [Object] description Value to be assigned
625
+ def description=(description)
626
+ if description.to_s.length > 255
627
+ fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
628
+ end
629
+
630
+ @description = description
631
+ end
632
+
633
+ # Custom attribute writer method checking allowed values (enum).
634
+ # @param [Object] size Object to be assigned
635
+ def size=(size)
636
+ validator = EnumAttributeValidator.new('String', ["8.75x3.75"])
637
+ unless validator.valid?(size)
638
+ fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
639
+ end
640
+ @size = size
641
+ end
642
+
643
+ # Checks equality by comparing each attribute.
644
+ # @param [Object] Object to be compared
645
+ def ==(o)
646
+ return true if self.equal?(o)
647
+ self.class == o.class &&
648
+ id == o.id &&
649
+ auto_reorder == o.auto_reorder &&
650
+ reorder_quantity == o.reorder_quantity &&
651
+ threshold_amount == o.threshold_amount &&
652
+ url == o.url &&
653
+ raw_url == o.raw_url &&
654
+ front_original_url == o.front_original_url &&
655
+ back_original_url == o.back_original_url &&
656
+ thumbnails == o.thumbnails &&
657
+ available_quantity == o.available_quantity &&
658
+ allocated_quantity == o.allocated_quantity &&
659
+ onhand_quantity == o.onhand_quantity &&
660
+ pending_quantity == o.pending_quantity &&
661
+ projected_quantity == o.projected_quantity &&
662
+ buckslip_orders == o.buckslip_orders &&
663
+ stock == o.stock &&
664
+ weight == o.weight &&
665
+ finish == o.finish &&
666
+ status == o.status &&
667
+ object == o.object &&
668
+ description == o.description &&
669
+ size == o.size
670
+ end
671
+
672
+ # @see the `==` method
673
+ # @param [Object] Object to be compared
674
+ def eql?(o)
675
+ self == o
676
+ end
677
+
678
+ # Calculates hash code according to all attributes.
679
+ # @return [Integer] Hash code
680
+ def hash
681
+ [id, auto_reorder, reorder_quantity, threshold_amount, url, raw_url, front_original_url, back_original_url, thumbnails, available_quantity, allocated_quantity, onhand_quantity, pending_quantity, projected_quantity, buckslip_orders, stock, weight, finish, status, object, description, size].hash
682
+ end
683
+
684
+
685
+ # Builds the object from hash
686
+ # @param [Hash] attributes Model attributes in the form of hash
687
+ # @return [Object] Returns the model itself
688
+ def self.build_from_hash(attributes)
689
+ new.build_from_hash(attributes)
690
+ end
691
+
692
+ # Builds the object from hash
693
+ # @param [Hash] attributes Model attributes in the form of hash
694
+ # @return [Object] Returns the model itself
695
+ def build_from_hash(attributes)
696
+ return nil unless attributes.is_a?(Hash)
697
+ attributes = attributes.transform_keys(&:to_sym)
698
+ self.class.openapi_types.each_pair do |key, type|
699
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
700
+ self.send("#{key}=", nil) # // guardrails-disable-line
701
+ elsif type =~ /\AArray<(.*)>/i
702
+ # check to ensure the input is an array given that the attribute
703
+ # is documented as an array but the input is not
704
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
705
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
706
+ end
707
+ elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
708
+ for base_type in type do
709
+ res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
710
+ if !res.nil?
711
+ self.send("#{key}=", res) # // guardrails-disable-line
712
+ break
713
+ end
714
+ end
715
+ elsif !attributes[self.class.attribute_map[key]].nil?
716
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
717
+ end
718
+ end
719
+
720
+ self
721
+ end
722
+
723
+ # Deserializes the data based on type
724
+ # @param string type Data type
725
+ # @param string value Value to be deserialized
726
+ # @return [Object] Deserialized data
727
+ def _deserialize(type, value)
728
+ case type.to_sym
729
+ when :Time
730
+ Time.parse(value)
731
+ when :Date
732
+ Date.parse(value)
733
+ when :String
734
+ value.to_s
735
+ when :Integer
736
+ value.to_i
737
+ when :Float
738
+ value.to_f
739
+ when :Boolean
740
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
741
+ true
742
+ else
743
+ false
744
+ end
745
+ when :Object
746
+ # generic object (usually a Hash), return directly
747
+ value
748
+ when /\AArray<(?<inner_type>.+)>\z/
749
+ inner_type = Regexp.last_match[:inner_type]
750
+ value.map { |v| _deserialize(inner_type, v) }
751
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
752
+ k_type = Regexp.last_match[:k_type]
753
+ v_type = Regexp.last_match[:v_type]
754
+ {}.tap do |hash|
755
+ value.each do |k, v|
756
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
757
+ end
758
+ end
759
+ else # model
760
+ # models (e.g. Pet) or oneOf
761
+ klass = Lob.const_get(type)
762
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
763
+ end
764
+ end
765
+
766
+ # Returns the string representation of the object
767
+ # @return [String] String presentation of the object
768
+ def to_s
769
+ to_hash.to_s
770
+ end
771
+
772
+ # to_body is an alias to to_hash (backward compatibility)
773
+ # @return [Hash] Returns the object in the form of hash
774
+ def to_body
775
+ to_hash
776
+ end
777
+
778
+ # Returns the object in the form of hash
779
+ # @return [Hash] Returns the object in the form of hash
780
+ def to_hash
781
+ hash = {}
782
+ self.class.attribute_map.each_pair do |attr, param|
783
+ value = self.send(attr) # // guardrails-disable-line
784
+ if value.nil?
785
+ is_nullable = self.class.openapi_nullable.include?(attr)
786
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
787
+ end
788
+
789
+ hash[param] = _to_hash(value)
790
+ end
791
+ hash
792
+ end
793
+
794
+ # Outputs non-array value in the form of hash
795
+ # For object, use to_hash. Otherwise, just return the value
796
+ # @param [Object] value Any valid value
797
+ # @return [Hash] Returns the value in the form of hash
798
+ def _to_hash(value)
799
+ if value.is_a?(Array)
800
+ value.compact.map { |v| _to_hash(v) }
801
+ elsif value.is_a?(Hash)
802
+ {}.tap do |hash|
803
+ value.each { |k, v| hash[k] = _to_hash(v) }
804
+ end
805
+ elsif value.respond_to? :to_hash
806
+ value.to_hash
807
+ else
808
+ value
809
+ end
810
+ end
811
+
812
+ end
813
+
814
+ end