solifyn 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (565) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +344 -0
  4. data/Rakefile +10 -0
  5. data/docs/AddCollectionProductsDto.md +18 -0
  6. data/docs/Addon.md +26 -0
  7. data/docs/AddonCreate.md +26 -0
  8. data/docs/AddonUpdate.md +24 -0
  9. data/docs/AffiliateApi.md +845 -0
  10. data/docs/ApiKeyResponseDto.md +34 -0
  11. data/docs/AppPortalUrlResponseDto.md +18 -0
  12. data/docs/BalanceApi.md +184 -0
  13. data/docs/BillingApi.md +68 -0
  14. data/docs/Brand.md +40 -0
  15. data/docs/BrandCreate.md +28 -0
  16. data/docs/BrandUpdate.md +28 -0
  17. data/docs/BrandsApi.md +286 -0
  18. data/docs/Business.md +56 -0
  19. data/docs/BusinessCreate.md +18 -0
  20. data/docs/BusinessFullCreate.md +26 -0
  21. data/docs/BusinessFullCreateResponse.md +20 -0
  22. data/docs/BusinessesApi.md +350 -0
  23. data/docs/ChatApi.md +246 -0
  24. data/docs/CheckoutApi.md +405 -0
  25. data/docs/CheckoutLinkMessageResponseDto.md +18 -0
  26. data/docs/CheckoutLinkResponseDto.md +50 -0
  27. data/docs/CheckoutLinksApi.md +356 -0
  28. data/docs/CheckoutResponseDto.md +22 -0
  29. data/docs/CheckoutSessionDetailsDto.md +38 -0
  30. data/docs/CollectionArchivedResponseDto.md +18 -0
  31. data/docs/CollectionDetailResponseDto.md +36 -0
  32. data/docs/CollectionProductDeletedResponseDto.md +18 -0
  33. data/docs/CollectionProductDto.md +84 -0
  34. data/docs/CollectionProductEntry.md +20 -0
  35. data/docs/CollectionProductRefDto.md +20 -0
  36. data/docs/CollectionProductUpdatedResponseDto.md +18 -0
  37. data/docs/CollectionResponseDto.md +36 -0
  38. data/docs/CollectionUnarchivedResponseDto.md +18 -0
  39. data/docs/CollectionUpdatedResponseDto.md +18 -0
  40. data/docs/CollectionsApi.md +711 -0
  41. data/docs/CommunityApi.md +497 -0
  42. data/docs/CreateApiKeyDto.md +20 -0
  43. data/docs/CreateCheckoutDto.md +36 -0
  44. data/docs/CreateCheckoutLinkDto.md +44 -0
  45. data/docs/CreateCollectionCheckoutDto.md +26 -0
  46. data/docs/CreateCollectionDto.md +26 -0
  47. data/docs/CreateCustomerDto.md +26 -0
  48. data/docs/CreateMeterDto.md +32 -0
  49. data/docs/CreateSetupCheckoutDto.md +26 -0
  50. data/docs/CreateWebhookEndpointDto.md +22 -0
  51. data/docs/CustomerListResponseDto.md +20 -0
  52. data/docs/CustomerMessageResponseDto.md +18 -0
  53. data/docs/CustomerResponseDto.md +38 -0
  54. data/docs/CustomerSharedInviteResponseDto.md +22 -0
  55. data/docs/CustomersApi.md +356 -0
  56. data/docs/DashboardStatsDto.md +24 -0
  57. data/docs/DefaultApi.md +930 -0
  58. data/docs/DeveloperApi.md +628 -0
  59. data/docs/DigitalFileApi.md +187 -0
  60. data/docs/Discount.md +42 -0
  61. data/docs/DiscountCreate.md +36 -0
  62. data/docs/DiscountUpdate.md +34 -0
  63. data/docs/DiscountsApi.md +441 -0
  64. data/docs/DiscountsList200Response.md +24 -0
  65. data/docs/DiscountsList200ResponsePagination.md +22 -0
  66. data/docs/Dispute.md +58 -0
  67. data/docs/DisputeAttachmentDto.md +18 -0
  68. data/docs/DisputeEvidenceDto.md +24 -0
  69. data/docs/DisputeEvidenceUpdate.md +24 -0
  70. data/docs/DisputeFileUpload.md +24 -0
  71. data/docs/DisputeList.md +20 -0
  72. data/docs/DisputeListMetaDto.md +24 -0
  73. data/docs/DisputesApi.md +442 -0
  74. data/docs/Instance.md +30 -0
  75. data/docs/Invoice.md +26 -0
  76. data/docs/License.md +48 -0
  77. data/docs/LicenseApi.md +716 -0
  78. data/docs/LicenseKeysApi.md +716 -0
  79. data/docs/LicenseKeysClientApi.md +289 -0
  80. data/docs/LicenseSubDto.md +30 -0
  81. data/docs/LicenseValidationResponse.md +22 -0
  82. data/docs/LicensesActivateRequest.md +22 -0
  83. data/docs/LicensesCreateRequest.md +26 -0
  84. data/docs/LicensesDeactivate200Response.md +18 -0
  85. data/docs/LicensesDeactivateRequest.md +18 -0
  86. data/docs/LicensesUpdateInstancePostRequest.md +20 -0
  87. data/docs/LicensesUpdateRequest.md +22 -0
  88. data/docs/LicensesVerifyRequest.md +20 -0
  89. data/docs/MeterDetailResponseDto.md +44 -0
  90. data/docs/MeterEventsResponseDto.md +22 -0
  91. data/docs/MeterIngestEventDto.md +28 -0
  92. data/docs/MeterIngestRequestDto.md +18 -0
  93. data/docs/MeterIngestResponseDto.md +22 -0
  94. data/docs/MeterQuantitiesCostDto.md +26 -0
  95. data/docs/MeterQuantitiesResponseDto.md +24 -0
  96. data/docs/MeterResponseDto.md +40 -0
  97. data/docs/MeterUsageEventDto.md +30 -0
  98. data/docs/MetersApi.md +515 -0
  99. data/docs/OperationalWebhookEndpointHeadersInDto.md +18 -0
  100. data/docs/OperationalWebhookEndpointHeadersResponseDto.md +20 -0
  101. data/docs/OperationalWebhookEndpointInDto.md +32 -0
  102. data/docs/OperationalWebhookEndpointListResponseDto.md +24 -0
  103. data/docs/OperationalWebhookEndpointResponseDto.md +38 -0
  104. data/docs/OperationalWebhookEndpointSecretInDto.md +18 -0
  105. data/docs/OperationalWebhookEndpointSecretResponseDto.md +18 -0
  106. data/docs/OperationalWebhookEndpointUpdateDto.md +30 -0
  107. data/docs/Order.md +68 -0
  108. data/docs/OrderBilling.md +26 -0
  109. data/docs/OrderBillingUpdate.md +26 -0
  110. data/docs/OrderCustomer.md +24 -0
  111. data/docs/OrderDetail.md +22 -0
  112. data/docs/OrderList.md +20 -0
  113. data/docs/OrderProductCart.md +26 -0
  114. data/docs/OrderRefund.md +32 -0
  115. data/docs/OrderRefundCreate.md +26 -0
  116. data/docs/OrderUpdate.md +18 -0
  117. data/docs/OrdersApi.md +369 -0
  118. data/docs/PartnerApi.md +125 -0
  119. data/docs/PayoutAccessToken.md +20 -0
  120. data/docs/PayoutAccount.md +22 -0
  121. data/docs/PayoutAccountLink.md +20 -0
  122. data/docs/PayoutMethod.md +24 -0
  123. data/docs/PayoutMethodList.md +18 -0
  124. data/docs/PayoutVerification.md +24 -0
  125. data/docs/PayoutVerificationList.md +18 -0
  126. data/docs/PayoutsApi.md +579 -0
  127. data/docs/PricePreviewResponseDto.md +24 -0
  128. data/docs/Product.md +82 -0
  129. data/docs/ProductAddOnsApi.md +433 -0
  130. data/docs/ProductCreate.md +62 -0
  131. data/docs/ProductCreateAddonsInner.md +26 -0
  132. data/docs/ProductCreateCustomFieldsInner.md +24 -0
  133. data/docs/ProductMessageResponseDto.md +18 -0
  134. data/docs/ProductSubDto.md +22 -0
  135. data/docs/ProductUpdate.md +62 -0
  136. data/docs/ProductsApi.md +445 -0
  137. data/docs/ProductsArchive200Response.md +18 -0
  138. data/docs/ProductsList200Response.md +20 -0
  139. data/docs/ProductsList200ResponsePagination.md +20 -0
  140. data/docs/ProductsUnarchive200Response.md +18 -0
  141. data/docs/Refund.md +42 -0
  142. data/docs/RefundRequestsApi.md +311 -0
  143. data/docs/RefundsChargebacksApi.md +215 -0
  144. data/docs/ResolvedAddon.md +24 -0
  145. data/docs/RevokeSeatDto.md +20 -0
  146. data/docs/Subscription.md +68 -0
  147. data/docs/SubscriptionAction.md +30 -0
  148. data/docs/SubscriptionCompanyDto.md +20 -0
  149. data/docs/SubscriptionDetail.md +24 -0
  150. data/docs/SubscriptionDetailProduct.md +28 -0
  151. data/docs/SubscriptionList.md +20 -0
  152. data/docs/SubscriptionMemberDto.md +18 -0
  153. data/docs/SubscriptionPlanDto.md +20 -0
  154. data/docs/SubscriptionProductDto.md +22 -0
  155. data/docs/SubscriptionSeatAdjustment.md +34 -0
  156. data/docs/SubscriptionUserDto.md +24 -0
  157. data/docs/SubscriptionsAction201Response.md +49 -0
  158. data/docs/SubscriptionsApi.md +223 -0
  159. data/docs/SupportedCurrenciesResponseDto.md +20 -0
  160. data/docs/TicketApi.md +318 -0
  161. data/docs/UpdateCheckoutLinkDto.md +44 -0
  162. data/docs/UpdateCollectionDto.md +22 -0
  163. data/docs/UpdateCollectionProductDto.md +18 -0
  164. data/docs/UpdateCustomerDto.md +24 -0
  165. data/docs/UpdateInstanceDto.md +20 -0
  166. data/docs/UpdateMeterDto.md +32 -0
  167. data/docs/UpdateWebhookEndpointDto.md +24 -0
  168. data/docs/UserPage.md +26 -0
  169. data/docs/UserProfileThemesApi.md +345 -0
  170. data/docs/UserSettings.md +34 -0
  171. data/docs/UserSettingsUpdate.md +76 -0
  172. data/docs/UserStats.md +20 -0
  173. data/docs/UserTheme.md +26 -0
  174. data/docs/UserThemeUpdate.md +22 -0
  175. data/docs/WebhookApi.md +128 -0
  176. data/docs/WebhookDeliveryResponseDto.md +34 -0
  177. data/docs/WebhookDisputePayload.md +42 -0
  178. data/docs/WebhookEndpointApi.md +574 -0
  179. data/docs/WebhookEndpointResponseDto.md +34 -0
  180. data/docs/WebhookLicensePayload.md +48 -0
  181. data/docs/WebhookPaymentPayload.md +116 -0
  182. data/docs/WebhookPaymentPayloadBillingAddress.md +30 -0
  183. data/docs/WebhookRefundPayload.md +38 -0
  184. data/docs/WebhookSubscriptionPayload.md +44 -0
  185. data/docs/WhopApiKeysRotation.md +18 -0
  186. data/docs/Withdrawal.md +46 -0
  187. data/docs/WithdrawalCreate.md +22 -0
  188. data/docs/WithdrawalList.md +20 -0
  189. data/git_push.sh +57 -0
  190. data/lib/solifyn/api/affiliate_api.rb +760 -0
  191. data/lib/solifyn/api/balance_api.rb +175 -0
  192. data/lib/solifyn/api/billing_api.rb +77 -0
  193. data/lib/solifyn/api/brands_api.rb +284 -0
  194. data/lib/solifyn/api/businesses_api.rb +338 -0
  195. data/lib/solifyn/api/chat_api.rb +232 -0
  196. data/lib/solifyn/api/checkout_api.rb +427 -0
  197. data/lib/solifyn/api/checkout_links_api.rb +347 -0
  198. data/lib/solifyn/api/collections_api.rb +690 -0
  199. data/lib/solifyn/api/community_api.rb +466 -0
  200. data/lib/solifyn/api/customers_api.rb +347 -0
  201. data/lib/solifyn/api/default_api.rb +828 -0
  202. data/lib/solifyn/api/developer_api.rb +631 -0
  203. data/lib/solifyn/api/digital_file_api.rb +181 -0
  204. data/lib/solifyn/api/discounts_api.rb +437 -0
  205. data/lib/solifyn/api/disputes_api.rb +424 -0
  206. data/lib/solifyn/api/license_api.rb +702 -0
  207. data/lib/solifyn/api/license_keys_api.rb +702 -0
  208. data/lib/solifyn/api/license_keys_client_api.rb +295 -0
  209. data/lib/solifyn/api/meters_api.rb +508 -0
  210. data/lib/solifyn/api/orders_api.rb +372 -0
  211. data/lib/solifyn/api/partner_api.rb +124 -0
  212. data/lib/solifyn/api/payouts_api.rb +520 -0
  213. data/lib/solifyn/api/product_add_ons_api.rb +432 -0
  214. data/lib/solifyn/api/products_api.rb +438 -0
  215. data/lib/solifyn/api/refund_requests_api.rb +305 -0
  216. data/lib/solifyn/api/refunds_chargebacks_api.rb +214 -0
  217. data/lib/solifyn/api/subscriptions_api.rb +230 -0
  218. data/lib/solifyn/api/ticket_api.rb +328 -0
  219. data/lib/solifyn/api/user_profile_themes_api.rb +313 -0
  220. data/lib/solifyn/api/webhook_api.rb +131 -0
  221. data/lib/solifyn/api/webhook_endpoint_api.rb +597 -0
  222. data/lib/solifyn/api_client.rb +394 -0
  223. data/lib/solifyn/api_error.rb +58 -0
  224. data/lib/solifyn/configuration.rb +313 -0
  225. data/lib/solifyn/models/add_collection_products_dto.rb +224 -0
  226. data/lib/solifyn/models/addon.rb +290 -0
  227. data/lib/solifyn/models/addon_create.rb +276 -0
  228. data/lib/solifyn/models/addon_update.rb +245 -0
  229. data/lib/solifyn/models/api_key_response_dto.rb +336 -0
  230. data/lib/solifyn/models/app_portal_url_response_dto.rb +221 -0
  231. data/lib/solifyn/models/brand.rb +367 -0
  232. data/lib/solifyn/models/brand_create.rb +310 -0
  233. data/lib/solifyn/models/brand_update.rb +303 -0
  234. data/lib/solifyn/models/business.rb +482 -0
  235. data/lib/solifyn/models/business_create.rb +241 -0
  236. data/lib/solifyn/models/business_full_create.rb +288 -0
  237. data/lib/solifyn/models/business_full_create_response.rb +239 -0
  238. data/lib/solifyn/models/checkout_link_message_response_dto.rb +222 -0
  239. data/lib/solifyn/models/checkout_link_response_dto.rb +410 -0
  240. data/lib/solifyn/models/checkout_response_dto.rb +256 -0
  241. data/lib/solifyn/models/checkout_session_details_dto.rb +350 -0
  242. data/lib/solifyn/models/collection_archived_response_dto.rb +222 -0
  243. data/lib/solifyn/models/collection_detail_response_dto.rb +390 -0
  244. data/lib/solifyn/models/collection_product_deleted_response_dto.rb +222 -0
  245. data/lib/solifyn/models/collection_product_dto.rb +826 -0
  246. data/lib/solifyn/models/collection_product_entry.rb +258 -0
  247. data/lib/solifyn/models/collection_product_ref_dto.rb +239 -0
  248. data/lib/solifyn/models/collection_product_updated_response_dto.rb +222 -0
  249. data/lib/solifyn/models/collection_response_dto.rb +390 -0
  250. data/lib/solifyn/models/collection_unarchived_response_dto.rb +222 -0
  251. data/lib/solifyn/models/collection_updated_response_dto.rb +222 -0
  252. data/lib/solifyn/models/create_api_key_dto.rb +234 -0
  253. data/lib/solifyn/models/create_checkout_dto.rb +314 -0
  254. data/lib/solifyn/models/create_checkout_link_dto.rb +582 -0
  255. data/lib/solifyn/models/create_collection_checkout_dto.rb +264 -0
  256. data/lib/solifyn/models/create_collection_dto.rb +305 -0
  257. data/lib/solifyn/models/create_customer_dto.rb +345 -0
  258. data/lib/solifyn/models/create_meter_dto.rb +344 -0
  259. data/lib/solifyn/models/create_setup_checkout_dto.rb +264 -0
  260. data/lib/solifyn/models/create_webhook_endpoint_dto.rb +251 -0
  261. data/lib/solifyn/models/customer_list_response_dto.rb +241 -0
  262. data/lib/solifyn/models/customer_message_response_dto.rb +222 -0
  263. data/lib/solifyn/models/customer_response_dto.rb +350 -0
  264. data/lib/solifyn/models/customer_shared_invite_response_dto.rb +249 -0
  265. data/lib/solifyn/models/dashboard_stats_dto.rb +273 -0
  266. data/lib/solifyn/models/discount.rb +466 -0
  267. data/lib/solifyn/models/discount_create.rb +362 -0
  268. data/lib/solifyn/models/discount_update.rb +331 -0
  269. data/lib/solifyn/models/discounts_list200_response.rb +273 -0
  270. data/lib/solifyn/models/discounts_list200_response_pagination.rb +256 -0
  271. data/lib/solifyn/models/dispute.rb +492 -0
  272. data/lib/solifyn/models/dispute_attachment_dto.rb +222 -0
  273. data/lib/solifyn/models/dispute_evidence_dto.rb +245 -0
  274. data/lib/solifyn/models/dispute_evidence_update.rb +245 -0
  275. data/lib/solifyn/models/dispute_file_upload.rb +259 -0
  276. data/lib/solifyn/models/dispute_list.rb +241 -0
  277. data/lib/solifyn/models/dispute_list_meta_dto.rb +273 -0
  278. data/lib/solifyn/models/instance.rb +325 -0
  279. data/lib/solifyn/models/invoice.rb +291 -0
  280. data/lib/solifyn/models/license.rb +512 -0
  281. data/lib/solifyn/models/license_sub_dto.rb +310 -0
  282. data/lib/solifyn/models/license_validation_response.rb +253 -0
  283. data/lib/solifyn/models/licenses_activate_request.rb +256 -0
  284. data/lib/solifyn/models/licenses_create_request.rb +269 -0
  285. data/lib/solifyn/models/licenses_deactivate200_response.rb +214 -0
  286. data/lib/solifyn/models/licenses_deactivate_request.rb +222 -0
  287. data/lib/solifyn/models/licenses_update_instance_post_request.rb +225 -0
  288. data/lib/solifyn/models/licenses_update_request.rb +266 -0
  289. data/lib/solifyn/models/licenses_verify_request.rb +239 -0
  290. data/lib/solifyn/models/meter_detail_response_dto.rb +454 -0
  291. data/lib/solifyn/models/meter_events_response_dto.rb +259 -0
  292. data/lib/solifyn/models/meter_ingest_event_dto.rb +290 -0
  293. data/lib/solifyn/models/meter_ingest_request_dto.rb +224 -0
  294. data/lib/solifyn/models/meter_ingest_response_dto.rb +258 -0
  295. data/lib/solifyn/models/meter_quantities_cost_dto.rb +290 -0
  296. data/lib/solifyn/models/meter_quantities_response_dto.rb +276 -0
  297. data/lib/solifyn/models/meter_response_dto.rb +418 -0
  298. data/lib/solifyn/models/meter_usage_event_dto.rb +319 -0
  299. data/lib/solifyn/models/operational_webhook_endpoint_headers_in_dto.rb +222 -0
  300. data/lib/solifyn/models/operational_webhook_endpoint_headers_response_dto.rb +241 -0
  301. data/lib/solifyn/models/operational_webhook_endpoint_in_dto.rb +315 -0
  302. data/lib/solifyn/models/operational_webhook_endpoint_list_response_dto.rb +257 -0
  303. data/lib/solifyn/models/operational_webhook_endpoint_response_dto.rb +363 -0
  304. data/lib/solifyn/models/operational_webhook_endpoint_secret_in_dto.rb +215 -0
  305. data/lib/solifyn/models/operational_webhook_endpoint_secret_response_dto.rb +221 -0
  306. data/lib/solifyn/models/operational_webhook_endpoint_update_dto.rb +303 -0
  307. data/lib/solifyn/models/order.rb +582 -0
  308. data/lib/solifyn/models/order_billing.rb +255 -0
  309. data/lib/solifyn/models/order_billing_update.rb +250 -0
  310. data/lib/solifyn/models/order_customer.rb +266 -0
  311. data/lib/solifyn/models/order_detail.rb +237 -0
  312. data/lib/solifyn/models/order_list.rb +241 -0
  313. data/lib/solifyn/models/order_product_cart.rb +283 -0
  314. data/lib/solifyn/models/order_refund.rb +334 -0
  315. data/lib/solifyn/models/order_refund_create.rb +278 -0
  316. data/lib/solifyn/models/order_update.rb +214 -0
  317. data/lib/solifyn/models/payout_access_token.rb +239 -0
  318. data/lib/solifyn/models/payout_account.rb +249 -0
  319. data/lib/solifyn/models/payout_account_link.rb +239 -0
  320. data/lib/solifyn/models/payout_method.rb +266 -0
  321. data/lib/solifyn/models/payout_method_list.rb +224 -0
  322. data/lib/solifyn/models/payout_verification.rb +266 -0
  323. data/lib/solifyn/models/payout_verification_list.rb +224 -0
  324. data/lib/solifyn/models/price_preview_response_dto.rb +273 -0
  325. data/lib/solifyn/models/product.rb +810 -0
  326. data/lib/solifyn/models/product_create.rb +527 -0
  327. data/lib/solifyn/models/product_create_addons_inner.rb +250 -0
  328. data/lib/solifyn/models/product_create_custom_fields_inner.rb +241 -0
  329. data/lib/solifyn/models/product_message_response_dto.rb +222 -0
  330. data/lib/solifyn/models/product_sub_dto.rb +253 -0
  331. data/lib/solifyn/models/product_update.rb +501 -0
  332. data/lib/solifyn/models/products_archive200_response.rb +214 -0
  333. data/lib/solifyn/models/products_list200_response.rb +239 -0
  334. data/lib/solifyn/models/products_list200_response_pagination.rb +239 -0
  335. data/lib/solifyn/models/products_unarchive200_response.rb +214 -0
  336. data/lib/solifyn/models/refund.rb +425 -0
  337. data/lib/solifyn/models/resolved_addon.rb +273 -0
  338. data/lib/solifyn/models/revoke_seat_dto.rb +239 -0
  339. data/lib/solifyn/models/subscription.rb +627 -0
  340. data/lib/solifyn/models/subscription_action.rb +392 -0
  341. data/lib/solifyn/models/subscription_company_dto.rb +239 -0
  342. data/lib/solifyn/models/subscription_detail.rb +278 -0
  343. data/lib/solifyn/models/subscription_detail_product.rb +300 -0
  344. data/lib/solifyn/models/subscription_list.rb +241 -0
  345. data/lib/solifyn/models/subscription_member_dto.rb +222 -0
  346. data/lib/solifyn/models/subscription_plan_dto.rb +232 -0
  347. data/lib/solifyn/models/subscription_product_dto.rb +249 -0
  348. data/lib/solifyn/models/subscription_seat_adjustment.rb +359 -0
  349. data/lib/solifyn/models/subscription_user_dto.rb +273 -0
  350. data/lib/solifyn/models/subscriptions_action201_response.rb +105 -0
  351. data/lib/solifyn/models/supported_currencies_response_dto.rb +239 -0
  352. data/lib/solifyn/models/update_checkout_link_dto.rb +575 -0
  353. data/lib/solifyn/models/update_collection_dto.rb +235 -0
  354. data/lib/solifyn/models/update_collection_product_dto.rb +241 -0
  355. data/lib/solifyn/models/update_customer_dto.rb +302 -0
  356. data/lib/solifyn/models/update_instance_dto.rb +225 -0
  357. data/lib/solifyn/models/update_meter_dto.rb +321 -0
  358. data/lib/solifyn/models/update_webhook_endpoint_dto.rb +281 -0
  359. data/lib/solifyn/models/user_page.rb +290 -0
  360. data/lib/solifyn/models/user_settings.rb +337 -0
  361. data/lib/solifyn/models/user_settings_update.rb +505 -0
  362. data/lib/solifyn/models/user_stats.rb +241 -0
  363. data/lib/solifyn/models/user_theme.rb +276 -0
  364. data/lib/solifyn/models/user_theme_update.rb +235 -0
  365. data/lib/solifyn/models/webhook_delivery_response_dto.rb +328 -0
  366. data/lib/solifyn/models/webhook_dispute_payload.rb +324 -0
  367. data/lib/solifyn/models/webhook_endpoint_response_dto.rb +339 -0
  368. data/lib/solifyn/models/webhook_license_payload.rb +512 -0
  369. data/lib/solifyn/models/webhook_payment_payload.rb +659 -0
  370. data/lib/solifyn/models/webhook_payment_payload_billing_address.rb +268 -0
  371. data/lib/solifyn/models/webhook_refund_payload.rb +306 -0
  372. data/lib/solifyn/models/webhook_subscription_payload.rb +333 -0
  373. data/lib/solifyn/models/whop_api_keys_rotation.rb +222 -0
  374. data/lib/solifyn/models/withdrawal.rb +411 -0
  375. data/lib/solifyn/models/withdrawal_create.rb +249 -0
  376. data/lib/solifyn/models/withdrawal_list.rb +241 -0
  377. data/lib/solifyn/version.rb +15 -0
  378. data/lib/solifyn.rb +191 -0
  379. data/solifyn.gemspec +39 -0
  380. data/spec/api/affiliate_api_spec.rb +165 -0
  381. data/spec/api/balance_api_spec.rb +62 -0
  382. data/spec/api/billing_api_spec.rb +46 -0
  383. data/spec/api/brands_api_spec.rb +83 -0
  384. data/spec/api/businesses_api_spec.rb +93 -0
  385. data/spec/api/chat_api_spec.rb +72 -0
  386. data/spec/api/checkout_api_spec.rb +99 -0
  387. data/spec/api/checkout_links_api_spec.rb +95 -0
  388. data/spec/api/collections_api_spec.rb +158 -0
  389. data/spec/api/community_api_spec.rb +113 -0
  390. data/spec/api/customers_api_spec.rb +95 -0
  391. data/spec/api/default_api_spec.rb +191 -0
  392. data/spec/api/developer_api_spec.rb +120 -0
  393. data/spec/api/digital_file_api_spec.rb +63 -0
  394. data/spec/api/discounts_api_spec.rb +113 -0
  395. data/spec/api/disputes_api_spec.rb +113 -0
  396. data/spec/api/license_api_spec.rb +160 -0
  397. data/spec/api/license_keys_api_spec.rb +160 -0
  398. data/spec/api/license_keys_client_api_spec.rb +84 -0
  399. data/spec/api/meters_api_spec.rb +125 -0
  400. data/spec/api/orders_api_spec.rb +103 -0
  401. data/spec/api/partner_api_spec.rb +53 -0
  402. data/spec/api/payouts_api_spec.rb +133 -0
  403. data/spec/api/product_add_ons_api_spec.rb +111 -0
  404. data/spec/api/products_api_spec.rb +115 -0
  405. data/spec/api/refund_requests_api_spec.rb +88 -0
  406. data/spec/api/refunds_chargebacks_api_spec.rb +71 -0
  407. data/spec/api/subscriptions_api_spec.rb +73 -0
  408. data/spec/api/ticket_api_spec.rb +86 -0
  409. data/spec/api/user_profile_themes_api_spec.rb +91 -0
  410. data/spec/api/webhook_api_spec.rb +54 -0
  411. data/spec/api/webhook_endpoint_api_spec.rb +136 -0
  412. data/spec/models/add_collection_products_dto_spec.rb +36 -0
  413. data/spec/models/addon_create_spec.rb +60 -0
  414. data/spec/models/addon_spec.rb +60 -0
  415. data/spec/models/addon_update_spec.rb +54 -0
  416. data/spec/models/api_key_response_dto_spec.rb +84 -0
  417. data/spec/models/app_portal_url_response_dto_spec.rb +36 -0
  418. data/spec/models/brand_create_spec.rb +66 -0
  419. data/spec/models/brand_spec.rb +102 -0
  420. data/spec/models/brand_update_spec.rb +66 -0
  421. data/spec/models/business_create_spec.rb +36 -0
  422. data/spec/models/business_full_create_response_spec.rb +42 -0
  423. data/spec/models/business_full_create_spec.rb +60 -0
  424. data/spec/models/business_spec.rb +150 -0
  425. data/spec/models/checkout_link_message_response_dto_spec.rb +36 -0
  426. data/spec/models/checkout_link_response_dto_spec.rb +132 -0
  427. data/spec/models/checkout_response_dto_spec.rb +48 -0
  428. data/spec/models/checkout_session_details_dto_spec.rb +96 -0
  429. data/spec/models/collection_archived_response_dto_spec.rb +36 -0
  430. data/spec/models/collection_detail_response_dto_spec.rb +94 -0
  431. data/spec/models/collection_product_deleted_response_dto_spec.rb +36 -0
  432. data/spec/models/collection_product_dto_spec.rb +236 -0
  433. data/spec/models/collection_product_entry_spec.rb +42 -0
  434. data/spec/models/collection_product_ref_dto_spec.rb +42 -0
  435. data/spec/models/collection_product_updated_response_dto_spec.rb +36 -0
  436. data/spec/models/collection_response_dto_spec.rb +94 -0
  437. data/spec/models/collection_unarchived_response_dto_spec.rb +36 -0
  438. data/spec/models/collection_updated_response_dto_spec.rb +36 -0
  439. data/spec/models/create_api_key_dto_spec.rb +42 -0
  440. data/spec/models/create_checkout_dto_spec.rb +90 -0
  441. data/spec/models/create_checkout_link_dto_spec.rb +114 -0
  442. data/spec/models/create_collection_checkout_dto_spec.rb +60 -0
  443. data/spec/models/create_collection_dto_spec.rb +64 -0
  444. data/spec/models/create_customer_dto_spec.rb +60 -0
  445. data/spec/models/create_meter_dto_spec.rb +82 -0
  446. data/spec/models/create_setup_checkout_dto_spec.rb +60 -0
  447. data/spec/models/create_webhook_endpoint_dto_spec.rb +48 -0
  448. data/spec/models/customer_list_response_dto_spec.rb +42 -0
  449. data/spec/models/customer_message_response_dto_spec.rb +36 -0
  450. data/spec/models/customer_response_dto_spec.rb +96 -0
  451. data/spec/models/customer_shared_invite_response_dto_spec.rb +48 -0
  452. data/spec/models/dashboard_stats_dto_spec.rb +54 -0
  453. data/spec/models/discount_create_spec.rb +94 -0
  454. data/spec/models/discount_spec.rb +116 -0
  455. data/spec/models/discount_update_spec.rb +88 -0
  456. data/spec/models/discounts_list200_response_pagination_spec.rb +48 -0
  457. data/spec/models/discounts_list200_response_spec.rb +54 -0
  458. data/spec/models/dispute_attachment_dto_spec.rb +36 -0
  459. data/spec/models/dispute_evidence_dto_spec.rb +54 -0
  460. data/spec/models/dispute_evidence_update_spec.rb +54 -0
  461. data/spec/models/dispute_file_upload_spec.rb +54 -0
  462. data/spec/models/dispute_list_meta_dto_spec.rb +54 -0
  463. data/spec/models/dispute_list_spec.rb +42 -0
  464. data/spec/models/dispute_spec.rb +156 -0
  465. data/spec/models/instance_spec.rb +72 -0
  466. data/spec/models/invoice_spec.rb +60 -0
  467. data/spec/models/license_spec.rb +130 -0
  468. data/spec/models/license_sub_dto_spec.rb +72 -0
  469. data/spec/models/license_validation_response_spec.rb +48 -0
  470. data/spec/models/licenses_activate_request_spec.rb +48 -0
  471. data/spec/models/licenses_create_request_spec.rb +60 -0
  472. data/spec/models/licenses_deactivate200_response_spec.rb +36 -0
  473. data/spec/models/licenses_deactivate_request_spec.rb +36 -0
  474. data/spec/models/licenses_update_instance_post_request_spec.rb +42 -0
  475. data/spec/models/licenses_update_request_spec.rb +52 -0
  476. data/spec/models/licenses_verify_request_spec.rb +42 -0
  477. data/spec/models/meter_detail_response_dto_spec.rb +118 -0
  478. data/spec/models/meter_events_response_dto_spec.rb +48 -0
  479. data/spec/models/meter_ingest_event_dto_spec.rb +66 -0
  480. data/spec/models/meter_ingest_request_dto_spec.rb +36 -0
  481. data/spec/models/meter_ingest_response_dto_spec.rb +48 -0
  482. data/spec/models/meter_quantities_cost_dto_spec.rb +60 -0
  483. data/spec/models/meter_quantities_response_dto_spec.rb +54 -0
  484. data/spec/models/meter_response_dto_spec.rb +106 -0
  485. data/spec/models/meter_usage_event_dto_spec.rb +72 -0
  486. data/spec/models/operational_webhook_endpoint_headers_in_dto_spec.rb +36 -0
  487. data/spec/models/operational_webhook_endpoint_headers_response_dto_spec.rb +42 -0
  488. data/spec/models/operational_webhook_endpoint_in_dto_spec.rb +78 -0
  489. data/spec/models/operational_webhook_endpoint_list_response_dto_spec.rb +54 -0
  490. data/spec/models/operational_webhook_endpoint_response_dto_spec.rb +96 -0
  491. data/spec/models/operational_webhook_endpoint_secret_in_dto_spec.rb +36 -0
  492. data/spec/models/operational_webhook_endpoint_secret_response_dto_spec.rb +36 -0
  493. data/spec/models/operational_webhook_endpoint_update_dto_spec.rb +72 -0
  494. data/spec/models/order_billing_spec.rb +60 -0
  495. data/spec/models/order_billing_update_spec.rb +60 -0
  496. data/spec/models/order_customer_spec.rb +54 -0
  497. data/spec/models/order_detail_spec.rb +48 -0
  498. data/spec/models/order_list_spec.rb +42 -0
  499. data/spec/models/order_product_cart_spec.rb +60 -0
  500. data/spec/models/order_refund_create_spec.rb +60 -0
  501. data/spec/models/order_refund_spec.rb +78 -0
  502. data/spec/models/order_spec.rb +180 -0
  503. data/spec/models/order_update_spec.rb +36 -0
  504. data/spec/models/payout_access_token_spec.rb +42 -0
  505. data/spec/models/payout_account_link_spec.rb +42 -0
  506. data/spec/models/payout_account_spec.rb +48 -0
  507. data/spec/models/payout_method_list_spec.rb +36 -0
  508. data/spec/models/payout_method_spec.rb +54 -0
  509. data/spec/models/payout_verification_list_spec.rb +36 -0
  510. data/spec/models/payout_verification_spec.rb +54 -0
  511. data/spec/models/price_preview_response_dto_spec.rb +54 -0
  512. data/spec/models/product_create_addons_inner_spec.rb +60 -0
  513. data/spec/models/product_create_custom_fields_inner_spec.rb +54 -0
  514. data/spec/models/product_create_spec.rb +170 -0
  515. data/spec/models/product_message_response_dto_spec.rb +36 -0
  516. data/spec/models/product_spec.rb +230 -0
  517. data/spec/models/product_sub_dto_spec.rb +48 -0
  518. data/spec/models/product_update_spec.rb +170 -0
  519. data/spec/models/products_archive200_response_spec.rb +36 -0
  520. data/spec/models/products_list200_response_pagination_spec.rb +42 -0
  521. data/spec/models/products_list200_response_spec.rb +42 -0
  522. data/spec/models/products_unarchive200_response_spec.rb +36 -0
  523. data/spec/models/refund_spec.rb +112 -0
  524. data/spec/models/resolved_addon_spec.rb +54 -0
  525. data/spec/models/revoke_seat_dto_spec.rb +42 -0
  526. data/spec/models/subscription_action_spec.rb +80 -0
  527. data/spec/models/subscription_company_dto_spec.rb +42 -0
  528. data/spec/models/subscription_detail_product_spec.rb +66 -0
  529. data/spec/models/subscription_detail_spec.rb +54 -0
  530. data/spec/models/subscription_list_spec.rb +42 -0
  531. data/spec/models/subscription_member_dto_spec.rb +36 -0
  532. data/spec/models/subscription_plan_dto_spec.rb +42 -0
  533. data/spec/models/subscription_product_dto_spec.rb +48 -0
  534. data/spec/models/subscription_seat_adjustment_spec.rb +84 -0
  535. data/spec/models/subscription_spec.rb +186 -0
  536. data/spec/models/subscription_user_dto_spec.rb +54 -0
  537. data/spec/models/subscriptions_action201_response_spec.rb +32 -0
  538. data/spec/models/supported_currencies_response_dto_spec.rb +42 -0
  539. data/spec/models/update_checkout_link_dto_spec.rb +114 -0
  540. data/spec/models/update_collection_dto_spec.rb +48 -0
  541. data/spec/models/update_collection_product_dto_spec.rb +36 -0
  542. data/spec/models/update_customer_dto_spec.rb +54 -0
  543. data/spec/models/update_instance_dto_spec.rb +42 -0
  544. data/spec/models/update_meter_dto_spec.rb +82 -0
  545. data/spec/models/update_webhook_endpoint_dto_spec.rb +58 -0
  546. data/spec/models/user_page_spec.rb +60 -0
  547. data/spec/models/user_settings_spec.rb +84 -0
  548. data/spec/models/user_settings_update_spec.rb +210 -0
  549. data/spec/models/user_stats_spec.rb +42 -0
  550. data/spec/models/user_theme_spec.rb +60 -0
  551. data/spec/models/user_theme_update_spec.rb +48 -0
  552. data/spec/models/webhook_delivery_response_dto_spec.rb +84 -0
  553. data/spec/models/webhook_dispute_payload_spec.rb +108 -0
  554. data/spec/models/webhook_endpoint_response_dto_spec.rb +84 -0
  555. data/spec/models/webhook_license_payload_spec.rb +130 -0
  556. data/spec/models/webhook_payment_payload_billing_address_spec.rb +72 -0
  557. data/spec/models/webhook_payment_payload_spec.rb +330 -0
  558. data/spec/models/webhook_refund_payload_spec.rb +96 -0
  559. data/spec/models/webhook_subscription_payload_spec.rb +114 -0
  560. data/spec/models/whop_api_keys_rotation_spec.rb +36 -0
  561. data/spec/models/withdrawal_create_spec.rb +48 -0
  562. data/spec/models/withdrawal_list_spec.rb +42 -0
  563. data/spec/models/withdrawal_spec.rb +120 -0
  564. data/spec/spec_helper.rb +111 -0
  565. metadata +831 -0
@@ -0,0 +1,34 @@
1
+ # Solifyn::ApiKeyResponseDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **name** | **String** | | |
9
+ | **prefix** | **String** | | |
10
+ | **status** | **String** | | |
11
+ | **allow_write** | **Boolean** | | |
12
+ | **api_key** | **String** | The raw API key. Only returned once during creation. | [optional] |
13
+ | **expires_at** | **Time** | | |
14
+ | **last_used_at** | **Object** | | [optional] |
15
+ | **created_at** | **Time** | | |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'solifyn'
21
+
22
+ instance = Solifyn::ApiKeyResponseDto.new(
23
+ id: key_019e56a1...,
24
+ name: Production Key,
25
+ prefix: fyn,
26
+ status: ACTIVE,
27
+ allow_write: true,
28
+ api_key: fyn_key_123456...,
29
+ expires_at: 2036-05-30T14:11:29.071Z,
30
+ last_used_at: 2026-05-30T14:11:29.071Z,
31
+ created_at: 2026-05-30T14:11:29.071Z
32
+ )
33
+ ```
34
+
@@ -0,0 +1,18 @@
1
+ # Solifyn::AppPortalUrlResponseDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'solifyn'
13
+
14
+ instance = Solifyn::AppPortalUrlResponseDto.new(
15
+ url: https://app.svix.com/login#key=...
16
+ )
17
+ ```
18
+
@@ -0,0 +1,184 @@
1
+ # Solifyn::BalanceApi
2
+
3
+ All URIs are relative to *http://localhost:8000*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**balance_controller_find_all**](BalanceApi.md#balance_controller_find_all) | **GET** /v1/balances | |
8
+ | [**balance_controller_generate_report**](BalanceApi.md#balance_controller_generate_report) | **GET** /v1/balances/report | |
9
+ | [**balance_controller_get_summary**](BalanceApi.md#balance_controller_get_summary) | **GET** /v1/balances/summary | |
10
+
11
+
12
+ ## balance_controller_find_all
13
+
14
+ > balance_controller_find_all
15
+
16
+
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'solifyn'
23
+
24
+ api_instance = Solifyn::BalanceApi.new
25
+
26
+ begin
27
+
28
+ api_instance.balance_controller_find_all
29
+ rescue Solifyn::ApiError => e
30
+ puts "Error when calling BalanceApi->balance_controller_find_all: #{e}"
31
+ end
32
+ ```
33
+
34
+ #### Using the balance_controller_find_all_with_http_info variant
35
+
36
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
37
+
38
+ > <Array(nil, Integer, Hash)> balance_controller_find_all_with_http_info
39
+
40
+ ```ruby
41
+ begin
42
+
43
+ data, status_code, headers = api_instance.balance_controller_find_all_with_http_info
44
+ p status_code # => 2xx
45
+ p headers # => { ... }
46
+ p data # => nil
47
+ rescue Solifyn::ApiError => e
48
+ puts "Error when calling BalanceApi->balance_controller_find_all_with_http_info: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ This endpoint does not need any parameter.
55
+
56
+ ### Return type
57
+
58
+ nil (empty response body)
59
+
60
+ ### Authorization
61
+
62
+ No authorization required
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: Not defined
67
+ - **Accept**: Not defined
68
+
69
+
70
+ ## balance_controller_generate_report
71
+
72
+ > balance_controller_generate_report
73
+
74
+
75
+
76
+ ### Examples
77
+
78
+ ```ruby
79
+ require 'time'
80
+ require 'solifyn'
81
+
82
+ api_instance = Solifyn::BalanceApi.new
83
+
84
+ begin
85
+
86
+ api_instance.balance_controller_generate_report
87
+ rescue Solifyn::ApiError => e
88
+ puts "Error when calling BalanceApi->balance_controller_generate_report: #{e}"
89
+ end
90
+ ```
91
+
92
+ #### Using the balance_controller_generate_report_with_http_info variant
93
+
94
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
95
+
96
+ > <Array(nil, Integer, Hash)> balance_controller_generate_report_with_http_info
97
+
98
+ ```ruby
99
+ begin
100
+
101
+ data, status_code, headers = api_instance.balance_controller_generate_report_with_http_info
102
+ p status_code # => 2xx
103
+ p headers # => { ... }
104
+ p data # => nil
105
+ rescue Solifyn::ApiError => e
106
+ puts "Error when calling BalanceApi->balance_controller_generate_report_with_http_info: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ This endpoint does not need any parameter.
113
+
114
+ ### Return type
115
+
116
+ nil (empty response body)
117
+
118
+ ### Authorization
119
+
120
+ No authorization required
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: Not defined
125
+ - **Accept**: Not defined
126
+
127
+
128
+ ## balance_controller_get_summary
129
+
130
+ > balance_controller_get_summary
131
+
132
+
133
+
134
+ ### Examples
135
+
136
+ ```ruby
137
+ require 'time'
138
+ require 'solifyn'
139
+
140
+ api_instance = Solifyn::BalanceApi.new
141
+
142
+ begin
143
+
144
+ api_instance.balance_controller_get_summary
145
+ rescue Solifyn::ApiError => e
146
+ puts "Error when calling BalanceApi->balance_controller_get_summary: #{e}"
147
+ end
148
+ ```
149
+
150
+ #### Using the balance_controller_get_summary_with_http_info variant
151
+
152
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
153
+
154
+ > <Array(nil, Integer, Hash)> balance_controller_get_summary_with_http_info
155
+
156
+ ```ruby
157
+ begin
158
+
159
+ data, status_code, headers = api_instance.balance_controller_get_summary_with_http_info
160
+ p status_code # => 2xx
161
+ p headers # => { ... }
162
+ p data # => nil
163
+ rescue Solifyn::ApiError => e
164
+ puts "Error when calling BalanceApi->balance_controller_get_summary_with_http_info: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+ This endpoint does not need any parameter.
171
+
172
+ ### Return type
173
+
174
+ nil (empty response body)
175
+
176
+ ### Authorization
177
+
178
+ No authorization required
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: Not defined
183
+ - **Accept**: Not defined
184
+
@@ -0,0 +1,68 @@
1
+ # Solifyn::BillingApi
2
+
3
+ All URIs are relative to *http://localhost:8000*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**billing_get_plans**](BillingApi.md#billing_get_plans) | **GET** /v1/billing/plans | Get Platform Plans |
8
+
9
+
10
+ ## billing_get_plans
11
+
12
+ > billing_get_plans
13
+
14
+ Get Platform Plans
15
+
16
+ Returns all available platform subscription plans with fees and features.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'solifyn'
23
+
24
+ api_instance = Solifyn::BillingApi.new
25
+
26
+ begin
27
+ # Get Platform Plans
28
+ api_instance.billing_get_plans
29
+ rescue Solifyn::ApiError => e
30
+ puts "Error when calling BillingApi->billing_get_plans: #{e}"
31
+ end
32
+ ```
33
+
34
+ #### Using the billing_get_plans_with_http_info variant
35
+
36
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
37
+
38
+ > <Array(nil, Integer, Hash)> billing_get_plans_with_http_info
39
+
40
+ ```ruby
41
+ begin
42
+ # Get Platform Plans
43
+ data, status_code, headers = api_instance.billing_get_plans_with_http_info
44
+ p status_code # => 2xx
45
+ p headers # => { ... }
46
+ p data # => nil
47
+ rescue Solifyn::ApiError => e
48
+ puts "Error when calling BillingApi->billing_get_plans_with_http_info: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ This endpoint does not need any parameter.
55
+
56
+ ### Return type
57
+
58
+ nil (empty response body)
59
+
60
+ ### Authorization
61
+
62
+ No authorization required
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: Not defined
67
+ - **Accept**: Not defined
68
+
data/docs/Brand.md ADDED
@@ -0,0 +1,40 @@
1
+ # Solifyn::Brand
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique brand ID | |
8
+ | **name** | **String** | The brand name | |
9
+ | **website_url** | **String** | The website URL associated with the brand | [optional] |
10
+ | **support_email** | **String** | Support email address for customer service | [optional] |
11
+ | **description** | **String** | Short description of the brand | [optional] |
12
+ | **logo_url** | **String** | Brand logo image URL | [optional] |
13
+ | **is_primary** | **Boolean** | Whether this is the primary brand for the merchant business | |
14
+ | **statement_descriptor** | **String** | Credit card statement descriptor | [optional] |
15
+ | **merchant_id** | **String** | The merchant ID owning the brand | |
16
+ | **business_id** | **String** | The business ID linked to the brand | [optional] |
17
+ | **created_at** | **Time** | Timestamp when the brand was created | |
18
+ | **updated_at** | **Time** | Timestamp when the brand was last updated | |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'solifyn'
24
+
25
+ instance = Solifyn::Brand.new(
26
+ id: brd_123,
27
+ name: Acme Corp,
28
+ website_url: https://acme.com,
29
+ support_email: support@acme.com,
30
+ description: A leading provider of ACME tools.,
31
+ logo_url: https://acme.com/logo.png,
32
+ is_primary: true,
33
+ statement_descriptor: ACME CORP INC,
34
+ merchant_id: mer_123,
35
+ business_id: biz_123,
36
+ created_at: 2025-01-01T12:00:00Z,
37
+ updated_at: 2025-01-01T12:00:00Z
38
+ )
39
+ ```
40
+
@@ -0,0 +1,28 @@
1
+ # Solifyn::BrandCreate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the brand | |
8
+ | **website_url** | **String** | The website URL associated with the brand | [optional] |
9
+ | **support_email** | **String** | Support email address for customer service | [optional] |
10
+ | **description** | **String** | Short description of the brand | [optional] |
11
+ | **logo_url** | **String** | Brand logo image URL | [optional] |
12
+ | **statement_descriptor** | **String** | Credit card statement descriptor (Max 22 chars) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'solifyn'
18
+
19
+ instance = Solifyn::BrandCreate.new(
20
+ name: Acme Corp,
21
+ website_url: https://acme.com,
22
+ support_email: support@acme.com,
23
+ description: A leading provider of ACME tools.,
24
+ logo_url: https://acme.com/logo.png,
25
+ statement_descriptor: ACME CORP INC
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # Solifyn::BrandUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the brand | [optional] |
8
+ | **website_url** | **String** | The website URL associated with the brand | [optional] |
9
+ | **support_email** | **String** | Support email address for customer service | [optional] |
10
+ | **description** | **String** | Short description of the brand | [optional] |
11
+ | **logo_url** | **String** | Brand logo image URL | [optional] |
12
+ | **statement_descriptor** | **String** | Credit card statement descriptor (Max 22 chars) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'solifyn'
18
+
19
+ instance = Solifyn::BrandUpdate.new(
20
+ name: Acme Corp,
21
+ website_url: https://acme.com,
22
+ support_email: support@acme.com,
23
+ description: A leading provider of ACME tools.,
24
+ logo_url: https://acme.com/logo.png,
25
+ statement_descriptor: ACME CORP INC
26
+ )
27
+ ```
28
+
data/docs/BrandsApi.md ADDED
@@ -0,0 +1,286 @@
1
+ # Solifyn::BrandsApi
2
+
3
+ All URIs are relative to *http://localhost:8000*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**brands_create**](BrandsApi.md#brands_create) | **POST** /v1/user/brand | Create Brand |
8
+ | [**brands_get**](BrandsApi.md#brands_get) | **GET** /v1/user/brand/{id} | Retrieve Brand |
9
+ | [**brands_list**](BrandsApi.md#brands_list) | **GET** /v1/user/brands | List Brands |
10
+ | [**brands_update**](BrandsApi.md#brands_update) | **PATCH** /v1/user/brand/{id} | Update Brand |
11
+
12
+
13
+ ## brands_create
14
+
15
+ > <Brand> brands_create(brand_create)
16
+
17
+ Create Brand
18
+
19
+ Add a new brand identity under the current active business.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'solifyn'
26
+ # setup authorization
27
+ Solifyn.configure do |config|
28
+ # Configure Bearer authorization (API Key): ApiKeyAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+ end
31
+
32
+ api_instance = Solifyn::BrandsApi.new
33
+ brand_create = Solifyn::BrandCreate.new({name: 'Acme Corp'}) # BrandCreate |
34
+
35
+ begin
36
+ # Create Brand
37
+ result = api_instance.brands_create(brand_create)
38
+ p result
39
+ rescue Solifyn::ApiError => e
40
+ puts "Error when calling BrandsApi->brands_create: #{e}"
41
+ end
42
+ ```
43
+
44
+ #### Using the brands_create_with_http_info variant
45
+
46
+ This returns an Array which contains the response data, status code and headers.
47
+
48
+ > <Array(<Brand>, Integer, Hash)> brands_create_with_http_info(brand_create)
49
+
50
+ ```ruby
51
+ begin
52
+ # Create Brand
53
+ data, status_code, headers = api_instance.brands_create_with_http_info(brand_create)
54
+ p status_code # => 2xx
55
+ p headers # => { ... }
56
+ p data # => <Brand>
57
+ rescue Solifyn::ApiError => e
58
+ puts "Error when calling BrandsApi->brands_create_with_http_info: #{e}"
59
+ end
60
+ ```
61
+
62
+ ### Parameters
63
+
64
+ | Name | Type | Description | Notes |
65
+ | ---- | ---- | ----------- | ----- |
66
+ | **brand_create** | [**BrandCreate**](BrandCreate.md) | | |
67
+
68
+ ### Return type
69
+
70
+ [**Brand**](Brand.md)
71
+
72
+ ### Authorization
73
+
74
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
80
+
81
+
82
+ ## brands_get
83
+
84
+ > <Brand> brands_get(id)
85
+
86
+ Retrieve Brand
87
+
88
+ Retrieve details of a brand identity by ID.
89
+
90
+ ### Examples
91
+
92
+ ```ruby
93
+ require 'time'
94
+ require 'solifyn'
95
+ # setup authorization
96
+ Solifyn.configure do |config|
97
+ # Configure Bearer authorization (API Key): ApiKeyAuth
98
+ config.access_token = 'YOUR_BEARER_TOKEN'
99
+ end
100
+
101
+ api_instance = Solifyn::BrandsApi.new
102
+ id = 'brd_123' # String | The brand ID to retrieve
103
+
104
+ begin
105
+ # Retrieve Brand
106
+ result = api_instance.brands_get(id)
107
+ p result
108
+ rescue Solifyn::ApiError => e
109
+ puts "Error when calling BrandsApi->brands_get: #{e}"
110
+ end
111
+ ```
112
+
113
+ #### Using the brands_get_with_http_info variant
114
+
115
+ This returns an Array which contains the response data, status code and headers.
116
+
117
+ > <Array(<Brand>, Integer, Hash)> brands_get_with_http_info(id)
118
+
119
+ ```ruby
120
+ begin
121
+ # Retrieve Brand
122
+ data, status_code, headers = api_instance.brands_get_with_http_info(id)
123
+ p status_code # => 2xx
124
+ p headers # => { ... }
125
+ p data # => <Brand>
126
+ rescue Solifyn::ApiError => e
127
+ puts "Error when calling BrandsApi->brands_get_with_http_info: #{e}"
128
+ end
129
+ ```
130
+
131
+ ### Parameters
132
+
133
+ | Name | Type | Description | Notes |
134
+ | ---- | ---- | ----------- | ----- |
135
+ | **id** | **String** | The brand ID to retrieve | |
136
+
137
+ ### Return type
138
+
139
+ [**Brand**](Brand.md)
140
+
141
+ ### Authorization
142
+
143
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
144
+
145
+ ### HTTP request headers
146
+
147
+ - **Content-Type**: Not defined
148
+ - **Accept**: application/json
149
+
150
+
151
+ ## brands_list
152
+
153
+ > <Array<Brand>> brands_list
154
+
155
+ List Brands
156
+
157
+ Retrieve all brands associated with the current business context.
158
+
159
+ ### Examples
160
+
161
+ ```ruby
162
+ require 'time'
163
+ require 'solifyn'
164
+ # setup authorization
165
+ Solifyn.configure do |config|
166
+ # Configure Bearer authorization (API Key): ApiKeyAuth
167
+ config.access_token = 'YOUR_BEARER_TOKEN'
168
+ end
169
+
170
+ api_instance = Solifyn::BrandsApi.new
171
+
172
+ begin
173
+ # List Brands
174
+ result = api_instance.brands_list
175
+ p result
176
+ rescue Solifyn::ApiError => e
177
+ puts "Error when calling BrandsApi->brands_list: #{e}"
178
+ end
179
+ ```
180
+
181
+ #### Using the brands_list_with_http_info variant
182
+
183
+ This returns an Array which contains the response data, status code and headers.
184
+
185
+ > <Array(<Array<Brand>>, Integer, Hash)> brands_list_with_http_info
186
+
187
+ ```ruby
188
+ begin
189
+ # List Brands
190
+ data, status_code, headers = api_instance.brands_list_with_http_info
191
+ p status_code # => 2xx
192
+ p headers # => { ... }
193
+ p data # => <Array<Brand>>
194
+ rescue Solifyn::ApiError => e
195
+ puts "Error when calling BrandsApi->brands_list_with_http_info: #{e}"
196
+ end
197
+ ```
198
+
199
+ ### Parameters
200
+
201
+ This endpoint does not need any parameter.
202
+
203
+ ### Return type
204
+
205
+ [**Array&lt;Brand&gt;**](Brand.md)
206
+
207
+ ### Authorization
208
+
209
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
210
+
211
+ ### HTTP request headers
212
+
213
+ - **Content-Type**: Not defined
214
+ - **Accept**: application/json
215
+
216
+
217
+ ## brands_update
218
+
219
+ > <Brand> brands_update(id, brand_update)
220
+
221
+ Update Brand
222
+
223
+ Update website, logo, description, or statement descriptors of a brand.
224
+
225
+ ### Examples
226
+
227
+ ```ruby
228
+ require 'time'
229
+ require 'solifyn'
230
+ # setup authorization
231
+ Solifyn.configure do |config|
232
+ # Configure Bearer authorization (API Key): ApiKeyAuth
233
+ config.access_token = 'YOUR_BEARER_TOKEN'
234
+ end
235
+
236
+ api_instance = Solifyn::BrandsApi.new
237
+ id = 'brd_123' # String | The brand ID to update
238
+ brand_update = Solifyn::BrandUpdate.new # BrandUpdate |
239
+
240
+ begin
241
+ # Update Brand
242
+ result = api_instance.brands_update(id, brand_update)
243
+ p result
244
+ rescue Solifyn::ApiError => e
245
+ puts "Error when calling BrandsApi->brands_update: #{e}"
246
+ end
247
+ ```
248
+
249
+ #### Using the brands_update_with_http_info variant
250
+
251
+ This returns an Array which contains the response data, status code and headers.
252
+
253
+ > <Array(<Brand>, Integer, Hash)> brands_update_with_http_info(id, brand_update)
254
+
255
+ ```ruby
256
+ begin
257
+ # Update Brand
258
+ data, status_code, headers = api_instance.brands_update_with_http_info(id, brand_update)
259
+ p status_code # => 2xx
260
+ p headers # => { ... }
261
+ p data # => <Brand>
262
+ rescue Solifyn::ApiError => e
263
+ puts "Error when calling BrandsApi->brands_update_with_http_info: #{e}"
264
+ end
265
+ ```
266
+
267
+ ### Parameters
268
+
269
+ | Name | Type | Description | Notes |
270
+ | ---- | ---- | ----------- | ----- |
271
+ | **id** | **String** | The brand ID to update | |
272
+ | **brand_update** | [**BrandUpdate**](BrandUpdate.md) | | |
273
+
274
+ ### Return type
275
+
276
+ [**Brand**](Brand.md)
277
+
278
+ ### Authorization
279
+
280
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: application/json
285
+ - **Accept**: application/json
286
+