From 1dec59da76b64fd5297f0cc28417c0e23df06a8d Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 13 Nov 2024 14:22:30 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.438.1 --- .speakeasy/gen.lock | 138 +++++--- .speakeasy/gen.yaml | 3 +- .speakeasy/workflow.lock | 15 +- .speakeasy/workflow.yaml | 2 + README.md | 32 +- RELEASES.md | 12 +- codeSamples.yaml | 6 + docs/models/components/address.md | 2 +- .../components/advertisementcampaign.md | 10 +- .../advertisementcampaignlistresource.md | 16 +- .../components/advertisementsortproperty.md | 2 +- docs/models/components/article.md | 27 +- docs/models/components/articlepreview.md | 2 +- docs/models/components/articlereceivers.md | 6 +- docs/models/components/assignee.md | 8 +- docs/models/components/attachedcustomfield.md | 6 +- docs/models/components/author.md | 8 +- ...nationuser.md => authorizeorganization.md} | 12 +- .../authorizeresponseorganization.md | 45 +++ .../authorizeresponseorganizationsubtype.md | 15 + .../components/authorizeresponseuser.md | 37 ++ .../authorizeresponseusersubtype.md | 15 + docs/models/components/authorizeuser.md | 21 ++ docs/models/components/benefit.md | 53 ++- docs/models/components/benefitads.md | 6 +- docs/models/components/benefitadscreate.md | 2 +- .../models/components/benefitadssubscriber.md | 26 +- .../components/benefitarticlessubscriber.md | 25 +- docs/models/components/benefitcustom.md | 6 +- docs/models/components/benefitcustomcreate.md | 2 +- .../components/benefitcustomsubscriber.md | 25 +- docs/models/components/benefitdiscord.md | 6 +- .../models/components/benefitdiscordcreate.md | 3 +- docs/models/components/benefitdiscordinput.md | 40 --- .../benefitdiscordpropertiesinput.md | 21 -- .../components/benefitdiscordsubscriber.md | 25 +- .../models/components/benefitdownloadables.md | 6 +- .../components/benefitdownloadablescreate.md | 2 +- .../benefitdownloadablessubscriber.md | 25 +- .../components/benefitgithubrepository.md | 6 +- .../benefitgithubrepositorycreate.md | 5 +- ...hubrepositorycreatepropertiespermission.md | 2 +- .../benefitgithubrepositoryproperties.md | 2 +- .../benefitgithubrepositorysubscriber.md | 25 +- docs/models/components/benefitgrant.md | 8 +- docs/models/components/benefitgrantads.md | 4 +- ...antgithubrepositorypropertiespermission.md | 2 +- .../components/benefitgrantlicensekeys.md | 4 +- .../components/benefitgrantsubscriber.md | 4 +- docs/models/components/benefitgrantwebhook.md | 18 +- docs/models/components/benefitinput.md | 143 -------- .../benefitlicensekeyactivationproperties.md | 2 +- .../benefitlicensekeyexpirationproperties.md | 4 +- docs/models/components/benefitlicensekeys.md | 15 +- .../components/benefitlicensekeyscreate.md | 2 +- .../benefitlicensekeysproperties.md | 8 +- .../benefitlicensekeyssubscriber.md | 33 +- .../benefitlicensekeyssubscriberproperties.md | 8 +- docs/models/components/benefits.md | 15 +- docs/models/components/benefittype.md | 2 +- docs/models/components/bylineprofile.md | 2 +- docs/models/components/checkoutlink.md | 43 +-- docs/models/components/checkoutlinkcreate.md | 12 +- .../components/checkoutlinkcreatemetadata.md | 23 ++ .../models/components/checkoutlinkmetadata.md | 23 ++ .../components/checkoutlinksortproperty.md | 2 +- docs/models/components/checkoutlinkupdate.md | 8 +- .../components/checkoutlinkupdatemetadata.md | 23 ++ docs/models/components/checkoutproduct.md | 36 +- .../components/checkoutproductbenefits.md | 15 +- .../models/components/checkoutproductinput.md | 77 ----- docs/models/components/checkoutpublic.md | 96 +++--- .../models/components/checkoutsortproperty.md | 2 +- docs/models/components/checkoutstatus.md | 2 +- docs/models/components/checkoutupdate.md | 26 +- .../components/checkoutupdatemetadata.md | 23 ++ docs/models/components/currencyamount.md | 4 +- docs/models/components/customfield.md | 26 +- docs/models/components/customfieldcheckbox.md | 28 +- .../components/customfieldcheckboxmetadata.md | 23 ++ .../components/customfieldcreatecheckbox.md | 16 +- .../customfieldcreatecheckboxmetadata.md | 23 ++ .../components/customfieldcreatedate.md | 16 +- .../customfieldcreatedatemetadata.md | 23 ++ .../components/customfieldcreatenumber.md | 16 +- .../customfieldcreatenumbermetadata.md | 23 ++ .../components/customfieldcreateselect.md | 16 +- .../customfieldcreateselectmetadata.md | 23 ++ .../components/customfieldcreatetext.md | 16 +- .../customfieldcreatetextmetadata.md | 23 ++ docs/models/components/customfielddate.md | 28 +- .../components/customfielddatemetadata.md | 23 ++ docs/models/components/customfieldnumber.md | 28 +- .../components/customfieldnumbermetadata.md | 23 ++ docs/models/components/customfieldselect.md | 28 +- .../components/customfieldselectmetadata.md | 23 ++ docs/models/components/customfieldtext.md | 28 +- .../components/customfieldtextmetadata.md | 23 ++ .../components/customfieldupdatecheckbox.md | 14 +- .../customfieldupdatecheckboxmetadata.md | 23 ++ .../components/customfieldupdatedate.md | 14 +- .../customfieldupdatedatemetadata.md | 23 ++ .../components/customfieldupdatenumber.md | 14 +- .../customfieldupdatenumbermetadata.md | 23 ++ .../components/customfieldupdateselect.md | 14 +- .../customfieldupdateselectmetadata.md | 23 ++ .../components/customfieldupdatetext.md | 14 +- .../customfieldupdatetextmetadata.md | 23 ++ .../models/components/donationorganization.md | 24 -- docs/models/components/donor.md | 26 -- .../components/downloadablefilecreate.md | 8 +- .../models/components/downloadablefileread.md | 8 +- docs/models/components/fileread.md | 28 +- docs/models/components/fileupload.md | 20 +- docs/models/components/fileuploadcompleted.md | 4 +- .../components/introspecttokenresponse.md | 6 +- docs/models/components/issue.md | 36 +- docs/models/components/label.md | 2 +- docs/models/components/listresource.md | 10 +- docs/models/components/listresourcearticle.md | 31 +- docs/models/components/listresourcebenefit.md | 17 +- .../components/listresourcebenefitgrant.md | 8 +- .../models/components/listresourcecheckout.md | 74 ++-- .../components/listresourcecheckoutlink.md | 20 +- .../models/components/listresourcefileread.md | 14 +- .../components/listresourceoauth2client.md | 14 +- docs/models/components/listresourceorder.md | 55 ++- .../components/listresourceorganization.md | 1 - docs/models/components/listresourceproduct.md | 51 +-- .../components/listresourcerepository.md | 1 - .../components/listresourcesubscription.md | 79 +++-- .../components/listresourceuserbenefit.md | 33 +- .../components/listresourceuserorder.md | 82 ++--- .../listresourceusersubscription.md | 1 - docs/models/components/loc.md | 2 +- docs/models/components/metadata.md | 23 ++ docs/models/components/metric.md | 4 +- docs/models/components/metricperiod.md | 24 +- docs/models/components/metrics.md | 28 +- .../models/components/metricsintervallimit.md | 2 +- .../components/metricsintervalslimits.md | 10 +- docs/models/components/metricslimits.md | 12 +- docs/models/components/metricsresponse.md | 52 +-- docs/models/components/metrictype.md | 2 +- docs/models/components/oauth2client.md | 10 +- .../components/oauth2clientconfiguration.md | 2 +- .../oauth2clientconfigurationgranttypes.md | 2 +- ...entconfigurationtokenendpointauthmethod.md | 3 +- .../oauth2clientconfigurationupdate.md | 2 +- ...figurationupdatetokenendpointauthmethod.md | 3 +- .../{donation.md => oauth2clientpublic.md} | 94 +---- ...componentsauthorizationcodetokenrequest.md | 2 +- docs/models/components/order.md | 50 +-- docs/models/components/orderbillingreason.md | 2 +- docs/models/components/orderinvoice.md | 2 +- docs/models/components/ordermetadata.md | 23 ++ docs/models/components/orderproduct.md | 6 +- docs/models/components/ordersortproperty.md | 2 +- docs/models/components/ordersubscription.md | 20 +- .../components/ordersubscriptionmetadata.md | 23 ++ docs/models/components/orderuser.md | 4 +- docs/models/components/organization.md | 16 +- .../organizationavatarfilecreate.md | 8 +- .../components/organizationavatarfileread.md | 10 +- docs/models/components/organizationcreate.md | 1 - docs/models/components/organizationupdate.md | 1 - docs/models/components/pagination.md | 4 +- docs/models/components/paymentprocessor.md | 2 - docs/models/components/permission.md | 2 +- docs/models/components/pledge.md | 45 ++- docs/models/components/pledger.md | 2 +- docs/models/components/pledgetype.md | 2 +- .../polarcheckoutlegacyschemascheckout.md | 41 +-- ...olarcheckoutlegacyschemascheckoutcreate.md | 2 +- .../polarcheckoutschemascheckout.md | 74 ++-- .../polarcheckoutschemascheckoutcreate.md | 30 +- ...archeckoutschemascheckoutcreatemetadata.md | 23 ++ ...utschemascheckoutcreatepaymentprocessor.md | 17 + .../polarcheckoutschemascheckoutinput.md | 155 --------- .../polarcheckoutschemascheckoutmetadata.md | 23 ++ .../components/polarenumspaymentprocessor.md | 15 - docs/models/components/prices.md | 2 +- docs/models/components/product.md | 47 ++- docs/models/components/productinput.md | 112 ------ .../components/productmediafilecreate.md | 8 +- .../components/productmediafilereadinput.md | 46 --- docs/models/components/productmetadata.md | 23 ++ .../models/components/productonetimecreate.md | 19 +- .../productonetimecreatemetadata.md | 23 ++ docs/models/components/productprice.md | 12 +- docs/models/components/productpriceonetime.md | 20 +- .../components/productpriceonetimecustom.md | 10 +- .../components/productpriceonetimefixed.md | 6 +- .../productpriceonetimefixedcreate.md | 2 +- .../components/productpriceonetimefree.md | 4 +- .../components/productpricerecurring.md | 22 +- .../components/productpricerecurringcustom.md | 10 +- .../components/productpricerecurringfixed.md | 6 +- .../productpricerecurringfixedcreate.md | 2 +- .../components/productpricerecurringfree.md | 4 +- .../components/productrecurringcreate.md | 21 +- .../productrecurringcreatemetadata.md | 23 ++ .../productrecurringcreateprices.md | 4 +- docs/models/components/productsortproperty.md | 2 +- docs/models/components/productupdate.md | 17 +- .../components/productupdatemetadata.md | 23 ++ docs/models/components/productupdateprices.md | 6 +- docs/models/components/reactions.md | 18 +- docs/models/components/repository.md | 1 - .../components/s3filecreatemultipart.md | 6 +- docs/models/components/s3filecreatepart.md | 6 +- .../components/s3fileuploadcompletedpart.md | 2 +- .../components/s3fileuploadmultipart.md | 12 +- docs/models/components/s3fileuploadpart.md | 10 +- docs/models/components/scope.md | 15 + docs/models/components/state.md | 2 +- docs/models/components/subscription.md | 63 ++-- docs/models/components/subscriptioninput.md | 150 -------- .../subscriptionrecurringinterval.md | 2 +- .../components/subscriptionsortproperty.md | 2 +- docs/models/components/subscriptionuser.md | 4 +- docs/models/components/subtype.md | 2 +- docs/models/components/timeframe.md | 2 +- .../components/tokenendpointauthmethod.md | 2 +- docs/models/components/tokenresponse.md | 2 +- docs/models/components/userbenefit.md | 184 +++++----- .../components/userbenefitsortproperty.md | 2 +- docs/models/components/userorder.md | 85 +++-- docs/models/components/userorderproduct.md | 23 +- .../components/userordersubscription.md | 18 +- docs/models/components/usersubscription.md | 1 - .../components/usersubscriptionproduct.md | 1 - docs/models/components/validationerror.md | 2 +- .../webhookbenefitcreatedpayload.md | 16 +- .../webhookbenefitgrantcreatedpayload.md | 24 +- .../webhookbenefitgrantrevokedpayload.md | 16 +- .../webhookbenefitgrantupdatedpayload.md | 14 +- .../webhookbenefitupdatedpayload.md | 18 +- .../webhookcheckoutcreatedpayload.md | 76 +++-- .../webhookcheckoutupdatedpayload.md | 91 ++--- .../webhookdonationcreatedpayload.md | 89 ----- .../webhookdonationcreatedpayloadtype.md | 15 - .../components/webhookordercreatedpayload.md | 50 +-- .../webhookorganizationupdatedpayload.md | 15 +- .../components/webhookpledgecreatedpayload.md | 47 ++- .../components/webhookpledgeupdatedpayload.md | 48 +-- .../webhookproductcreatedpayload.md | 59 ++-- .../webhookproductupdatedpayload.md | 57 ++-- .../webhooksubscriptionactivepayload.md | 99 +++--- .../webhooksubscriptioncanceledpayload.md | 87 +++-- .../webhooksubscriptioncreatedpayload.md | 103 +++--- .../webhooksubscriptionrevokedpayload.md | 94 ++--- .../webhooksubscriptionupdatedpayload.md | 87 +++-- .../operations/advertisementslistresponse.md | 16 +- .../operations/articlesexportrequest.md | 2 +- .../models/operations/articleslistresponse.md | 31 +- .../operations/articlespreviewrequest.md | 2 +- .../operations/articlevisibilityfilter.md | 4 +- .../operations/benefitscreatebenefitcreate.md | 17 +- .../operations/benefitsgrantsresponse.md | 8 +- .../models/operations/benefitslistresponse.md | 21 +- .../operations/benefitsupdatebenefitupdate.md | 2 +- .../operations/checkoutlinkslistresponse.md | 21 +- .../operations/checkoutscustomlistresponse.md | 80 ++--- .../operations/customfieldslistresponse.md | 8 +- .../operations/customfieldtypefilter.md | 4 +- .../operations/filescreatefilecreate.md | 24 +- docs/models/operations/fileslistresponse.md | 13 +- .../filesupdateresponsefilesupdate.md | 28 +- .../models/operations/filesuploadedrequest.md | 4 +- .../filesuploadedresponsefilesuploaded.md | 28 +- ...icensekeyslistqueryparambenefitidfilter.md | 21 ++ .../operations/licensekeyslistrequest.md | 1 + .../operations/licensekeyslistresponse.md | 22 +- ...ricsgetqueryparamproductpricetypefilter.md | 2 +- docs/models/operations/metricsgetrequest.md | 4 +- .../oauth2authorizeresponseoauth2authorize.md | 64 ++++ .../operations/oauth2clientslistresponse.md | 14 +- .../oauth2clientsoauth2updateclientrequest.md | 2 +- .../oauth2introspecttokentokentypehint.md | 2 +- .../oauth2requesttokenrequestbody.md | 2 +- docs/models/operations/orderslistresponse.md | 55 +-- .../operations/organizationslistresponse.md | 1 - .../operations/productscreateproductcreate.md | 4 +- .../models/operations/productslistresponse.md | 56 +-- .../operations/queryparambenefittypefilter.md | 4 +- .../queryparamproductpricetypefilter.md | 2 +- .../operations/repositorieslistresponse.md | 1 - .../operations/subscriptionslistresponse.md | 66 ++-- ...sersbenefitsgetresponseusersbenefitsget.md | 7 - .../operations/usersbenefitslistresponse.md | 1 - .../operations/usersorderslistresponse.md | 1 - .../userssubscriptionslistresponse.md | 1 - docs/sdks/oauth2/README.md | 72 ++++ jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/funcs/advertisementsGet.ts | 3 + src/funcs/advertisementsList.ts | 3 + src/funcs/articlesCreate.ts | 3 + src/funcs/articlesDelete.ts | 3 + src/funcs/articlesExport.ts | 3 + src/funcs/articlesGet.ts | 3 + src/funcs/articlesList.ts | 3 + src/funcs/articlesPreview.ts | 3 + src/funcs/articlesReceivers.ts | 3 + src/funcs/articlesSend.ts | 3 + src/funcs/articlesUpdate.ts | 3 + src/funcs/benefitsCreate.ts | 3 + src/funcs/benefitsDelete.ts | 3 + src/funcs/benefitsGet.ts | 3 + src/funcs/benefitsGrants.ts | 3 + src/funcs/benefitsList.ts | 3 + src/funcs/benefitsUpdate.ts | 3 + src/funcs/checkoutLinksCreate.ts | 3 + src/funcs/checkoutLinksDelete.ts | 3 + src/funcs/checkoutLinksGet.ts | 3 + src/funcs/checkoutLinksList.ts | 3 + src/funcs/checkoutLinksUpdate.ts | 3 + src/funcs/checkoutsCreate.ts | 3 + src/funcs/checkoutsCustomClientConfirm.ts | 3 + src/funcs/checkoutsCustomClientGet.ts | 3 + src/funcs/checkoutsCustomClientUpdate.ts | 3 + src/funcs/checkoutsCustomCreate.ts | 3 + src/funcs/checkoutsCustomGet.ts | 3 + src/funcs/checkoutsCustomList.ts | 3 + src/funcs/checkoutsCustomUpdate.ts | 3 + src/funcs/checkoutsGet.ts | 3 + src/funcs/customFieldsCreate.ts | 3 + src/funcs/customFieldsDelete.ts | 3 + src/funcs/customFieldsGet.ts | 3 + src/funcs/customFieldsList.ts | 3 + src/funcs/customFieldsUpdate.ts | 3 + src/funcs/externalOrganizationsList.ts | 3 + src/funcs/filesCreate.ts | 3 + src/funcs/filesDelete.ts | 3 + src/funcs/filesList.ts | 3 + src/funcs/filesUpdate.ts | 3 + src/funcs/filesUploaded.ts | 3 + src/funcs/licenseKeysGet.ts | 3 + src/funcs/licenseKeysGetActivation.ts | 3 + src/funcs/licenseKeysList.ts | 4 + src/funcs/licenseKeysUpdate.ts | 3 + src/funcs/metricsGet.ts | 3 + src/funcs/metricsLimits.ts | 3 + src/funcs/oauth2Authorize.ts | 107 ++++++ src/funcs/oauth2ClientsCreate.ts | 3 + src/funcs/oauth2ClientsDelete.ts | 3 + src/funcs/oauth2ClientsGet.ts | 3 + src/funcs/oauth2ClientsList.ts | 3 + src/funcs/oauth2ClientsUpdate.ts | 3 + src/funcs/oauth2Introspect.ts | 3 + src/funcs/oauth2Revoke.ts | 3 + src/funcs/oauth2Token.ts | 3 + src/funcs/oauth2Userinfo.ts | 3 + src/funcs/ordersGet.ts | 3 + src/funcs/ordersInvoice.ts | 3 + src/funcs/ordersList.ts | 3 + src/funcs/organizationsCreate.ts | 3 + src/funcs/organizationsGet.ts | 3 + src/funcs/organizationsList.ts | 3 + src/funcs/organizationsUpdate.ts | 3 + src/funcs/productsCreate.ts | 3 + src/funcs/productsGet.ts | 3 + src/funcs/productsList.ts | 3 + src/funcs/productsUpdate.ts | 3 + src/funcs/productsUpdateBenefits.ts | 3 + src/funcs/repositoriesGet.ts | 3 + src/funcs/repositoriesList.ts | 3 + src/funcs/repositoriesUpdate.ts | 3 + src/funcs/subscriptionsExport.ts | 3 + src/funcs/subscriptionsList.ts | 3 + src/funcs/usersAdvertisementsCreate.ts | 3 + src/funcs/usersAdvertisementsDelete.ts | 3 + src/funcs/usersAdvertisementsEnable.ts | 3 + src/funcs/usersAdvertisementsGet.ts | 3 + src/funcs/usersAdvertisementsList.ts | 3 + src/funcs/usersAdvertisementsUpdate.ts | 3 + src/funcs/usersBenefitsGet.ts | 3 + src/funcs/usersBenefitsList.ts | 3 + src/funcs/usersDownloadablesGet.ts | 3 + src/funcs/usersDownloadablesList.ts | 3 + src/funcs/usersLicenseKeysActivate.ts | 3 + src/funcs/usersLicenseKeysDeactivate.ts | 3 + src/funcs/usersLicenseKeysGet.ts | 3 + src/funcs/usersLicenseKeysList.ts | 3 + src/funcs/usersLicenseKeysValidate.ts | 3 + src/funcs/usersOrdersGet.ts | 3 + src/funcs/usersOrdersInvoice.ts | 3 + src/funcs/usersOrdersList.ts | 3 + src/funcs/usersSubscriptionsCancel.ts | 3 + src/funcs/usersSubscriptionsGet.ts | 3 + src/funcs/usersSubscriptionsList.ts | 3 + src/funcs/usersSubscriptionsUpdate.ts | 3 + src/hooks/types.ts | 2 + src/lib/config.ts | 6 +- src/lib/env.ts | 7 +- src/lib/primitives.ts | 20 ++ src/lib/security.ts | 42 ++- .../components/authorizeorganization.ts | 62 ++++ .../authorizeresponseorganization.ts | 115 +++++++ .../components/authorizeresponseuser.ts | 108 ++++++ .../{donationuser.ts => authorizeuser.ts} | 38 +-- src/models/components/benefitdiscord.ts | 123 ------- .../benefitdiscordpropertiesinput.ts | 69 ---- src/models/components/benefitgrantwebhook.ts | 20 +- src/models/components/benefitinput.ts | 109 ------ src/models/components/checkoutlink.ts | 40 ++- src/models/components/checkoutlinkcreate.ts | 48 ++- src/models/components/checkoutlinkupdate.ts | 50 ++- src/models/components/checkoutproduct.ts | 142 -------- src/models/components/checkoutupdate.ts | 50 ++- src/models/components/customfieldcheckbox.ts | 42 ++- .../components/customfieldcreatecheckbox.ts | 54 ++- .../components/customfieldcreatedate.ts | 50 ++- .../components/customfieldcreatenumber.ts | 53 ++- .../components/customfieldcreateselect.ts | 53 ++- .../components/customfieldcreatetext.ts | 50 ++- src/models/components/customfielddate.ts | 42 ++- src/models/components/customfieldnumber.ts | 42 ++- src/models/components/customfieldselect.ts | 42 ++- src/models/components/customfieldtext.ts | 42 ++- .../components/customfieldupdatecheckbox.ts | 54 ++- .../components/customfieldupdatedate.ts | 50 ++- .../components/customfieldupdatenumber.ts | 53 ++- .../components/customfieldupdateselect.ts | 53 ++- .../components/customfieldupdatetext.ts | 50 ++- src/models/components/donation.ts | 152 --------- src/models/components/donationorganization.ts | 72 ---- src/models/components/index.ts | 15 +- src/models/components/oauth2clientpublic.ts | 104 ++++++ src/models/components/order.ts | 40 ++- src/models/components/ordersubscription.ts | 40 ++- src/models/components/organization.ts | 9 - src/models/components/organizationcreate.ts | 6 - src/models/components/organizationupdate.ts | 6 - src/models/components/paymentprocessor.ts | 32 ++ .../polarcheckoutschemascheckout.ts | 321 +++--------------- .../polarcheckoutschemascheckoutcreate.ts | 85 ++++- .../components/polarenumspaymentprocessor.ts | 34 -- src/models/components/product.ts | 36 ++ src/models/components/productinput.ts | 173 ---------- src/models/components/productmediafileread.ts | 128 ------- src/models/components/productonetimecreate.ts | 51 +++ .../components/productrecurringcreate.ts | 51 +++ src/models/components/productupdate.ts | 53 +++ src/models/components/scope.ts | 73 ++++ src/models/components/subscription.ts | 223 ++---------- .../webhookbenefitcreatedpayload.ts | 18 +- .../webhookbenefitupdatedpayload.ts | 18 +- .../webhookcheckoutcreatedpayload.ts | 16 +- .../webhookcheckoutupdatedpayload.ts | 16 +- .../webhookdonationcreatedpayload.ts | 92 ----- .../webhookproductcreatedpayload.ts | 18 +- .../webhookproductupdatedpayload.ts | 18 +- .../webhooksubscriptionactivepayload.ts | 16 +- .../webhooksubscriptioncanceledpayload.ts | 16 +- .../webhooksubscriptioncreatedpayload.ts | 16 +- .../webhooksubscriptionrevokedpayload.ts | 16 +- .../webhooksubscriptionupdatedpayload.ts | 16 +- src/models/operations/index.ts | 1 + src/models/operations/licensekeyslist.ts | 48 +++ src/models/operations/oauth2authorize.ts | 71 ++++ src/sdk/oauth2.ts | 13 + 464 files changed, 5735 insertions(+), 5115 deletions(-) rename docs/models/components/{donationuser.md => authorizeorganization.md} (62%) create mode 100644 docs/models/components/authorizeresponseorganization.md create mode 100644 docs/models/components/authorizeresponseorganizationsubtype.md create mode 100644 docs/models/components/authorizeresponseuser.md create mode 100644 docs/models/components/authorizeresponseusersubtype.md create mode 100644 docs/models/components/authorizeuser.md delete mode 100644 docs/models/components/benefitdiscordinput.md delete mode 100644 docs/models/components/benefitdiscordpropertiesinput.md delete mode 100644 docs/models/components/benefitinput.md create mode 100644 docs/models/components/checkoutlinkcreatemetadata.md create mode 100644 docs/models/components/checkoutlinkmetadata.md create mode 100644 docs/models/components/checkoutlinkupdatemetadata.md delete mode 100644 docs/models/components/checkoutproductinput.md create mode 100644 docs/models/components/checkoutupdatemetadata.md create mode 100644 docs/models/components/customfieldcheckboxmetadata.md create mode 100644 docs/models/components/customfieldcreatecheckboxmetadata.md create mode 100644 docs/models/components/customfieldcreatedatemetadata.md create mode 100644 docs/models/components/customfieldcreatenumbermetadata.md create mode 100644 docs/models/components/customfieldcreateselectmetadata.md create mode 100644 docs/models/components/customfieldcreatetextmetadata.md create mode 100644 docs/models/components/customfielddatemetadata.md create mode 100644 docs/models/components/customfieldnumbermetadata.md create mode 100644 docs/models/components/customfieldselectmetadata.md create mode 100644 docs/models/components/customfieldtextmetadata.md create mode 100644 docs/models/components/customfieldupdatecheckboxmetadata.md create mode 100644 docs/models/components/customfieldupdatedatemetadata.md create mode 100644 docs/models/components/customfieldupdatenumbermetadata.md create mode 100644 docs/models/components/customfieldupdateselectmetadata.md create mode 100644 docs/models/components/customfieldupdatetextmetadata.md delete mode 100644 docs/models/components/donationorganization.md delete mode 100644 docs/models/components/donor.md create mode 100644 docs/models/components/metadata.md rename docs/models/components/{donation.md => oauth2clientpublic.md} (52%) create mode 100644 docs/models/components/ordermetadata.md create mode 100644 docs/models/components/ordersubscriptionmetadata.md create mode 100644 docs/models/components/polarcheckoutschemascheckoutcreatemetadata.md create mode 100644 docs/models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md delete mode 100644 docs/models/components/polarcheckoutschemascheckoutinput.md create mode 100644 docs/models/components/polarcheckoutschemascheckoutmetadata.md delete mode 100644 docs/models/components/polarenumspaymentprocessor.md delete mode 100644 docs/models/components/productinput.md delete mode 100644 docs/models/components/productmediafilereadinput.md create mode 100644 docs/models/components/productmetadata.md create mode 100644 docs/models/components/productonetimecreatemetadata.md create mode 100644 docs/models/components/productrecurringcreatemetadata.md create mode 100644 docs/models/components/productupdatemetadata.md create mode 100644 docs/models/components/scope.md delete mode 100644 docs/models/components/subscriptioninput.md delete mode 100644 docs/models/components/webhookdonationcreatedpayload.md delete mode 100644 docs/models/components/webhookdonationcreatedpayloadtype.md create mode 100644 docs/models/operations/licensekeyslistqueryparambenefitidfilter.md create mode 100644 docs/models/operations/oauth2authorizeresponseoauth2authorize.md create mode 100644 src/funcs/oauth2Authorize.ts create mode 100644 src/models/components/authorizeorganization.ts create mode 100644 src/models/components/authorizeresponseorganization.ts create mode 100644 src/models/components/authorizeresponseuser.ts rename src/models/components/{donationuser.ts => authorizeuser.ts} (51%) delete mode 100644 src/models/components/benefitdiscordpropertiesinput.ts delete mode 100644 src/models/components/benefitinput.ts delete mode 100644 src/models/components/donation.ts delete mode 100644 src/models/components/donationorganization.ts create mode 100644 src/models/components/oauth2clientpublic.ts create mode 100644 src/models/components/paymentprocessor.ts delete mode 100644 src/models/components/polarenumspaymentprocessor.ts delete mode 100644 src/models/components/productinput.ts create mode 100644 src/models/components/scope.ts delete mode 100644 src/models/components/webhookdonationcreatedpayload.ts create mode 100644 src/models/operations/oauth2authorize.ts diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index d900ff49..860e209c 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 983150e6-ebc8-43fe-9b18-750461aad344 management: - docChecksum: 9b3030720e46b7de09827b780f11990a + docChecksum: f10d2ffa9e9b80cbc34e64ff5e4038e9 docVersion: 0.1.0 - speakeasyVersion: 1.431.0 - generationVersion: 2.451.0 - releaseVersion: 0.15.1 - configChecksum: 696ad9740df1b7253d7c04779515176f + speakeasyVersion: 1.438.1 + generationVersion: 2.457.2 + releaseVersion: 0.16.0 + configChecksum: 51618a402ae7ac3463cae88c673fb726 repoURL: https://github.com/polarsource/polar-js.git installationURL: https://github.com/polarsource/polar-js published: true @@ -25,8 +25,6 @@ features: globalSecurityFlattening: 0.1.0 globalServerURLs: 2.82.4 groups: 2.81.2 - ignores: 2.81.1 - inputOutputModels: 2.82.0 nameOverrides: 2.81.2 nullables: 0.1.0 pagination: 2.82.7 @@ -65,6 +63,12 @@ generatedFiles: - docs/models/components/attachedcustomfield.md - docs/models/components/attachedcustomfieldcreate.md - docs/models/components/author.md + - docs/models/components/authorizeorganization.md + - docs/models/components/authorizeresponseorganization.md + - docs/models/components/authorizeresponseorganizationsubtype.md + - docs/models/components/authorizeresponseuser.md + - docs/models/components/authorizeresponseusersubtype.md + - docs/models/components/authorizeuser.md - docs/models/components/benefit.md - docs/models/components/benefitads.md - docs/models/components/benefitadscreate.md @@ -98,9 +102,7 @@ generatedFiles: - docs/models/components/benefitdiscordcreate.md - docs/models/components/benefitdiscordcreateproperties.md - docs/models/components/benefitdiscordcreatetype.md - - docs/models/components/benefitdiscordinput.md - docs/models/components/benefitdiscordproperties.md - - docs/models/components/benefitdiscordpropertiesinput.md - docs/models/components/benefitdiscordsubscriber.md - docs/models/components/benefitdiscordsubscriberproperties.md - docs/models/components/benefitdiscordsubscribertype.md @@ -145,7 +147,6 @@ generatedFiles: - docs/models/components/benefitgrantsubscriber.md - docs/models/components/benefitgrantwebhook.md - docs/models/components/benefitgrantwebhookproperties.md - - docs/models/components/benefitinput.md - docs/models/components/benefitlicensekeyactivationproperties.md - docs/models/components/benefitlicensekeyexpirationproperties.md - docs/models/components/benefitlicensekeys.md @@ -166,68 +167,82 @@ generatedFiles: - docs/models/components/checkoutconfirmstripecustomfielddata.md - docs/models/components/checkoutlink.md - docs/models/components/checkoutlinkcreate.md + - docs/models/components/checkoutlinkcreatemetadata.md - docs/models/components/checkoutlinkcreatepaymentprocessor.md + - docs/models/components/checkoutlinkmetadata.md - docs/models/components/checkoutlinksortproperty.md - docs/models/components/checkoutlinkupdate.md + - docs/models/components/checkoutlinkupdatemetadata.md - docs/models/components/checkoutproduct.md - docs/models/components/checkoutproductbenefits.md - - docs/models/components/checkoutproductinput.md - docs/models/components/checkoutpublic.md - docs/models/components/checkoutpubliccustomfielddata.md - docs/models/components/checkoutpublicpaymentprocessormetadata.md - docs/models/components/checkoutsortproperty.md - docs/models/components/checkoutstatus.md - docs/models/components/checkoutupdate.md + - docs/models/components/checkoutupdatemetadata.md - docs/models/components/checkoutupdatepublic.md - docs/models/components/checkoutupdatepubliccustomfielddata.md - docs/models/components/conditions.md - docs/models/components/currencyamount.md - docs/models/components/customfield.md - docs/models/components/customfieldcheckbox.md + - docs/models/components/customfieldcheckboxmetadata.md - docs/models/components/customfieldcheckboxproperties.md - docs/models/components/customfieldcheckboxtype.md - docs/models/components/customfieldcreate.md - docs/models/components/customfieldcreatecheckbox.md + - docs/models/components/customfieldcreatecheckboxmetadata.md - docs/models/components/customfieldcreatecheckboxtype.md - docs/models/components/customfieldcreatedate.md + - docs/models/components/customfieldcreatedatemetadata.md - docs/models/components/customfieldcreatedatetype.md - docs/models/components/customfieldcreatenumber.md + - docs/models/components/customfieldcreatenumbermetadata.md - docs/models/components/customfieldcreatenumbertype.md - docs/models/components/customfieldcreateselect.md + - docs/models/components/customfieldcreateselectmetadata.md - docs/models/components/customfieldcreateselecttype.md - docs/models/components/customfieldcreatetext.md + - docs/models/components/customfieldcreatetextmetadata.md - docs/models/components/customfieldcreatetexttype.md - docs/models/components/customfielddata.md - docs/models/components/customfielddate.md + - docs/models/components/customfielddatemetadata.md - docs/models/components/customfielddateproperties.md - docs/models/components/customfielddatetype.md - docs/models/components/customfieldnumber.md + - docs/models/components/customfieldnumbermetadata.md - docs/models/components/customfieldnumberproperties.md - docs/models/components/customfieldnumbertype.md - docs/models/components/customfieldselect.md + - docs/models/components/customfieldselectmetadata.md - docs/models/components/customfieldselectoption.md - docs/models/components/customfieldselectproperties.md - docs/models/components/customfieldselecttype.md - docs/models/components/customfieldsortproperty.md - docs/models/components/customfieldtext.md + - docs/models/components/customfieldtextmetadata.md - docs/models/components/customfieldtextproperties.md - docs/models/components/customfieldtexttype.md - docs/models/components/customfieldtype.md - docs/models/components/customfieldupdate.md - docs/models/components/customfieldupdatecheckbox.md + - docs/models/components/customfieldupdatecheckboxmetadata.md - docs/models/components/customfieldupdatecheckboxtype.md - docs/models/components/customfieldupdatedate.md + - docs/models/components/customfieldupdatedatemetadata.md - docs/models/components/customfieldupdatedatetype.md - docs/models/components/customfieldupdatenumber.md + - docs/models/components/customfieldupdatenumbermetadata.md - docs/models/components/customfieldupdatenumbertype.md - docs/models/components/customfieldupdateselect.md + - docs/models/components/customfieldupdateselectmetadata.md - docs/models/components/customfieldupdateselecttype.md - docs/models/components/customfieldupdatetext.md + - docs/models/components/customfieldupdatetextmetadata.md - docs/models/components/customfieldupdatetexttype.md - - docs/models/components/donation.md - - docs/models/components/donationorganization.md - - docs/models/components/donationuser.md - - docs/models/components/donor.md - docs/models/components/downloadablefilecreate.md - docs/models/components/downloadablefilecreateservice.md - docs/models/components/downloadablefileread.md @@ -285,6 +300,7 @@ generatedFiles: - docs/models/components/listresourceusersubscription.md - docs/models/components/loc.md - docs/models/components/meta.md + - docs/models/components/metadata.md - docs/models/components/metric.md - docs/models/components/metricperiod.md - docs/models/components/metrics.md @@ -302,6 +318,7 @@ generatedFiles: - docs/models/components/oauth2clientconfigurationupdategranttypes.md - docs/models/components/oauth2clientconfigurationupdateresponsetypes.md - docs/models/components/oauth2clientconfigurationupdatetokenendpointauthmethod.md + - docs/models/components/oauth2clientpublic.md - docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md - docs/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequest.md - docs/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequestgranttype.md @@ -309,9 +326,11 @@ generatedFiles: - docs/models/components/orderbillingreason.md - docs/models/components/ordercustomfielddata.md - docs/models/components/orderinvoice.md + - docs/models/components/ordermetadata.md - docs/models/components/orderproduct.md - docs/models/components/ordersortproperty.md - docs/models/components/ordersubscription.md + - docs/models/components/ordersubscriptionmetadata.md - docs/models/components/orderuser.md - docs/models/components/organization.md - docs/models/components/organizationavatarfilecreate.md @@ -338,19 +357,20 @@ generatedFiles: - docs/models/components/polarcheckoutschemascheckout.md - docs/models/components/polarcheckoutschemascheckoutcreate.md - docs/models/components/polarcheckoutschemascheckoutcreatecustomfielddata.md + - docs/models/components/polarcheckoutschemascheckoutcreatemetadata.md + - docs/models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md - docs/models/components/polarcheckoutschemascheckoutcustomfielddata.md - - docs/models/components/polarcheckoutschemascheckoutinput.md - - docs/models/components/polarenumspaymentprocessor.md + - docs/models/components/polarcheckoutschemascheckoutmetadata.md - docs/models/components/previousproperties.md - docs/models/components/prices.md - docs/models/components/product.md - docs/models/components/productbenefitsupdate.md - - docs/models/components/productinput.md - docs/models/components/productmediafilecreate.md - docs/models/components/productmediafilecreateservice.md - docs/models/components/productmediafileread.md - - docs/models/components/productmediafilereadinput.md + - docs/models/components/productmetadata.md - docs/models/components/productonetimecreate.md + - docs/models/components/productonetimecreatemetadata.md - docs/models/components/productprice.md - docs/models/components/productpriceonetime.md - docs/models/components/productpriceonetimecustom.md @@ -388,9 +408,11 @@ generatedFiles: - docs/models/components/productpricerecurringfreetype.md - docs/models/components/productpricetype.md - docs/models/components/productrecurringcreate.md + - docs/models/components/productrecurringcreatemetadata.md - docs/models/components/productrecurringcreateprices.md - docs/models/components/productsortproperty.md - docs/models/components/productupdate.md + - docs/models/components/productupdatemetadata.md - docs/models/components/productupdateprices.md - docs/models/components/properties.md - docs/models/components/reactions.md @@ -407,12 +429,12 @@ generatedFiles: - docs/models/components/s3fileuploadcompletedpart.md - docs/models/components/s3fileuploadmultipart.md - docs/models/components/s3fileuploadpart.md + - docs/models/components/scope.md - docs/models/components/security.md - docs/models/components/service.md - docs/models/components/state.md - docs/models/components/subscription.md - docs/models/components/subscriptioncustomfielddata.md - - docs/models/components/subscriptioninput.md - docs/models/components/subscriptionrecurringinterval.md - docs/models/components/subscriptionsortproperty.md - docs/models/components/subscriptionstatus.md @@ -458,8 +480,6 @@ generatedFiles: - docs/models/components/webhookcheckoutcreatedpayloadtype.md - docs/models/components/webhookcheckoutupdatedpayload.md - docs/models/components/webhookcheckoutupdatedpayloadtype.md - - docs/models/components/webhookdonationcreatedpayload.md - - docs/models/components/webhookdonationcreatedpayloadtype.md - docs/models/components/webhookordercreatedpayload.md - docs/models/components/webhookordercreatedpayloadtype.md - docs/models/components/webhookorganizationupdatedpayload.md @@ -557,6 +577,7 @@ generatedFiles: - docs/models/operations/filesuploadedresponsefilesuploaded.md - docs/models/operations/licensekeysgetactivationrequest.md - docs/models/operations/licensekeysgetrequest.md + - docs/models/operations/licensekeyslistqueryparambenefitidfilter.md - docs/models/operations/licensekeyslistqueryparamorganizationidfilter.md - docs/models/operations/licensekeyslistrequest.md - docs/models/operations/licensekeyslistresponse.md @@ -565,6 +586,7 @@ generatedFiles: - docs/models/operations/metricsgetqueryparamproductidfilter.md - docs/models/operations/metricsgetqueryparamproductpricetypefilter.md - docs/models/operations/metricsgetrequest.md + - docs/models/operations/oauth2authorizeresponseoauth2authorize.md - docs/models/operations/oauth2clientslistrequest.md - docs/models/operations/oauth2clientslistresponse.md - docs/models/operations/oauth2clientsoauth2deleteclientrequest.md @@ -726,6 +748,7 @@ generatedFiles: - src/funcs/licenseKeysUpdate.ts - src/funcs/metricsGet.ts - src/funcs/metricsLimits.ts + - src/funcs/oauth2Authorize.ts - src/funcs/oauth2ClientsCreate.ts - src/funcs/oauth2ClientsDelete.ts - src/funcs/oauth2ClientsGet.ts @@ -809,6 +832,10 @@ generatedFiles: - src/models/components/attachedcustomfield.ts - src/models/components/attachedcustomfieldcreate.ts - src/models/components/author.ts + - src/models/components/authorizeorganization.ts + - src/models/components/authorizeresponseorganization.ts + - src/models/components/authorizeresponseuser.ts + - src/models/components/authorizeuser.ts - src/models/components/benefit.ts - src/models/components/benefitads.ts - src/models/components/benefitadscreate.ts @@ -832,7 +859,6 @@ generatedFiles: - src/models/components/benefitdiscordcreate.ts - src/models/components/benefitdiscordcreateproperties.ts - src/models/components/benefitdiscordproperties.ts - - src/models/components/benefitdiscordpropertiesinput.ts - src/models/components/benefitdiscordsubscriber.ts - src/models/components/benefitdiscordsubscriberproperties.ts - src/models/components/benefitdiscordupdate.ts @@ -863,7 +889,6 @@ generatedFiles: - src/models/components/benefitgrantlicensekeysproperties.ts - src/models/components/benefitgrantsubscriber.ts - src/models/components/benefitgrantwebhook.ts - - src/models/components/benefitinput.ts - src/models/components/benefitlicensekeyactivationproperties.ts - src/models/components/benefitlicensekeyexpirationproperties.ts - src/models/components/benefitlicensekeys.ts @@ -913,9 +938,6 @@ generatedFiles: - src/models/components/customfieldupdatenumber.ts - src/models/components/customfieldupdateselect.ts - src/models/components/customfieldupdatetext.ts - - src/models/components/donation.ts - - src/models/components/donationorganization.ts - - src/models/components/donationuser.ts - src/models/components/downloadablefilecreate.ts - src/models/components/downloadablefileread.ts - src/models/components/downloadableread.ts @@ -974,6 +996,7 @@ generatedFiles: - src/models/components/oauth2client.ts - src/models/components/oauth2clientconfiguration.ts - src/models/components/oauth2clientconfigurationupdate.ts + - src/models/components/oauth2clientpublic.ts - src/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.ts - src/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequest.ts - src/models/components/order.ts @@ -993,6 +1016,7 @@ generatedFiles: - src/models/components/organizationsubscribepromotesettings.ts - src/models/components/organizationupdate.ts - src/models/components/pagination.ts + - src/models/components/paymentprocessor.ts - src/models/components/platforms.ts - src/models/components/pledge.ts - src/models/components/pledger.ts @@ -1002,10 +1026,8 @@ generatedFiles: - src/models/components/polarcheckoutlegacyschemascheckoutcreate.ts - src/models/components/polarcheckoutschemascheckout.ts - src/models/components/polarcheckoutschemascheckoutcreate.ts - - src/models/components/polarenumspaymentprocessor.ts - src/models/components/product.ts - src/models/components/productbenefitsupdate.ts - - src/models/components/productinput.ts - src/models/components/productmediafilecreate.ts - src/models/components/productmediafileread.ts - src/models/components/productonetimecreate.ts @@ -1040,6 +1062,7 @@ generatedFiles: - src/models/components/s3fileuploadcompletedpart.ts - src/models/components/s3fileuploadmultipart.ts - src/models/components/s3fileuploadpart.ts + - src/models/components/scope.ts - src/models/components/security.ts - src/models/components/state.ts - src/models/components/subscription.ts @@ -1075,7 +1098,6 @@ generatedFiles: - src/models/components/webhookbenefitupdatedpayload.ts - src/models/components/webhookcheckoutcreatedpayload.ts - src/models/components/webhookcheckoutupdatedpayload.ts - - src/models/components/webhookdonationcreatedpayload.ts - src/models/components/webhookordercreatedpayload.ts - src/models/components/webhookorganizationupdatedpayload.ts - src/models/components/webhookpledgecreatedpayload.ts @@ -1140,6 +1162,7 @@ generatedFiles: - src/models/operations/licensekeyslist.ts - src/models/operations/licensekeysupdate.ts - src/models/operations/metricsget.ts + - src/models/operations/oauth2authorize.ts - src/models/operations/oauth2clientslist.ts - src/models/operations/oauth2clientsoauth2deleteclient.ts - src/models/operations/oauth2clientsoauth2getclient.ts @@ -1232,7 +1255,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-09-05T11:33:52.011Z", "modified_at": "2023-08-20T11:11:04.610Z", "id": "", "description": "hundred whereas dimly unused cone restructure gadzooks", "selectable": false, "deletable": false, "organization_id": "", "grants": [{"created_at": "2023-03-12T15:23:46.888Z", "modified_at": "2024-03-05T14:23:34.462Z", "id": "", "is_granted": true, "is_revoked": true, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}, {"created_at": "2024-02-24T17:48:17.639Z", "modified_at": "2023-03-07T06:16:39.367Z", "id": "", "is_granted": false, "is_revoked": false, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}, {"created_at": "2024-07-13T14:31:52.430Z", "modified_at": "2023-04-01T04:11:43.083Z", "id": "", "is_granted": true, "is_revoked": false, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}], "organization": {"created_at": "2023-07-07T00:34:30.082Z", "modified_at": "2024-11-07T20:31:03.453Z", "id": "", "name": "", "slug": "", "avatar_url": "https://bleak-birdcage.com/", "bio": "", "company": "Orn and Sons", "blog": "", "location": "", "email": "Lowell_Greenholt28@gmail.com", "twitter_username": "", "pledge_minimum_amount": 710636, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 786952, "donations_enabled": false}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo"}} + application/json: {"created_at": "2023-09-05T11:33:52.011Z", "modified_at": "2023-08-20T11:11:04.610Z", "id": "", "description": "hundred whereas dimly unused cone restructure gadzooks", "selectable": false, "deletable": false, "organization_id": "", "grants": [{"created_at": "2023-03-12T15:23:46.888Z", "modified_at": "2024-03-05T14:23:34.462Z", "id": "", "is_granted": true, "is_revoked": true, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}, {"created_at": "2024-02-24T17:48:17.639Z", "modified_at": "2023-03-07T06:16:39.367Z", "id": "", "is_granted": false, "is_revoked": false, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}, {"created_at": "2024-07-13T14:31:52.430Z", "modified_at": "2023-04-01T04:11:43.083Z", "id": "", "is_granted": true, "is_revoked": false, "subscription_id": "", "order_id": "", "user_id": "", "benefit_id": ""}], "organization": {"created_at": "2023-07-07T00:34:30.082Z", "modified_at": "2024-11-07T20:31:03.453Z", "id": "", "name": "", "slug": "", "avatar_url": "https://bleak-birdcage.com/", "bio": "", "company": "Orn and Sons", "blog": "", "location": "", "email": "Lowell_Greenholt28@gmail.com", "twitter_username": "", "pledge_minimum_amount": 710636, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 786952}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo"}} "404": application/json: {"detail": ""} "422": {} @@ -1249,7 +1272,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "amount": 558834, "tax_amount": 844199, "currency": "Ouguiya", "user_id": "", "product_id": "", "product_price_id": "", "subscription_id": "", "product": {"created_at": "2024-06-29T09:01:50.308Z", "modified_at": "2023-07-26T06:33:15.886Z", "id": "", "name": "", "description": "Centralized well-modulated strategy", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699, "donations_enabled": false}}, "product_price": {"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}, "subscription": {"created_at": "2022-11-08T10:33:23.061Z", "modified_at": "2023-04-26T04:53:50.205Z", "id": "", "amount": 521235, "currency": "Bulgarian Lev", "recurring_interval": "year", "status": "trialing", "current_period_start": "2024-05-28T07:17:56.701Z", "current_period_end": "2024-03-20T23:00:26.309Z", "cancel_at_period_end": false, "started_at": "2024-12-06T14:08:11.458Z", "ended_at": "2022-08-30T01:43:46.083Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": ""}} + application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "amount": 558834, "tax_amount": 844199, "currency": "Ouguiya", "user_id": "", "product_id": "", "product_price_id": "", "subscription_id": "", "product": {"created_at": "2024-06-29T09:01:50.308Z", "modified_at": "2023-07-26T06:33:15.886Z", "id": "", "name": "", "description": "Centralized well-modulated strategy", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699}}, "product_price": {"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}, "subscription": {"created_at": "2022-11-08T10:33:23.061Z", "modified_at": "2023-04-26T04:53:50.205Z", "id": "", "amount": 521235, "currency": "Bulgarian Lev", "recurring_interval": "year", "status": "trialing", "current_period_start": "2024-05-28T07:17:56.701Z", "current_period_end": "2024-03-20T23:00:26.309Z", "cancel_at_period_end": false, "started_at": "2024-12-06T14:08:11.458Z", "ended_at": "2022-08-30T01:43:46.083Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": ""}} "404": application/json: {"detail": ""} "422": {} @@ -1289,7 +1312,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "amount": 700347, "currency": "Burundi Franc", "recurring_interval": "year", "status": "active", "current_period_start": "2024-07-14T05:47:45.857Z", "current_period_end": "2023-08-20T11:11:04.289Z", "cancel_at_period_end": false, "started_at": "2023-07-26T06:33:15.886Z", "ended_at": "2022-03-28T03:17:21.516Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2024-11-29T01:50:48.387Z", "modified_at": "2024-08-07T07:28:43.175Z", "id": "", "name": "", "description": "Multi-channelled optimal hierarchy", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699, "donations_enabled": false}}, "price": {"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}} + application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "amount": 700347, "currency": "Burundi Franc", "recurring_interval": "year", "status": "active", "current_period_start": "2024-07-14T05:47:45.857Z", "current_period_end": "2023-08-20T11:11:04.289Z", "cancel_at_period_end": false, "started_at": "2023-07-26T06:33:15.886Z", "ended_at": "2022-03-28T03:17:21.516Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2024-11-29T01:50:48.387Z", "modified_at": "2024-08-07T07:28:43.175Z", "id": "", "name": "", "description": "Multi-channelled optimal hierarchy", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699}}, "price": {"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}} "404": application/json: {"detail": ""} "422": {} @@ -1302,7 +1325,7 @@ examples: application/json: {"product_price_id": ""} responses: "200": - application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "amount": 857478, "currency": "Netherlands Antillian Guilder", "recurring_interval": "year", "status": "past_due", "current_period_start": "2022-01-18T03:43:33.232Z", "current_period_end": "2023-01-13T16:52:57.237Z", "cancel_at_period_end": true, "started_at": "2024-12-22T15:27:45.933Z", "ended_at": "2022-10-24T06:37:05.817Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2023-11-19T22:44:57.818Z", "modified_at": "2024-01-20T21:09:11.127Z", "id": "", "name": "", "description": "Multi-tiered grid-enabled website", "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-07-28T19:04:48.565Z", "modified_at": "2023-10-17T10:52:42.015Z", "id": "", "name": "", "slug": "", "avatar_url": "https://yearly-order.info/", "bio": "", "company": "Becker, Treutel and King", "blog": "", "location": "", "email": "Delphia_Schamberger@gmail.com", "twitter_username": "", "pledge_minimum_amount": 771203, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 404265, "donations_enabled": true}}, "price": {"created_at": "2023-01-13T16:52:57.274Z", "modified_at": "2024-12-22T15:27:45.882Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 488852, "maximum_amount": 984008, "preset_amount": 54062}} + application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "amount": 857478, "currency": "Netherlands Antillian Guilder", "recurring_interval": "year", "status": "past_due", "current_period_start": "2022-01-18T03:43:33.232Z", "current_period_end": "2023-01-13T16:52:57.237Z", "cancel_at_period_end": true, "started_at": "2024-12-22T15:27:45.933Z", "ended_at": "2022-10-24T06:37:05.817Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2023-11-19T22:44:57.818Z", "modified_at": "2024-01-20T21:09:11.127Z", "id": "", "name": "", "description": "Multi-tiered grid-enabled website", "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2024-07-28T19:04:48.565Z", "modified_at": "2023-10-17T10:52:42.015Z", "id": "", "name": "", "slug": "", "avatar_url": "https://yearly-order.info/", "bio": "", "company": "Becker, Treutel and King", "blog": "", "location": "", "email": "Delphia_Schamberger@gmail.com", "twitter_username": "", "pledge_minimum_amount": 771203, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 404265}}, "price": {"created_at": "2023-01-13T16:52:57.274Z", "modified_at": "2024-12-22T15:27:45.882Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 488852, "maximum_amount": 984008, "preset_amount": 54062}} "403": application/json: {"detail": ""} "404": @@ -1315,7 +1338,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2022-01-28T04:39:19.402Z", "modified_at": "2022-07-26T00:54:13.634Z", "id": "", "amount": 24812, "currency": "Cuban Peso", "recurring_interval": "year", "status": "unpaid", "current_period_start": "2023-12-06T17:35:22.378Z", "current_period_end": "2023-06-04T09:53:22.955Z", "cancel_at_period_end": false, "started_at": "2022-04-04T13:59:58.493Z", "ended_at": "2022-07-16T10:00:54.807Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2022-08-03T23:44:35.164Z", "modified_at": "2022-05-01T05:45:14.845Z", "id": "", "name": "", "description": "Fully-configurable multimedia alliance", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2022-01-28T04:39:19.513Z", "modified_at": "2024-12-24T10:36:51.473Z", "id": "", "name": "", "slug": "", "avatar_url": "https://brave-costume.biz/", "bio": "", "company": "Crooks - Marvin", "blog": "", "location": "", "email": "Dagmar41@gmail.com", "twitter_username": "", "pledge_minimum_amount": 730293, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 786521, "donations_enabled": true}}, "price": {"created_at": "2023-06-04T09:53:22.758Z", "modified_at": "2022-04-04T13:59:58.090Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}} + application/json: {"created_at": "2022-01-28T04:39:19.402Z", "modified_at": "2022-07-26T00:54:13.634Z", "id": "", "amount": 24812, "currency": "Cuban Peso", "recurring_interval": "year", "status": "unpaid", "current_period_start": "2023-12-06T17:35:22.378Z", "current_period_end": "2023-06-04T09:53:22.955Z", "cancel_at_period_end": false, "started_at": "2022-04-04T13:59:58.493Z", "ended_at": "2022-07-16T10:00:54.807Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": "", "product": {"created_at": "2022-08-03T23:44:35.164Z", "modified_at": "2022-05-01T05:45:14.845Z", "id": "", "name": "", "description": "Fully-configurable multimedia alliance", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "organization": {"created_at": "2022-01-28T04:39:19.513Z", "modified_at": "2024-12-24T10:36:51.473Z", "id": "", "name": "", "slug": "", "avatar_url": "https://brave-costume.biz/", "bio": "", "company": "Crooks - Marvin", "blog": "", "location": "", "email": "Dagmar41@gmail.com", "twitter_username": "", "pledge_minimum_amount": 730293, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 786521}}, "price": {"created_at": "2023-06-04T09:53:22.758Z", "modified_at": "2022-04-04T13:59:58.090Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}} "403": application/json: {"detail": ""} "404": @@ -1466,7 +1489,7 @@ examples: id: "" responses: "200": - application/json: {"id": "b18d8d81-fd7b-4764-a31e-475cb1f36591", "is_private": false, "name": "MyOrg", "description": "Optional reciprocal projection", "stars": 1337, "license": "", "homepage": "", "organization": {"id": "c65bc928-1545-452e-b0c0-48b8c2b5ed5f", "name": "", "avatar_url": "", "is_personal": true, "bio": "", "pretty_name": "", "company": "Windler, Bahringer and Kilback", "blog": "", "location": "", "email": "Herbert14@hotmail.com", "twitter_username": "", "organization_id": ""}, "internal_organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699, "donations_enabled": false}} + application/json: {"id": "b18d8d81-fd7b-4764-a31e-475cb1f36591", "is_private": false, "name": "MyOrg", "description": "Optional reciprocal projection", "stars": 1337, "license": "", "homepage": "", "organization": {"id": "c65bc928-1545-452e-b0c0-48b8c2b5ed5f", "name": "", "avatar_url": "", "is_personal": true, "bio": "", "pretty_name": "", "company": "Windler, Bahringer and Kilback", "blog": "", "location": "", "email": "Herbert14@hotmail.com", "twitter_username": "", "organization_id": ""}, "internal_organization": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "slug": "", "avatar_url": "https://misguided-violin.info", "bio": "", "company": "Gislason Group", "blog": "", "location": "", "email": "Ian.Block31@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 552582, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 380699}} "404": application/json: {"detail": ""} "422": {} @@ -1477,7 +1500,7 @@ examples: id: "" responses: "200": - application/json: {"id": "d0905bf4-aa77-4f20-8e77-54c352acfe54", "is_private": true, "name": "MyOrg", "description": "Multi-lateral grid-enabled product", "stars": 1337, "license": "", "homepage": "", "organization": {"id": "abf6805c-5ca7-4187-9435-5ad7d4e1b584", "name": "", "avatar_url": "", "is_personal": false, "bio": "", "pretty_name": "", "company": "Lubowitz - Wiza", "blog": "", "location": "", "email": "Reta_Larkin@yahoo.com", "twitter_username": "", "organization_id": ""}, "internal_organization": {"created_at": "2024-07-28T19:04:48.565Z", "modified_at": "2023-10-17T10:52:42.015Z", "id": "", "name": "", "slug": "", "avatar_url": "https://yearly-order.info/", "bio": "", "company": "Becker, Treutel and King", "blog": "", "location": "", "email": "Delphia_Schamberger@gmail.com", "twitter_username": "", "pledge_minimum_amount": 771203, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 404265, "donations_enabled": true}} + application/json: {"id": "d0905bf4-aa77-4f20-8e77-54c352acfe54", "is_private": true, "name": "MyOrg", "description": "Multi-lateral grid-enabled product", "stars": 1337, "license": "", "homepage": "", "organization": {"id": "abf6805c-5ca7-4187-9435-5ad7d4e1b584", "name": "", "avatar_url": "", "is_personal": false, "bio": "", "pretty_name": "", "company": "Lubowitz - Wiza", "blog": "", "location": "", "email": "Reta_Larkin@yahoo.com", "twitter_username": "", "organization_id": ""}, "internal_organization": {"created_at": "2024-07-28T19:04:48.565Z", "modified_at": "2023-10-17T10:52:42.015Z", "id": "", "name": "", "slug": "", "avatar_url": "https://yearly-order.info/", "bio": "", "company": "Becker, Treutel and King", "blog": "", "location": "", "email": "Delphia_Schamberger@gmail.com", "twitter_username": "", "pledge_minimum_amount": 771203, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 404265}} "403": application/json: {"detail": ""} "404": @@ -1495,7 +1518,7 @@ examples: application/json: {"name": "", "slug": ""} responses: "201": - application/json: {"created_at": "2023-06-18T07:14:55.676Z", "modified_at": "2023-06-21T08:42:38.998Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Stokes - Johnson", "blog": "", "location": "", "email": "Bria99@gmail.com", "twitter_username": "", "pledge_minimum_amount": 796474, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 951062, "donations_enabled": false} + application/json: {"created_at": "2023-06-18T07:14:55.676Z", "modified_at": "2023-06-21T08:42:38.998Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Stokes - Johnson", "blog": "", "location": "", "email": "Bria99@gmail.com", "twitter_username": "", "pledge_minimum_amount": 796474, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 951062} "422": {} organizations:get: speakeasy-default-organizations:get: @@ -1504,7 +1527,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Sporer - Little", "blog": "", "location": "", "email": "Jovanny_Block45@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 735287, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 413663, "donations_enabled": true} + application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Sporer - Little", "blog": "", "location": "", "email": "Jovanny_Block45@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 735287, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 413663} "404": application/json: {"detail": ""} "422": {} @@ -1515,7 +1538,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Armstrong - Hegmann", "blog": "", "location": "", "email": "Yvonne_Glover@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 488852, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 984008, "donations_enabled": true} + application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Armstrong - Hegmann", "blog": "", "location": "", "email": "Yvonne_Glover@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 488852, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 984008} "403": application/json: {"detail": ""} "404": @@ -1561,7 +1584,7 @@ examples: application/json: {"title": ""} responses: "201": - application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "hidden", "user_id": "", "organization_id": "", "organization": {"created_at": "2023-06-21T08:42:38.998Z", "modified_at": "2023-12-01T17:06:07.793Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Johnson, Green and Collier", "blog": "", "location": "", "email": "Annie.Zieme95@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 891510, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 455222, "donations_enabled": true}, "published_at": "2022-11-27T10:55:40.526Z", "paid_subscribers_only": false, "paid_subscribers_only_ends_at": "2024-02-23T16:23:46.908Z", "is_preview": false, "is_pinned": false, "notify_subscribers": false, "notifications_sent_at": "2023-08-28T21:56:09.233Z", "email_sent_to_count": 586220, "og_image_url": "", "og_description": ""} + application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "hidden", "user_id": "", "organization_id": "", "organization": {"created_at": "2023-06-21T08:42:38.998Z", "modified_at": "2023-12-01T17:06:07.793Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Johnson, Green and Collier", "blog": "", "location": "", "email": "Annie.Zieme95@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 891510, "pledge_badge_show_amount": false, "default_upfront_split_to_contributors": 455222}, "published_at": "2022-11-27T10:55:40.526Z", "paid_subscribers_only": false, "paid_subscribers_only_ends_at": "2024-02-23T16:23:46.908Z", "is_preview": false, "is_pinned": false, "notify_subscribers": false, "notifications_sent_at": "2023-08-28T21:56:09.233Z", "email_sent_to_count": 586220, "og_image_url": "", "og_description": ""} "422": {} articles:get: speakeasy-default-articles:get: @@ -1570,7 +1593,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "private", "user_id": "", "organization_id": "", "organization": {"created_at": "2022-04-09T17:04:24.706Z", "modified_at": "2023-09-05T11:33:52.010Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Little, Simonis and Lebsack", "blog": "", "location": "", "email": "Waino_Streich@gmail.com", "twitter_username": "", "pledge_minimum_amount": 450824, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 262795, "donations_enabled": false}, "published_at": "2022-08-22T22:47:10.338Z", "paid_subscribers_only": true, "paid_subscribers_only_ends_at": "2024-10-24T02:41:21.565Z", "is_preview": false, "is_pinned": false, "notify_subscribers": true, "notifications_sent_at": "2024-05-28T07:17:56.701Z", "email_sent_to_count": 739014, "og_image_url": "", "og_description": ""} + application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "private", "user_id": "", "organization_id": "", "organization": {"created_at": "2022-04-09T17:04:24.706Z", "modified_at": "2023-09-05T11:33:52.010Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Little, Simonis and Lebsack", "blog": "", "location": "", "email": "Waino_Streich@gmail.com", "twitter_username": "", "pledge_minimum_amount": 450824, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 262795}, "published_at": "2022-08-22T22:47:10.338Z", "paid_subscribers_only": true, "paid_subscribers_only_ends_at": "2024-10-24T02:41:21.565Z", "is_preview": false, "is_pinned": false, "notify_subscribers": true, "notifications_sent_at": "2024-05-28T07:17:56.701Z", "email_sent_to_count": 739014, "og_image_url": "", "og_description": ""} "404": application/json: {"detail": ""} "422": {} @@ -1581,7 +1604,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "private", "user_id": "", "organization_id": "", "organization": {"created_at": "2022-01-27T21:53:39.052Z", "modified_at": "2023-10-17T10:52:42.269Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Hegmann LLC", "blog": "", "location": "", "email": "Don.Murazik44@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 984008, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 54062, "donations_enabled": true}, "published_at": "2024-09-09T13:32:29.292Z", "paid_subscribers_only": true, "paid_subscribers_only_ends_at": "2023-05-05T18:16:41.139Z", "is_preview": false, "is_pinned": true, "notify_subscribers": false, "notifications_sent_at": "2022-10-01T09:16:10.269Z", "email_sent_to_count": 366807, "og_image_url": "", "og_description": ""} + application/json: {"id": "", "slug": "", "title": "", "body": "", "byline": {"name": "", "avatar_url": ""}, "visibility": "private", "user_id": "", "organization_id": "", "organization": {"created_at": "2022-01-27T21:53:39.052Z", "modified_at": "2023-10-17T10:52:42.269Z", "id": "", "name": "", "slug": "", "avatar_url": "", "bio": "", "company": "Hegmann LLC", "blog": "", "location": "", "email": "Don.Murazik44@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 984008, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 54062}, "published_at": "2024-09-09T13:32:29.292Z", "paid_subscribers_only": true, "paid_subscribers_only_ends_at": "2023-05-05T18:16:41.139Z", "is_preview": false, "is_pinned": true, "notify_subscribers": false, "notifications_sent_at": "2022-10-01T09:16:10.269Z", "email_sent_to_count": 366807, "og_image_url": "", "og_description": ""} "403": application/json: {"detail": ""} "404": @@ -1797,7 +1820,7 @@ examples: application/json: {"name": "", "prices": [{"recurring_interval": "month"}]} responses: "201": - application/json: {"created_at": "2023-12-01T17:06:07.793Z", "modified_at": "2024-07-30T16:43:31.437Z", "id": "", "name": "", "description": "Inverse discrete benchmark", "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "attached_custom_fields": []} + application/json: {"created_at": "2023-12-01T17:06:07.793Z", "modified_at": "2024-07-30T16:43:31.437Z", "id": "", "name": "", "description": "Inverse discrete benchmark", "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [], "benefits": [], "medias": [], "attached_custom_fields": []} "422": {} products:get: speakeasy-default-products:get: @@ -1806,7 +1829,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "name": "", "description": "Optional static intranet", "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-09-05T11:33:52.011Z", "modified_at": "2023-08-20T11:11:04.610Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}, {"value": "", "label": ""}, {"value": "", "label": ""}]}}, "order": 458049, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-05-10T02:28:23.533Z", "modified_at": "2022-10-16T00:34:27.106Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 801373, "required": true}]} + application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "name": "", "description": "Optional static intranet", "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 544221, "key1": 969961}, "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-05-10T02:28:23.533Z", "modified_at": "2022-10-16T00:34:27.106Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 458049, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-04-26T04:53:50.189Z", "modified_at": "2024-05-28T07:17:57.134Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 801373, "required": true}]} "404": application/json: {"detail": ""} "422": {} @@ -1817,7 +1840,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "name": "", "description": "Persistent 24/7 focus group", "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-10-17T10:52:42.015Z", "modified_at": "2023-01-13T16:52:57.274Z", "id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 488852, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-06-20T18:46:17.643Z", "modified_at": "2024-12-14T11:19:45.098Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}, {"value": "", "label": ""}, {"value": "", "label": ""}]}}, "order": 249440, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2022-12-08T09:52:54.805Z", "modified_at": "2022-10-01T09:16:09.932Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 693508, "required": true}]} + application/json: {"created_at": "2024-07-28T19:04:48.900Z", "modified_at": "2022-01-27T21:53:39.052Z", "id": "", "name": "", "description": "Persistent 24/7 focus group", "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": 344620, "key1": false, "key2": 984008}, "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-09-09T13:32:29.600Z", "modified_at": "2023-05-05T18:16:40.936Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 488852, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-05-15T01:05:20.251Z", "modified_at": "2024-09-02T06:16:41.919Z", "id": "", "metadata": {"key": 771203}, "slug": "", "name": "", "organization_id": ""}, "order": 249440, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-03-20T01:46:46.018Z", "modified_at": "2022-02-07T05:49:27.174Z", "id": "", "metadata": {"key": true, "key1": 111158, "key2": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}]}}, "order": 693508, "required": true}]} "403": application/json: {"detail": ""} "404": @@ -1832,7 +1855,7 @@ examples: application/json: {"benefits": []} responses: "200": - application/json: {"created_at": "2023-02-17T23:13:10.706Z", "modified_at": "2024-10-03T16:30:23.323Z", "id": "", "name": "", "description": "Intuitive object-oriented parallelism", "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-03-21T10:54:06.081Z", "modified_at": "2024-03-05T13:29:26.777Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 176757, "required": false}]} + application/json: {"created_at": "2023-02-17T23:13:10.706Z", "modified_at": "2024-10-03T16:30:23.323Z", "id": "", "name": "", "description": "Intuitive object-oriented parallelism", "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 724966}, "prices": [], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-02-02T20:10:57.575Z", "modified_at": "2022-07-13T17:24:47.759Z", "id": "", "metadata": {"key": false, "key1": "", "key2": false}, "slug": "", "name": "", "organization_id": ""}, "order": 176757, "required": false}]} "403": application/json: {"detail": ""} "404": @@ -1998,7 +2021,7 @@ examples: speakeasy-default-checkouts:custom:list: responses: "200": - application/json: {"items": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "status": "open", "client_secret": "", "url": "https://average-fedora.org/", "expires_at": "2022-09-09T18:28:08.953Z", "success_url": "https://primary-paintwork.com/", "embed_origin": "", "amount": 718303, "tax_amount": 86140, "currency": "Convertible Marks", "total_amount": 687960, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Adam7@yahoo.com", "customer_ip_address": "", "customer_billing_address": {"country": "Mauritius"}, "customer_tax_id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "product": {"created_at": "2024-04-22T08:39:55.981Z", "modified_at": "2023-08-23T19:26:20.850Z", "id": "", "name": "", "description": "mmm avalanche jungle unto meanwhile beside tromp worth", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "description": "bob inwardly beautifully comparison", "selectable": true, "deletable": false, "organization_id": "", "properties": {"paid_articles": true}}, {"created_at": "2023-02-10T20:11:51.410Z", "modified_at": "2023-05-17T08:33:13.471Z", "id": "", "type": "articles", "description": "commonly softly boo massive sorrowful aw strict behind along energetic", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2023-04-12T03:59:08.538Z", "modified_at": "2023-04-20T11:47:41.889Z", "id": "", "type": "discord", "description": "cleverly blossom defiantly", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/private/var", "mime_type": "", "size": 704478, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-05-27T06:03:00.110Z", "version": "", "is_uploaded": false, "created_at": "2024-01-10T05:13:52.456Z", "size_readable": "", "public_url": "https://jam-packed-median.net/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 186930, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2022-03-11T17:32:08.709Z", "version": "", "is_uploaded": false, "created_at": "2022-12-07T09:46:44.632Z", "size_readable": "", "public_url": "https://hateful-linseed.info"}, {"id": "", "organization_id": "", "name": "", "path": "/dev", "mime_type": "", "size": 694688, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2022-08-19T17:38:55.606Z", "version": "", "is_uploaded": false, "created_at": "2024-10-13T14:46:57.561Z", "size_readable": "", "public_url": "https://left-exterior.biz/"}]}, "product_price": {"created_at": "2023-04-20T11:47:41.889Z", "modified_at": "2023-06-11T18:07:18.321Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 523875, "maximum_amount": 841031, "preset_amount": 410206, "recurring_interval": "year"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-03-06T16:40:09.484Z", "modified_at": "2022-05-05T09:08:16.530Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 33597, "required": false}]}, {"created_at": "2022-01-21T00:48:05.986Z", "modified_at": "2024-09-10T07:49:25.657Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://practical-trick.org/", "expires_at": "2024-09-28T03:47:03.515Z", "success_url": "https://blue-technologist.com/", "embed_origin": "", "amount": 460276, "tax_amount": 425334, "currency": "Kenyan Shilling", "total_amount": 480616, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Roman.Stracke39@yahoo.com", "customer_ip_address": "", "customer_billing_address": {"country": "China"}, "customer_tax_id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "product": {"created_at": "2023-12-15T18:53:29.970Z", "modified_at": "2023-10-06T17:09:46.559Z", "id": "", "name": "", "description": "soap cheerfully distinction range", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-11-20T09:41:40.649Z", "modified_at": "2024-10-21T17:10:37.357Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "price_amount": 84189}, {"created_at": "2024-07-08T11:13:00.198Z", "modified_at": "2024-06-14T00:49:25.662Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 81309, "maximum_amount": 164965, "preset_amount": 73973}, {"created_at": "2022-06-05T08:58:03.644Z", "modified_at": "2023-12-29T19:56:44.465Z", "id": "", "is_archived": true, "product_id": ""}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/src", "mime_type": "", "size": 88338, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-06-07T09:30:51.196Z", "version": "", "is_uploaded": false, "created_at": "2024-10-06T07:08:41.329Z", "size_readable": "", "public_url": "https://damaged-tapioca.com"}, {"id": "", "organization_id": "", "name": "", "path": "/root", "mime_type": "", "size": 387926, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-05T10:11:23.447Z", "version": "", "is_uploaded": true, "created_at": "2024-05-23T21:54:30.697Z", "size_readable": "", "public_url": "https://favorite-digit.biz"}]}, "product_price": {"created_at": "2022-03-15T10:11:56.132Z", "modified_at": "2022-03-08T17:05:22.411Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 993305, "maximum_amount": 747562, "preset_amount": 258945}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2022-04-16T23:50:27.729Z", "modified_at": "2024-01-14T06:48:49.446Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 810770, "required": false}]}, {"created_at": "2022-04-03T06:30:19.876Z", "modified_at": "2024-01-30T10:30:11.361Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://bustling-plastic.info/", "expires_at": "2024-07-08T11:13:00.198Z", "success_url": "https://yummy-birdcage.com", "embed_origin": "", "amount": 73973, "tax_amount": 836788, "currency": "Leone", "total_amount": 141764, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Oswald29@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Saint Helena"}, "customer_tax_id": "", "metadata": {"key": ""}, "product": {"created_at": "2022-04-29T02:27:27.855Z", "modified_at": "2024-09-02T23:08:00.186Z", "id": "", "name": "", "description": "frenetically from yuck failing consign tedious scar failing unknown in", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2024-11-14T19:49:34.065Z", "modified_at": "2024-05-02T01:42:40.060Z", "id": "", "is_archived": false, "product_id": "", "recurring_interval": "year"}], "benefits": [{"created_at": "2022-01-23T14:15:37.576Z", "modified_at": "2023-05-28T16:21:14.723Z", "id": "", "description": "eek censor tenement commonly softly boo massive sorrowful aw strict", "selectable": false, "deletable": false, "organization_id": "", "properties": {"paid_articles": true}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/dev", "mime_type": "", "size": 679829, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-04-24T19:54:59.989Z", "version": "", "is_uploaded": false, "created_at": "2023-08-01T10:27:50.144Z", "size_readable": "", "public_url": "https://plump-markup.net"}]}, "product_price": {"created_at": "2024-07-20T01:34:08.268Z", "modified_at": "2022-11-06T04:06:54.106Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-06-29T11:50:30.649Z", "modified_at": "2022-01-22T06:34:12.791Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 282091, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-06-01T09:15:34.681Z", "modified_at": "2024-05-23T16:01:48.733Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 634941, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-07-24T23:46:23.843Z", "modified_at": "2024-09-09T09:50:03.003Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 520064, "required": false}]}], "pagination": {"total_count": 5229, "max_page": 810770}} + application/json: {"items": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "status": "open", "client_secret": "", "url": "https://average-fedora.org/", "expires_at": "2022-09-09T18:28:08.953Z", "success_url": "https://primary-paintwork.com/", "embed_origin": "", "amount": 718303, "tax_amount": 86140, "currency": "Convertible Marks", "total_amount": 687960, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Adam7@yahoo.com", "customer_ip_address": "", "customer_billing_address": {"country": "Mauritius"}, "customer_tax_id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "product": {"created_at": "2024-04-22T08:39:55.981Z", "modified_at": "2023-08-23T19:26:20.850Z", "id": "", "name": "", "description": "mmm avalanche jungle unto meanwhile beside tromp worth", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "description": "bob inwardly beautifully comparison", "selectable": true, "deletable": false, "organization_id": "", "properties": {"paid_articles": true}}, {"created_at": "2023-02-10T20:11:51.410Z", "modified_at": "2023-05-17T08:33:13.471Z", "id": "", "type": "articles", "description": "commonly softly boo massive sorrowful aw strict behind along energetic", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2023-04-12T03:59:08.538Z", "modified_at": "2023-04-20T11:47:41.889Z", "id": "", "type": "discord", "description": "cleverly blossom defiantly", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/private/var", "mime_type": "", "size": 704478, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-05-27T06:03:00.110Z", "version": "", "is_uploaded": false, "created_at": "2024-01-10T05:13:52.456Z", "size_readable": "", "public_url": "https://jam-packed-median.net/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 186930, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2022-03-11T17:32:08.709Z", "version": "", "is_uploaded": false, "created_at": "2022-12-07T09:46:44.632Z", "size_readable": "", "public_url": "https://hateful-linseed.info"}, {"id": "", "organization_id": "", "name": "", "path": "/dev", "mime_type": "", "size": 694688, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2022-08-19T17:38:55.606Z", "version": "", "is_uploaded": false, "created_at": "2024-10-13T14:46:57.561Z", "size_readable": "", "public_url": "https://left-exterior.biz/"}]}, "product_price": {"created_at": "2023-04-20T11:47:41.889Z", "modified_at": "2023-06-11T18:07:18.321Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 523875, "maximum_amount": 841031, "preset_amount": 410206, "recurring_interval": "year"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-03-06T16:40:09.484Z", "modified_at": "2022-05-05T09:08:16.530Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 33597, "required": false}]}, {"created_at": "2022-01-21T00:48:05.986Z", "modified_at": "2024-09-10T07:49:25.657Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://practical-trick.org/", "expires_at": "2024-09-28T03:47:03.515Z", "success_url": "https://blue-technologist.com/", "embed_origin": "", "amount": 460276, "tax_amount": 425334, "currency": "Kenyan Shilling", "total_amount": 480616, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Roman.Stracke39@yahoo.com", "customer_ip_address": "", "customer_billing_address": {"country": "China"}, "customer_tax_id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "product": {"created_at": "2023-12-15T18:53:29.970Z", "modified_at": "2023-10-06T17:09:46.559Z", "id": "", "name": "", "description": "soap cheerfully distinction range", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-11-20T09:41:40.649Z", "modified_at": "2024-10-21T17:10:37.357Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "price_amount": 84189}, {"created_at": "2024-07-08T11:13:00.198Z", "modified_at": "2024-06-14T00:49:25.662Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 81309, "maximum_amount": 164965, "preset_amount": 73973}, {"created_at": "2022-06-05T08:58:03.644Z", "modified_at": "2023-12-29T19:56:44.465Z", "id": "", "is_archived": true, "product_id": ""}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/src", "mime_type": "", "size": 88338, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-06-07T09:30:51.196Z", "version": "", "is_uploaded": false, "created_at": "2024-10-06T07:08:41.329Z", "size_readable": "", "public_url": "https://damaged-tapioca.com"}, {"id": "", "organization_id": "", "name": "", "path": "/root", "mime_type": "", "size": 387926, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-05T10:11:23.447Z", "version": "", "is_uploaded": true, "created_at": "2024-05-23T21:54:30.697Z", "size_readable": "", "public_url": "https://favorite-digit.biz"}]}, "product_price": {"created_at": "2022-03-15T10:11:56.132Z", "modified_at": "2022-03-08T17:05:22.411Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 993305, "maximum_amount": 747562, "preset_amount": 258945}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2022-04-16T23:50:27.729Z", "modified_at": "2024-01-14T06:48:49.446Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 810770, "required": false}]}, {"created_at": "2022-04-03T06:30:19.876Z", "modified_at": "2024-01-30T10:30:11.361Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://bustling-plastic.info/", "expires_at": "2024-07-08T11:13:00.198Z", "success_url": "https://yummy-birdcage.com", "embed_origin": "", "amount": 73973, "tax_amount": 836788, "currency": "Leone", "total_amount": 141764, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Oswald29@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Saint Helena"}, "customer_tax_id": "", "metadata": {"key": ""}, "product": {"created_at": "2022-04-29T02:27:27.855Z", "modified_at": "2024-09-02T23:08:00.186Z", "id": "", "name": "", "description": "frenetically from yuck failing consign tedious scar failing unknown in", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2024-05-02T01:42:40.060Z", "modified_at": "2023-07-09T07:59:15.466Z", "id": "", "is_archived": false, "product_id": ""}], "benefits": [{"created_at": "2022-01-23T14:15:37.576Z", "modified_at": "2023-05-28T16:21:14.723Z", "id": "", "description": "eek censor tenement commonly softly boo massive sorrowful aw strict", "selectable": false, "deletable": false, "organization_id": "", "properties": {"paid_articles": true}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/dev", "mime_type": "", "size": 679829, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-04-24T19:54:59.989Z", "version": "", "is_uploaded": false, "created_at": "2023-08-01T10:27:50.144Z", "size_readable": "", "public_url": "https://plump-markup.net"}]}, "product_price": {"created_at": "2024-07-20T01:34:08.268Z", "modified_at": "2022-11-06T04:06:54.106Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-06-29T11:50:30.649Z", "modified_at": "2022-01-22T06:34:12.791Z", "id": "", "metadata": {"key": "", "key1": 797143}, "slug": "", "name": "", "organization_id": ""}, "order": 282091, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-05-03T02:57:15.201Z", "modified_at": "2023-07-24T23:46:23.843Z", "id": "", "metadata": {"key": "", "key1": "", "key2": 633721}, "slug": "", "name": "", "organization_id": ""}, "order": 634941, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2024-10-04T22:19:43.532Z", "modified_at": "2024-05-17T20:40:45.053Z", "id": "", "metadata": {"key": 580639, "key1": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 520064, "required": false}]}], "pagination": {"total_count": 5229, "max_page": 810770}} "422": {} checkouts:custom:create: speakeasy-default-checkouts:custom:create: @@ -2015,7 +2038,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://glossy-concentration.biz/", "expires_at": "2023-07-26T06:33:15.810Z", "success_url": "https://lavish-ice-cream.biz", "embed_origin": "", "amount": 213457, "tax_amount": 937146, "currency": "Som", "total_amount": 801373, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Elyssa38@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Mozambique"}, "customer_tax_id": "", "metadata": {"key": "", "key1": ""}, "product": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "description": "tune only fellow scary but embarrassment metabolise", "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}, {"created_at": "2023-04-26T04:53:50.189Z", "modified_at": "2024-05-28T07:17:57.134Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}], "benefits": [{"created_at": "2022-04-14T16:04:46.468Z", "modified_at": "2023-08-29T15:06:35.685Z", "id": "", "type": "downloadables", "description": "disapprove glum ugh roundabout middle ha", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2022-04-14T16:04:46.468Z", "modified_at": "2023-08-29T15:06:35.685Z", "id": "", "type": "downloadables", "description": "disapprove glum ugh roundabout middle ha", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2023-08-29T15:06:35.685Z", "modified_at": "2024-06-02T05:45:06.910Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 746585, "recurring_interval": "year"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2022-12-20T13:59:56.783Z", "modified_at": "2022-12-21T05:04:07.004Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 165215, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-05-05T04:00:06.053Z", "modified_at": "2022-11-08T07:25:39.944Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 292469, "required": false}]} + application/json: {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "status": "confirmed", "client_secret": "", "url": "https://glossy-concentration.biz/", "expires_at": "2023-07-26T06:33:15.810Z", "success_url": "https://lavish-ice-cream.biz", "embed_origin": "", "amount": 213457, "tax_amount": 937146, "currency": "Som", "total_amount": 801373, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Elyssa38@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Mozambique"}, "customer_tax_id": "", "metadata": {"key": "", "key1": ""}, "product": {"created_at": "2024-02-07T13:54:48.821Z", "modified_at": "2023-09-05T11:33:52.011Z", "id": "", "name": "", "description": "tune only fellow scary but embarrassment metabolise", "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-08-20T11:11:04.610Z", "modified_at": "2023-07-26T06:33:15.810Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 458049, "maximum_amount": 450824, "preset_amount": 262795}, {"created_at": "2023-04-26T04:53:50.189Z", "modified_at": "2024-05-28T07:17:57.134Z", "id": "", "is_archived": true, "product_id": "", "recurring_interval": "month"}], "benefits": [{"created_at": "2022-04-14T16:04:46.468Z", "modified_at": "2023-08-29T15:06:35.685Z", "id": "", "type": "downloadables", "description": "disapprove glum ugh roundabout middle ha", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2022-04-14T16:04:46.468Z", "modified_at": "2023-08-29T15:06:35.685Z", "id": "", "type": "downloadables", "description": "disapprove glum ugh roundabout middle ha", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2023-08-29T15:06:35.685Z", "modified_at": "2024-06-02T05:45:06.910Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 746585, "recurring_interval": "year"}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2022-12-20T13:59:56.783Z", "modified_at": "2022-12-21T05:04:07.004Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 165215, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-05-05T04:00:06.053Z", "modified_at": "2022-11-08T07:25:39.944Z", "id": "", "metadata": {"key": false, "key1": true}, "slug": "", "name": "", "organization_id": ""}, "order": 292469, "required": false}]} "404": application/json: {"detail": ""} "422": {} @@ -2037,7 +2060,7 @@ examples: client_secret: "" responses: "200": - application/json: {"created_at": "2022-06-23T19:45:02.115Z", "modified_at": "2022-11-26T05:04:17.930Z", "id": "", "status": "succeeded", "client_secret": "", "url": "https://lumpy-jellyfish.com", "expires_at": "2023-08-07T16:01:01.665Z", "success_url": "https://obedient-operating.org/", "embed_origin": "", "amount": 553902, "tax_amount": 201138, "currency": "Seychelles Rupee", "total_amount": 493334, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Coleman_Rutherford@hotmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Maldives"}, "customer_tax_id": "", "product": {"created_at": "2022-09-10T21:17:06.373Z", "modified_at": "2024-10-11T12:01:20.600Z", "id": "", "name": "", "description": "of grave parade whereas wherever", "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"created_at": "2022-11-26T05:04:17.930Z", "modified_at": "2024-04-14T21:02:40.457Z", "id": "", "type": "discord", "description": "given impolite how astride cap", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2024-07-23T16:17:04.686Z", "modified_at": "2024-10-15T01:25:33.429Z", "id": "", "type": "ads", "description": "definitive as fluffy", "selectable": false, "deletable": true, "organization_id": ""}, {"created_at": "2023-05-06T11:19:10.077Z", "modified_at": "2023-11-17T04:52:10.824Z", "id": "", "type": "downloadables", "description": "yum lecture against alienated meanwhile unabashedly", "selectable": true, "deletable": true, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-04-14T21:02:40.457Z", "modified_at": "2023-08-07T16:01:01.665Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 564186, "recurring_interval": "year"}, "organization": {"created_at": "2024-10-05T02:43:03.106Z", "modified_at": "2023-08-31T01:50:30.615Z", "id": "", "name": "", "slug": "", "avatar_url": "https://shy-kettledrum.name/", "bio": "", "company": "Douglas, Nolan and Rutherford", "blog": "", "location": "", "email": "Gregoria.Littel92@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 528457, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 944792, "donations_enabled": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-08-31T01:50:30.615Z", "modified_at": "2022-08-09T10:44:49.155Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 250741, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-12-13T09:34:37.808Z", "modified_at": "2024-06-16T05:48:00.853Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, "order": 113721, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-04-27T22:21:52.955Z", "modified_at": "2024-01-07T03:44:33.409Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}, {"value": "", "label": ""}]}}, "order": 241475, "required": true}]} + application/json: {"created_at": "2022-06-23T19:45:02.115Z", "modified_at": "2022-11-26T05:04:17.930Z", "id": "", "status": "succeeded", "client_secret": "", "url": "https://lumpy-jellyfish.com", "expires_at": "2023-08-07T16:01:01.665Z", "success_url": "https://obedient-operating.org/", "embed_origin": "", "amount": 553902, "tax_amount": 201138, "currency": "Seychelles Rupee", "total_amount": 493334, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Coleman_Rutherford@hotmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Maldives"}, "customer_tax_id": "", "product": {"created_at": "2022-09-10T21:17:06.373Z", "modified_at": "2024-10-11T12:01:20.600Z", "id": "", "name": "", "description": "of grave parade whereas wherever", "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"created_at": "2022-11-26T05:04:17.930Z", "modified_at": "2024-04-14T21:02:40.457Z", "id": "", "type": "discord", "description": "given impolite how astride cap", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2024-07-23T16:17:04.686Z", "modified_at": "2024-10-15T01:25:33.429Z", "id": "", "type": "ads", "description": "definitive as fluffy", "selectable": false, "deletable": true, "organization_id": ""}, {"created_at": "2023-05-06T11:19:10.077Z", "modified_at": "2023-11-17T04:52:10.824Z", "id": "", "type": "downloadables", "description": "yum lecture against alienated meanwhile unabashedly", "selectable": true, "deletable": true, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-04-14T21:02:40.457Z", "modified_at": "2023-08-07T16:01:01.665Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 564186, "recurring_interval": "year"}, "organization": {"created_at": "2024-10-05T02:43:03.106Z", "modified_at": "2023-08-31T01:50:30.615Z", "id": "", "name": "", "slug": "", "avatar_url": "https://shy-kettledrum.name/", "bio": "", "company": "Douglas, Nolan and Rutherford", "blog": "", "location": "", "email": "Gregoria.Littel92@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 528457, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 944792}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-08-31T01:50:30.615Z", "modified_at": "2022-08-09T10:44:49.155Z", "id": "", "metadata": {"key": 649087, "key1": true}, "slug": "", "name": "", "organization_id": ""}, "order": 250741, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-04-27T22:21:52.955Z", "modified_at": "2024-01-07T03:44:33.409Z", "id": "", "metadata": {"key": 542382}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}}, "order": 113721, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2022-12-09T12:49:04.135Z", "modified_at": "2023-08-03T04:31:36.942Z", "id": "", "metadata": {"key": true}, "slug": "", "name": "", "organization_id": ""}, "order": 241475, "required": true}]} "404": application/json: {"detail": ""} "422": {} @@ -2048,7 +2071,7 @@ examples: client_secret: "" responses: "200": - application/json: {"created_at": "2024-10-22T20:45:21.815Z", "modified_at": "2023-07-17T23:31:05.499Z", "id": "", "status": "expired", "client_secret": "", "url": "https://simple-flint.org/", "expires_at": "2023-07-14T01:44:24.320Z", "success_url": "https://passionate-understanding.com/", "embed_origin": "", "amount": 573767, "tax_amount": 903274, "currency": "Sudanese Pound", "total_amount": 813143, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Leonie50@hotmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Bulgaria"}, "customer_tax_id": "", "product": {"created_at": "2023-09-04T23:39:15.429Z", "modified_at": "2022-06-30T18:11:17.062Z", "id": "", "name": "", "description": "ack notwithstanding lively into trusty", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2022-11-16T20:51:18.745Z", "modified_at": "2023-07-14T01:44:24.320Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 597177, "maximum_amount": 947630, "preset_amount": 166401}, {"created_at": "2024-04-03T02:37:24.726Z", "modified_at": "2024-06-10T04:54:08.615Z", "id": "", "is_archived": true, "product_id": ""}, {"created_at": "2024-07-08T15:45:04.860Z", "modified_at": "2023-09-22T09:06:50.882Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 508864, "maximum_amount": 744619, "preset_amount": 137234}], "benefits": [{"created_at": "2024-04-13T01:40:05.694Z", "modified_at": "2024-07-12T13:33:11.703Z", "id": "", "type": "discord", "description": "prohibition where although negative where psst", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2022-11-01T16:37:11.315Z", "modified_at": "2024-11-11T09:22:51.554Z", "id": "", "type": "ads", "description": "anenst meanwhile little", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2023-12-08T07:51:27.800Z", "modified_at": "2022-03-18T21:13:49.993Z", "id": "", "type": "discord", "description": "long-term relative singe urgently questionably", "selectable": false, "deletable": true, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/share", "mime_type": "", "size": 389948, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-01-06T16:44:49.420Z", "version": "", "is_uploaded": false, "created_at": "2024-04-09T09:13:22.245Z", "size_readable": "", "public_url": "https://smoggy-graffiti.net/"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/obj", "mime_type": "", "size": 503125, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-06-27T13:22:35.587Z", "version": "", "is_uploaded": false, "created_at": "2022-06-08T06:40:16.558Z", "size_readable": "", "public_url": "https://lumbering-charlatan.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 126531, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-10-20T22:04:15.588Z", "version": "", "is_uploaded": false, "created_at": "2023-02-02T22:10:58.341Z", "size_readable": "", "public_url": "https://which-entry.biz/"}]}, "product_price": {"created_at": "2022-10-09T22:41:34.766Z", "modified_at": "2024-06-14T00:54:00.547Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 172495}, "organization": {"created_at": "2023-07-15T16:51:46.519Z", "modified_at": "2023-07-18T07:58:43.752Z", "id": "", "name": "", "slug": "", "avatar_url": "https://squiggly-conservative.name/", "bio": "", "company": "Parker - Funk", "blog": "", "location": "", "email": "Lelia.Lind1@yahoo.com", "twitter_username": "", "pledge_minimum_amount": 359631, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 600341, "donations_enabled": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-07-18T07:58:43.752Z", "modified_at": "2022-01-25T05:31:14.324Z", "id": "", "metadata": {"key": "", "key1": "", "key2": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 278568, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-12-25T03:42:50.687Z", "modified_at": "2022-11-13T10:59:03.173Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 873793, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-11-27T07:00:49.297Z", "modified_at": "2023-10-26T18:06:03.198Z", "id": "", "metadata": {"key": ""}, "slug": "", "name": "", "organization_id": ""}, "order": 458158, "required": true}]} + application/json: {"created_at": "2024-10-22T20:45:21.815Z", "modified_at": "2023-07-17T23:31:05.499Z", "id": "", "status": "expired", "client_secret": "", "url": "https://simple-flint.org/", "expires_at": "2023-07-14T01:44:24.320Z", "success_url": "https://passionate-understanding.com/", "embed_origin": "", "amount": 573767, "tax_amount": 903274, "currency": "Sudanese Pound", "total_amount": 813143, "product_id": "", "product_price_id": "", "is_payment_required": true, "customer_id": "", "customer_name": "", "customer_email": "Leonie50@hotmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Bulgaria"}, "customer_tax_id": "", "product": {"created_at": "2023-09-04T23:39:15.429Z", "modified_at": "2022-06-30T18:11:17.062Z", "id": "", "name": "", "description": "ack notwithstanding lively into trusty", "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2022-11-16T20:51:18.745Z", "modified_at": "2023-07-14T01:44:24.320Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 597177, "maximum_amount": 947630, "preset_amount": 166401}, {"created_at": "2024-04-03T02:37:24.726Z", "modified_at": "2024-06-10T04:54:08.615Z", "id": "", "is_archived": true, "product_id": ""}, {"created_at": "2024-07-08T15:45:04.860Z", "modified_at": "2023-09-22T09:06:50.882Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "minimum_amount": 508864, "maximum_amount": 744619, "preset_amount": 137234}], "benefits": [{"created_at": "2024-04-13T01:40:05.694Z", "modified_at": "2024-07-12T13:33:11.703Z", "id": "", "type": "discord", "description": "prohibition where although negative where psst", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2022-11-01T16:37:11.315Z", "modified_at": "2024-11-11T09:22:51.554Z", "id": "", "type": "ads", "description": "anenst meanwhile little", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2023-12-08T07:51:27.800Z", "modified_at": "2022-03-18T21:13:49.993Z", "id": "", "type": "discord", "description": "long-term relative singe urgently questionably", "selectable": false, "deletable": true, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/share", "mime_type": "", "size": 389948, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-01-06T16:44:49.420Z", "version": "", "is_uploaded": false, "created_at": "2024-04-09T09:13:22.245Z", "size_readable": "", "public_url": "https://smoggy-graffiti.net/"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/obj", "mime_type": "", "size": 503125, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-06-27T13:22:35.587Z", "version": "", "is_uploaded": false, "created_at": "2022-06-08T06:40:16.558Z", "size_readable": "", "public_url": "https://lumbering-charlatan.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 126531, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-10-20T22:04:15.588Z", "version": "", "is_uploaded": false, "created_at": "2023-02-02T22:10:58.341Z", "size_readable": "", "public_url": "https://which-entry.biz/"}]}, "product_price": {"created_at": "2022-10-09T22:41:34.766Z", "modified_at": "2024-06-14T00:54:00.547Z", "id": "", "is_archived": true, "product_id": "", "price_currency": "", "price_amount": 172495}, "organization": {"created_at": "2023-07-15T16:51:46.519Z", "modified_at": "2023-07-18T07:58:43.752Z", "id": "", "name": "", "slug": "", "avatar_url": "https://squiggly-conservative.name/", "bio": "", "company": "Parker - Funk", "blog": "", "location": "", "email": "Lelia.Lind1@yahoo.com", "twitter_username": "", "pledge_minimum_amount": 359631, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 600341}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-07-18T07:58:43.752Z", "modified_at": "2022-01-25T05:31:14.324Z", "id": "", "metadata": {"key": "", "key1": 288739, "key2": true}, "slug": "", "name": "", "organization_id": ""}, "order": 278568, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-10-26T18:06:03.198Z", "modified_at": "2023-04-17T00:02:14.300Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}}, "order": 873793, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-05-05T04:20:49.023Z", "modified_at": "2023-10-20T23:21:29.133Z", "id": "", "metadata": {"key": false}, "slug": "", "name": "", "organization_id": ""}, "order": 458158, "required": true}]} "404": application/json: {"detail": ""} "422": {} @@ -2059,7 +2082,7 @@ examples: client_secret: "" responses: "200": - application/json: {"created_at": "2024-09-27T22:33:04.250Z", "modified_at": "2024-07-24T02:45:26.067Z", "id": "", "status": "succeeded", "client_secret": "", "url": "https://apt-devastation.biz/", "expires_at": "2022-07-30T06:29:51.767Z", "success_url": "https://secondary-gallery.net", "embed_origin": "", "amount": 662896, "tax_amount": 131007, "currency": "Nepalese Rupee", "total_amount": 714568, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Maggie18@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Nigeria"}, "customer_tax_id": "", "product": {"created_at": "2023-01-28T03:25:59.665Z", "modified_at": "2022-01-24T16:41:51.515Z", "id": "", "name": "", "description": "potentially thread toady subsidy probable motionless obedience clear-cut", "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-11-15T07:38:37.445Z", "modified_at": "2022-07-30T06:29:51.767Z", "id": "", "is_archived": false, "product_id": ""}], "benefits": [{"created_at": "2022-10-20T16:59:20.255Z", "modified_at": "2023-01-30T20:43:56.426Z", "id": "", "type": "articles", "description": "editor until ah daintily oof aw tarry impanel", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2024-07-26T21:52:00.436Z", "modified_at": "2024-03-11T23:49:19.061Z", "id": "", "type": "license_keys", "description": "forenenst aw or distorted legal cycle posh off", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2023-02-11T02:25:13.433Z", "modified_at": "2024-01-07T19:25:42.663Z", "id": "", "description": "hovel yuck absentmindedly oh anti joyous psst tender", "selectable": false, "deletable": true, "organization_id": "", "properties": {"paid_articles": true}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/mnt", "mime_type": "", "size": 249646, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-06-10T13:10:48.480Z", "version": "", "is_uploaded": true, "created_at": "2022-02-28T04:49:04.106Z", "size_readable": "", "public_url": "https://glittering-confusion.biz/"}]}, "product_price": {"created_at": "2023-01-06T21:00:26.752Z", "modified_at": "2022-10-07T14:51:36.263Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 638939, "maximum_amount": 942266, "preset_amount": 508098}, "organization": {"created_at": "2024-01-09T08:11:20.495Z", "modified_at": "2024-08-15T01:27:14.128Z", "id": "", "name": "", "slug": "", "avatar_url": "https://clear-cut-deer.net", "bio": "", "company": "Hauck Inc", "blog": "", "location": "", "email": "Janae.Hirthe@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 851973, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 267069, "donations_enabled": true}, "attached_custom_fields": []} + application/json: {"created_at": "2024-09-27T22:33:04.250Z", "modified_at": "2024-07-24T02:45:26.067Z", "id": "", "status": "succeeded", "client_secret": "", "url": "https://apt-devastation.biz/", "expires_at": "2022-07-30T06:29:51.767Z", "success_url": "https://secondary-gallery.net", "embed_origin": "", "amount": 662896, "tax_amount": 131007, "currency": "Nepalese Rupee", "total_amount": 714568, "product_id": "", "product_price_id": "", "is_payment_required": false, "customer_id": "", "customer_name": "", "customer_email": "Maggie18@gmail.com", "customer_ip_address": "", "customer_billing_address": {"country": "Nigeria"}, "customer_tax_id": "", "product": {"created_at": "2023-01-28T03:25:59.665Z", "modified_at": "2022-01-24T16:41:51.515Z", "id": "", "name": "", "description": "potentially thread toady subsidy probable motionless obedience clear-cut", "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-11-15T07:38:37.445Z", "modified_at": "2022-07-30T06:29:51.767Z", "id": "", "is_archived": false, "product_id": ""}], "benefits": [{"created_at": "2022-10-20T16:59:20.255Z", "modified_at": "2023-01-30T20:43:56.426Z", "id": "", "type": "articles", "description": "editor until ah daintily oof aw tarry impanel", "selectable": false, "deletable": false, "organization_id": ""}, {"created_at": "2024-07-26T21:52:00.436Z", "modified_at": "2024-03-11T23:49:19.061Z", "id": "", "type": "license_keys", "description": "forenenst aw or distorted legal cycle posh off", "selectable": true, "deletable": false, "organization_id": ""}, {"created_at": "2023-02-11T02:25:13.433Z", "modified_at": "2024-01-07T19:25:42.663Z", "id": "", "description": "hovel yuck absentmindedly oh anti joyous psst tender", "selectable": false, "deletable": true, "organization_id": "", "properties": {"paid_articles": true}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/mnt", "mime_type": "", "size": 249646, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-06-10T13:10:48.480Z", "version": "", "is_uploaded": true, "created_at": "2022-02-28T04:49:04.106Z", "size_readable": "", "public_url": "https://glittering-confusion.biz/"}]}, "product_price": {"created_at": "2023-01-06T21:00:26.752Z", "modified_at": "2022-10-07T14:51:36.263Z", "id": "", "is_archived": false, "product_id": "", "price_currency": "", "minimum_amount": 638939, "maximum_amount": 942266, "preset_amount": 508098}, "organization": {"created_at": "2024-01-09T08:11:20.495Z", "modified_at": "2024-08-15T01:27:14.128Z", "id": "", "name": "", "slug": "", "avatar_url": "https://clear-cut-deer.net", "bio": "", "company": "Hauck Inc", "blog": "", "location": "", "email": "Janae.Hirthe@hotmail.com", "twitter_username": "", "pledge_minimum_amount": 851973, "pledge_badge_show_amount": true, "default_upfront_split_to_contributors": 267069}, "attached_custom_fields": []} "404": application/json: {"detail": ""} "422": {} @@ -2121,7 +2144,7 @@ examples: speakeasy-default-custom-fields:list: responses: "200": - application/json: {"items": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}}, {"created_at": "2023-11-28T13:02:27.296Z", "modified_at": "2023-12-02T18:25:37.169Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, {"created_at": "2022-04-05T09:49:38.010Z", "modified_at": "2022-03-17T01:57:00.187Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}, {"value": "", "label": ""}]}}], "pagination": {"total_count": 633911, "max_page": 7468}} + application/json: {"items": [{"created_at": "2023-08-23T19:26:20.850Z", "modified_at": "2024-01-14T10:26:00.433Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}}, {"created_at": "2023-11-28T13:02:27.296Z", "modified_at": "2023-12-02T18:25:37.169Z", "id": "", "metadata": {}, "slug": "", "name": "", "organization_id": ""}, {"created_at": "2022-04-05T09:49:38.010Z", "modified_at": "2022-03-17T01:57:00.187Z", "id": "", "metadata": {"key": 633911, "key1": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}}], "pagination": {"total_count": 633911, "max_page": 7468}} "422": {} custom-fields:create: speakeasy-default-custom-fields:create: @@ -2138,7 +2161,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-09-05T11:33:52.011Z", "modified_at": "2023-08-20T11:11:04.610Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": "", "properties": {"options": [{"value": "", "label": ""}, {"value": "", "label": ""}, {"value": "", "label": ""}]}} + application/json: {"created_at": "2023-09-05T11:33:52.011Z", "modified_at": "2023-08-20T11:11:04.610Z", "id": "", "metadata": {"key": true, "key1": 262795}, "slug": "", "name": "", "organization_id": "", "properties": {"options": []}} "404": application/json: {"detail": ""} "422": {} @@ -2149,7 +2172,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-01-13T16:52:57.274Z", "modified_at": "2024-12-22T15:27:45.882Z", "id": "", "metadata": {"key": "", "key1": ""}, "slug": "", "name": "", "organization_id": ""} + application/json: {"created_at": "2023-01-13T16:52:57.274Z", "modified_at": "2024-12-22T15:27:45.882Z", "id": "", "metadata": {"key": 984008, "key1": ""}, "slug": "", "name": "", "organization_id": ""} "404": application/json: {"detail": ""} "422": {} @@ -2162,3 +2185,8 @@ examples: "404": application/json: {"detail": ""} "422": {} + oauth2:authorize: + speakeasy-default-oauth2-:authorize: + responses: + "200": + application/json: {"client": {"created_at": "2022-05-14T00:33:15.801Z", "modified_at": "2022-01-08T10:23:26.945Z", "client_id": "", "client_name": "", "client_uri": "https://thrifty-excess.biz/", "logo_uri": "https://zany-morbidity.info/", "tos_uri": "https://noted-digit.com/", "policy_uri": "https://that-airmail.info"}, "sub": {"id": "", "email": "Frederic48@hotmail.com", "avatar_url": "https://burdensome-institute.info"}, "scopes": ["user:benefits:read", "checkouts:write"]} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 6dffc310..87691bc5 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -16,7 +16,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false typescript: - version: 0.15.1 + version: 0.16.0 additionalDependencies: dependencies: {} devDependencies: {} @@ -24,6 +24,7 @@ typescript: additionalPackageJSON: {} author: Speakeasy clientServerStatusCodesAsErrors: true + defaultErrorName: SDKError enumFormat: union envVarPrefix: POLAR flattenGlobalSecurity: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 987f5c10..dc3d79e5 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.431.0 +speakeasyVersion: 1.438.1 sources: Polar-OAS: sourceNamespace: polar-oas - sourceRevisionDigest: sha256:f42da804fd4b2c4d782ed454d174adb8316fdc986e50245ae703e445020b1b76 - sourceBlobDigest: sha256:0e4a2d08c7f1223110e726f0037614363ba877289fef1c97a1a12fd3d5a7dc59 + sourceRevisionDigest: sha256:4df6842813b1d54baedbb25f874738d0e3c669760833f3b457579ba69a12a8e4 + sourceBlobDigest: sha256:0f5b5388af51c8cea34904ea7acce013ecca69a2afb75886d9f134e135a365bd tags: - latest - main @@ -11,8 +11,10 @@ targets: polar: source: Polar-OAS sourceNamespace: polar-oas - sourceRevisionDigest: sha256:f42da804fd4b2c4d782ed454d174adb8316fdc986e50245ae703e445020b1b76 - sourceBlobDigest: sha256:0e4a2d08c7f1223110e726f0037614363ba877289fef1c97a1a12fd3d5a7dc59 + sourceRevisionDigest: sha256:4df6842813b1d54baedbb25f874738d0e3c669760833f3b457579ba69a12a8e4 + sourceBlobDigest: sha256:0f5b5388af51c8cea34904ea7acce013ecca69a2afb75886d9f134e135a365bd + codeSamplesNamespace: polar-oas-code-samples + codeSamplesRevisionDigest: sha256:75cc7be78a96633fb0659d25db90c457df8c0fac82a428524a1fadb33d3a8699 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest @@ -24,6 +26,7 @@ workflow: - location: https://raw.githubusercontent.com/polarsource/polar/main/sdk/overlays/security.yml - location: https://raw.githubusercontent.com/polarsource/polar/main/sdk/overlays/type_parameter.yml - location: https://raw.githubusercontent.com/polarsource/polar/main/sdk/overlays/product_price_discriminator.yml + - location: https://raw.githubusercontent.com/polarsource/polar/main/sdk/overlays/read_only.yml registry: location: registry.speakeasyapi.dev/polar/polar/polar-oas targets: @@ -35,3 +38,5 @@ workflow: token: $npm_token codeSamples: output: codeSamples.yaml + registry: + location: registry.speakeasyapi.dev/polar/polar/polar-oas-code-samples diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index b6451bca..4509a004 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -20,3 +20,5 @@ targets: token: $npm_token codeSamples: output: codeSamples.yaml + registry: + location: registry.speakeasyapi.dev/polar/polar/polar-oas-code-samples diff --git a/README.md b/README.md index e3fb3b2d..3ba50c2a 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,7 @@ run(); ### [oauth2](docs/sdks/oauth2/README.md) +* [authorize](docs/sdks/oauth2/README.md#authorize) - Authorize * [token](docs/sdks/oauth2/README.md#token) - Request Token * [revoke](docs/sdks/oauth2/README.md#revoke) - Revoke Token * [introspect](docs/sdks/oauth2/README.md#introspect) - Introspect Token @@ -344,6 +345,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`licenseKeysUpdate`](docs/sdks/licensekeys/README.md#update) - Update License Key - [`metricsGet`](docs/sdks/metrics/README.md#get) - Get Metrics - [`metricsLimits`](docs/sdks/metrics/README.md#limits) - Get Metrics Limits +- [`oauth2Authorize`](docs/sdks/oauth2/README.md#authorize) - Authorize - [`oauth2ClientsCreate`](docs/sdks/clients/README.md#create) - Create Client - [`oauth2ClientsDelete`](docs/sdks/clients/README.md#delete) - Delete Client - [`oauth2ClientsGet`](docs/sdks/clients/README.md#get) - Get Client @@ -517,10 +519,10 @@ If a HTTP request fails, an operation my also throw an error from the `models/er In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors: -| Error Type | Status Code | Content Type | -| -------------------------- | -------------------------- | -------------------------- | -| errors.HTTPValidationError | 422 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| -------------------------- | ----------- | ---------------- | +| errors.HTTPValidationError | 422 | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | ```typescript import { Polar } from "@polar-sh/sdk"; @@ -575,12 +577,14 @@ Validation errors can also occur when either method arguments or data returned f ### Select Server by Name -You can override the default server globally by passing a server name to the `server` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: +You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: -| Name | Server | Variables | -| ----- | ------ | --------- | -| `production` | `https://api.polar.sh` | None | -| `sandbox` | `https://sandbox-api.polar.sh` | None | +| Name | Server | +| ------------ | ------------------------------ | +| `production` | `https://api.polar.sh` | +| `sandbox` | `https://sandbox-api.polar.sh` | + +#### Example ```typescript import { Polar } from "@polar-sh/sdk"; @@ -603,11 +607,9 @@ run(); ``` - ### Override Server URL Per-Client -The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: - +The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example: ```typescript import { Polar } from "@polar-sh/sdk"; @@ -686,9 +688,9 @@ const sdk = new Polar({ httpClient }); This SDK supports the following security scheme globally: -| Name | Type | Scheme | Environment Variable | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `accessToken` | http | HTTP Bearer | `POLAR_ACCESS_TOKEN` | +| Name | Type | Scheme | Environment Variable | +| ------------- | ---- | ----------- | -------------------- | +| `accessToken` | http | HTTP Bearer | `POLAR_ACCESS_TOKEN` | To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: ```typescript diff --git a/RELEASES.md b/RELEASES.md index b2f6b303..30532e17 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -198,4 +198,14 @@ Based on: ### Generated - [typescript v0.15.1] . ### Releases -- [NPM v0.15.1] https://www.npmjs.com/package/@polar-sh/sdk/v/0.15.1 - . \ No newline at end of file +- [NPM v0.15.1] https://www.npmjs.com/package/@polar-sh/sdk/v/0.15.1 - . + +## 2024-11-13 14:21:07 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.16.0] . +### Releases +- [NPM v0.16.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.16.0 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index d1e0fddb..8c6bd206 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -285,6 +285,12 @@ actions: - "lang": "typescript" "label": "list" "source": "import { Polar } from \"@polar-sh/sdk\";\n\nconst polar = new Polar({\n accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n const result = await polar.oauth2.clients.list({});\n\n for await (const page of result) {\n // Handle the page\n console.log(page);\n }\n}\n\nrun();" + - target: $["paths"]["/v1/oauth2/authorize"]["get"] + update: + "x-codeSamples": + - "lang": "typescript" + "label": "authorize" + "source": "import { Polar } from \"@polar-sh/sdk\";\n\nconst polar = new Polar({\n accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n const result = await polar.oauth2.authorize();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/v1/oauth2/introspect"]["post"] update: "x-codeSamples": diff --git a/docs/models/components/address.md b/docs/models/components/address.md index fa54a941..70961cb9 100644 --- a/docs/models/components/address.md +++ b/docs/models/components/address.md @@ -6,7 +6,7 @@ import { Address } from "@polar-sh/sdk/models/components"; let value: Address = { - country: "Italy", + country: "Netherlands", }; ``` diff --git a/docs/models/components/advertisementcampaign.md b/docs/models/components/advertisementcampaign.md index 9c4052d6..601538e5 100644 --- a/docs/models/components/advertisementcampaign.md +++ b/docs/models/components/advertisementcampaign.md @@ -6,13 +6,13 @@ import { AdvertisementCampaign } from "@polar-sh/sdk/models/components"; let value: AdvertisementCampaign = { - createdAt: new Date("2023-07-24T07:58:55.379Z"), - modifiedAt: new Date("2023-08-15T05:41:44.857Z"), + createdAt: new Date("2023-05-29T14:57:16.680Z"), + modifiedAt: new Date("2022-10-03T22:43:14.073Z"), id: "", - imageUrl: "https://short-term-mentor.info", - imageUrlDark: "https://clean-essence.net/", + imageUrl: "https://basic-emergent.net", + imageUrlDark: "https://alienated-metal.biz", text: "", - linkUrl: "https://competent-bid.org/", + linkUrl: "https://spherical-cauliflower.info", }; ``` diff --git a/docs/models/components/advertisementcampaignlistresource.md b/docs/models/components/advertisementcampaignlistresource.md index 85e19bbb..e0926eb8 100644 --- a/docs/models/components/advertisementcampaignlistresource.md +++ b/docs/models/components/advertisementcampaignlistresource.md @@ -8,21 +8,21 @@ import { AdvertisementCampaignListResource } from "@polar-sh/sdk/models/componen let value: AdvertisementCampaignListResource = { items: [ { - createdAt: new Date("2023-03-04T12:05:11.807Z"), - modifiedAt: new Date("2022-11-29T03:56:04.500Z"), + createdAt: new Date("2022-03-16T23:12:57.117Z"), + modifiedAt: new Date("2024-12-22T15:39:21.636Z"), id: "", - imageUrl: "https://lovely-sandbar.net/", - imageUrlDark: "https://unfit-assist.org", + imageUrl: "https://trivial-ostrich.biz", + imageUrlDark: "https://awesome-moment.info", text: "", - linkUrl: "https://digital-vision.net/", + linkUrl: "https://alienated-governance.info", }, ], pagination: { - totalCount: 929724, - maxPage: 523154, + totalCount: 152359, + maxPage: 414720, }, dimensions: [ - 747742, + 910478, ], }; ``` diff --git a/docs/models/components/advertisementsortproperty.md b/docs/models/components/advertisementsortproperty.md index 2a89a502..331cdbf6 100644 --- a/docs/models/components/advertisementsortproperty.md +++ b/docs/models/components/advertisementsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { AdvertisementSortProperty } from "@polar-sh/sdk/models/components"; -let value: AdvertisementSortProperty = "-created_at"; +let value: AdvertisementSortProperty = "-granted_at"; ``` ## Values diff --git a/docs/models/components/article.md b/docs/models/components/article.md index 8bb08293..8a684ec5 100644 --- a/docs/models/components/article.md +++ b/docs/models/components/article.md @@ -12,40 +12,39 @@ let value: Article = { body: "", byline: { name: "", - avatarUrl: "https://witty-scenario.com/", + avatarUrl: "https://unwieldy-vision.name/", }, visibility: "hidden", userId: "", organizationId: "", organization: { - createdAt: new Date("2023-06-22T00:09:40.274Z"), - modifiedAt: new Date("2022-07-19T21:06:20.014Z"), + createdAt: new Date("2024-01-25T11:17:56.076Z"), + modifiedAt: new Date("2022-01-18T01:14:03.818Z"), id: "", name: "", slug: "", - avatarUrl: "https://tempting-accelerator.com", + avatarUrl: "https://hoarse-sonnet.biz/", bio: "", - company: "Wyman - Jakubowski", + company: "Hoeger - Flatley", blog: "", location: "", - email: "Bo53@gmail.com", + email: "Grayson.Rice@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 318150, + pledgeMinimumAmount: 646822, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 639855, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 887921, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2024-03-18T13:58:56.966Z"), + publishedAt: new Date("2022-06-06T17:12:12.382Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2023-09-23T21:51:50.742Z"), + paidSubscribersOnlyEndsAt: new Date("2024-06-13T14:44:19.237Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2022-07-04T22:19:31.096Z"), - emailSentToCount: 985905, - ogImageUrl: "https://lustrous-offset.net", + notificationsSentAt: new Date("2023-10-31T06:09:51.790Z"), + emailSentToCount: 29242, + ogImageUrl: "https://mysterious-sediment.info", ogDescription: "", }; ``` diff --git a/docs/models/components/articlepreview.md b/docs/models/components/articlepreview.md index 979cafc6..4ae44ff0 100644 --- a/docs/models/components/articlepreview.md +++ b/docs/models/components/articlepreview.md @@ -6,7 +6,7 @@ import { ArticlePreview } from "@polar-sh/sdk/models/components"; let value: ArticlePreview = { - email: "Kali.Schultz@hotmail.com", + email: "Berneice16@hotmail.com", }; ``` diff --git a/docs/models/components/articlereceivers.md b/docs/models/components/articlereceivers.md index 86b0e62f..282179d4 100644 --- a/docs/models/components/articlereceivers.md +++ b/docs/models/components/articlereceivers.md @@ -6,9 +6,9 @@ import { ArticleReceivers } from "@polar-sh/sdk/models/components"; let value: ArticleReceivers = { - freeSubscribers: 554289, - premiumSubscribers: 500494, - organizationMembers: 58582, + freeSubscribers: 666805, + premiumSubscribers: 821345, + organizationMembers: 426397, }; ``` diff --git a/docs/models/components/assignee.md b/docs/models/components/assignee.md index 40e174f2..4a3ea0c3 100644 --- a/docs/models/components/assignee.md +++ b/docs/models/components/assignee.md @@ -6,10 +6,10 @@ import { Assignee } from "@polar-sh/sdk/models/components"; let value: Assignee = { - id: 706309, - login: "Wilford.Bogisich78", - htmlUrl: "https://raw-farm.net/", - avatarUrl: "https://sweet-marimba.info", + id: 838479, + login: "Rafaela_Smith", + htmlUrl: "https://terrible-provision.net", + avatarUrl: "https://pitiful-avalanche.biz/", }; ``` diff --git a/docs/models/components/attachedcustomfield.md b/docs/models/components/attachedcustomfield.md index f98b0597..4ad838b1 100644 --- a/docs/models/components/attachedcustomfield.md +++ b/docs/models/components/attachedcustomfield.md @@ -10,8 +10,8 @@ import { AttachedCustomField } from "@polar-sh/sdk/models/components"; let value: AttachedCustomField = { customFieldId: "", customField: { - createdAt: new Date("2023-05-30T01:41:52.063Z"), - modifiedAt: new Date("2022-06-22T02:05:53.320Z"), + createdAt: new Date("2023-10-31T04:19:03.850Z"), + modifiedAt: new Date("2024-01-14T05:30:11.757Z"), id: "", metadata: { "key": "", @@ -21,7 +21,7 @@ let value: AttachedCustomField = { organizationId: "", properties: {}, }, - order: 241568, + order: 756641, required: false, }; ``` diff --git a/docs/models/components/author.md b/docs/models/components/author.md index 90bf8be1..b8de7097 100644 --- a/docs/models/components/author.md +++ b/docs/models/components/author.md @@ -6,10 +6,10 @@ import { Author } from "@polar-sh/sdk/models/components"; let value: Author = { - id: 618463, - login: "Christy_Schuppe", - htmlUrl: "https://kooky-deduction.biz/", - avatarUrl: "https://raw-waist.com", + id: 202789, + login: "Gia84", + htmlUrl: "https://exhausted-disadvantage.info/", + avatarUrl: "https://noxious-minority.org", }; ``` diff --git a/docs/models/components/donationuser.md b/docs/models/components/authorizeorganization.md similarity index 62% rename from docs/models/components/donationuser.md rename to docs/models/components/authorizeorganization.md index 995ee7d9..51ba1c2e 100644 --- a/docs/models/components/donationuser.md +++ b/docs/models/components/authorizeorganization.md @@ -1,14 +1,14 @@ -# DonationUser +# AuthorizeOrganization ## Example Usage ```typescript -import { DonationUser } from "@polar-sh/sdk/models/components"; +import { AuthorizeOrganization } from "@polar-sh/sdk/models/components"; -let value: DonationUser = { +let value: AuthorizeOrganization = { id: "", - publicName: "", - avatarUrl: "https://bustling-coil.com/", + slug: "", + avatarUrl: "https://private-outrun.com/", }; ``` @@ -17,5 +17,5 @@ let value: DonationUser = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `id` | *string* | :heavy_check_mark: | N/A | -| `publicName` | *string* | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | N/A | | `avatarUrl` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/authorizeresponseorganization.md b/docs/models/components/authorizeresponseorganization.md new file mode 100644 index 00000000..de2230d1 --- /dev/null +++ b/docs/models/components/authorizeresponseorganization.md @@ -0,0 +1,45 @@ +# AuthorizeResponseOrganization + +## Example Usage + +```typescript +import { AuthorizeResponseOrganization } from "@polar-sh/sdk/models/components"; + +let value: AuthorizeResponseOrganization = { + client: { + createdAt: new Date("2024-03-20T05:44:31.552Z"), + modifiedAt: new Date("2023-09-14T04:31:24.353Z"), + clientId: "", + clientName: "", + clientUri: "https://dark-captain.biz/", + logoUri: "https://difficult-ceramic.com", + tosUri: "https://excellent-countess.info", + policyUri: "https://outrageous-traditionalism.net", + }, + sub: { + id: "", + slug: "", + avatarUrl: "https://scented-pharmacopoeia.net", + }, + scopes: [ + "articles:read", + ], + organizations: [ + { + id: "", + slug: "", + avatarUrl: "https://unruly-possession.info", + }, + ], +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `client` | [components.OAuth2ClientPublic](../../models/components/oauth2clientpublic.md) | :heavy_check_mark: | N/A | +| `subType` | [components.AuthorizeResponseOrganizationSubType](../../models/components/authorizeresponseorganizationsubtype.md) | :heavy_check_mark: | N/A | +| `sub` | [components.AuthorizeOrganization](../../models/components/authorizeorganization.md) | :heavy_check_mark: | N/A | +| `scopes` | [components.Scope](../../models/components/scope.md)[] | :heavy_check_mark: | N/A | +| `organizations` | [components.AuthorizeOrganization](../../models/components/authorizeorganization.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/authorizeresponseorganizationsubtype.md b/docs/models/components/authorizeresponseorganizationsubtype.md new file mode 100644 index 00000000..ace551a4 --- /dev/null +++ b/docs/models/components/authorizeresponseorganizationsubtype.md @@ -0,0 +1,15 @@ +# AuthorizeResponseOrganizationSubType + +## Example Usage + +```typescript +import { AuthorizeResponseOrganizationSubType } from "@polar-sh/sdk/models/components"; + +let value: AuthorizeResponseOrganizationSubType = "organization"; +``` + +## Values + +```typescript +"organization" +``` \ No newline at end of file diff --git a/docs/models/components/authorizeresponseuser.md b/docs/models/components/authorizeresponseuser.md new file mode 100644 index 00000000..c717a977 --- /dev/null +++ b/docs/models/components/authorizeresponseuser.md @@ -0,0 +1,37 @@ +# AuthorizeResponseUser + +## Example Usage + +```typescript +import { AuthorizeResponseUser } from "@polar-sh/sdk/models/components"; + +let value: AuthorizeResponseUser = { + client: { + createdAt: new Date("2022-07-19T21:06:20.014Z"), + modifiedAt: new Date("2024-02-11T21:28:56.934Z"), + clientId: "", + clientName: "", + clientUri: "https://accomplished-certification.biz", + logoUri: "https://impressionable-commercial.com", + tosUri: "https://stunning-offset.name", + policyUri: "https://glass-paintwork.net", + }, + sub: { + id: "", + email: "Cathy_Schroeder-Kulas@yahoo.com", + avatarUrl: "https://sophisticated-in-joke.biz", + }, + scopes: [ + "articles:write", + ], +}; +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `client` | [components.OAuth2ClientPublic](../../models/components/oauth2clientpublic.md) | :heavy_check_mark: | N/A | +| `subType` | [components.AuthorizeResponseUserSubType](../../models/components/authorizeresponseusersubtype.md) | :heavy_check_mark: | N/A | +| `sub` | [components.AuthorizeUser](../../models/components/authorizeuser.md) | :heavy_check_mark: | N/A | +| `scopes` | [components.Scope](../../models/components/scope.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/authorizeresponseusersubtype.md b/docs/models/components/authorizeresponseusersubtype.md new file mode 100644 index 00000000..7572a65c --- /dev/null +++ b/docs/models/components/authorizeresponseusersubtype.md @@ -0,0 +1,15 @@ +# AuthorizeResponseUserSubType + +## Example Usage + +```typescript +import { AuthorizeResponseUserSubType } from "@polar-sh/sdk/models/components"; + +let value: AuthorizeResponseUserSubType = "user"; +``` + +## Values + +```typescript +"user" +``` \ No newline at end of file diff --git a/docs/models/components/authorizeuser.md b/docs/models/components/authorizeuser.md new file mode 100644 index 00000000..43aa5be1 --- /dev/null +++ b/docs/models/components/authorizeuser.md @@ -0,0 +1,21 @@ +# AuthorizeUser + +## Example Usage + +```typescript +import { AuthorizeUser } from "@polar-sh/sdk/models/components"; + +let value: AuthorizeUser = { + id: "", + email: "Andreane.Lind81@yahoo.com", + avatarUrl: "https://productive-graffiti.biz/", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | +| `email` | *string* | :heavy_check_mark: | N/A | +| `avatarUrl` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/benefit.md b/docs/models/components/benefit.md index e0424b51..fdd9b171 100644 --- a/docs/models/components/benefit.md +++ b/docs/models/components/benefit.md @@ -7,11 +7,11 @@ ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2023-07-08T03:14:38.624Z"), - modifiedAt: new Date("2024-09-09T01:45:30.325Z"), + createdAt: new Date("2024-06-22T06:45:38.869Z"), + modifiedAt: new Date("2022-11-09T16:12:50.253Z"), id: "", description: - "tarragon design merit spook numeric round apropos separate impish whenever", + "usually even by wholly unnecessarily amid far-off beloved decent whoa", selectable: false, deletable: false, organizationId: "", @@ -25,10 +25,10 @@ const value: components.BenefitArticles = { ```typescript const value: components.BenefitAds = { - createdAt: new Date("2022-05-23T09:32:37.289Z"), - modifiedAt: new Date("2024-12-17T11:03:47.381Z"), + createdAt: new Date("2023-12-15T21:21:22.673Z"), + modifiedAt: new Date("2022-01-11T18:44:58.211Z"), id: "", - description: "famously conservative scramble officially sticky versus", + description: "flawed reasonable while", selectable: false, deletable: false, organizationId: "", @@ -40,11 +40,10 @@ const value: components.BenefitAds = { ```typescript const value: components.BenefitCustom = { - createdAt: new Date("2024-03-31T02:07:48.328Z"), - modifiedAt: new Date("2022-07-08T02:24:58.034Z"), + createdAt: new Date("2023-08-08T06:49:36.002Z"), + modifiedAt: new Date("2023-06-15T21:31:47.005Z"), id: "", - description: - "onto whenever pneumonia decriminalize wasteful who fat iridescence yahoo deer", + description: "heating weary whereas meh considering ack", selectable: false, deletable: false, organizationId: "", @@ -59,10 +58,10 @@ const value: components.BenefitCustom = { ```typescript const value: components.BenefitDiscord = { - createdAt: new Date("2023-07-02T23:56:35.113Z"), - modifiedAt: new Date("2023-10-03T12:55:16.245Z"), + createdAt: new Date("2024-02-01T11:06:52.837Z"), + modifiedAt: new Date("2024-11-02T04:19:53.934Z"), id: "", - description: "besmirch distinction adviser accompanist sport calmly", + description: "heighten overcoat incidentally", selectable: false, deletable: false, organizationId: "", @@ -78,10 +77,10 @@ const value: components.BenefitDiscord = { ```typescript const value: components.BenefitGitHubRepository = { - createdAt: new Date("2022-08-30T11:08:28.655Z"), - modifiedAt: new Date("2024-05-10T23:58:01.273Z"), + createdAt: new Date("2023-11-02T06:10:06.959Z"), + modifiedAt: new Date("2022-01-07T12:56:00.125Z"), id: "", - description: "worth tomorrow talkative soon alongside acidic jovially awful", + description: "likewise excitedly ugh bakeware warmly boo", selectable: false, deletable: false, organizationId: "", @@ -89,7 +88,7 @@ const value: components.BenefitGitHubRepository = { repositoryId: "", repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "admin", + permission: "push", }, }; ``` @@ -98,10 +97,10 @@ const value: components.BenefitGitHubRepository = { ```typescript const value: components.BenefitDownloadables = { - createdAt: new Date("2022-07-16T03:22:51.500Z"), - modifiedAt: new Date("2024-04-07T19:20:03.652Z"), + createdAt: new Date("2024-04-18T06:42:06.014Z"), + modifiedAt: new Date("2024-12-20T13:50:06.096Z"), id: "", - description: "brr haunting bookend mispronounce goodwill fork pfft", + description: "notwithstanding yuck inside", selectable: false, deletable: false, organizationId: "", @@ -120,24 +119,24 @@ const value: components.BenefitDownloadables = { ```typescript const value: components.BenefitLicenseKeys = { - createdAt: new Date("2022-12-28T03:57:53.023Z"), - modifiedAt: new Date("2024-02-06T05:51:10.313Z"), + createdAt: new Date("2024-06-11T19:52:42.696Z"), + modifiedAt: new Date("2023-07-11T03:19:08.621Z"), id: "", - description: "halt requite oh personal skateboard", + description: "brr even hmph joyfully and whether cafe filter", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 926479, - timeframe: "year", + ttl: 699128, + timeframe: "month", }, activations: { - limit: 624730, + limit: 796525, enableUserAdmin: false, }, - limitUsage: 27877, + limitUsage: 587166, }, }; ``` diff --git a/docs/models/components/benefitads.md b/docs/models/components/benefitads.md index 90c4cf58..b60a1c67 100644 --- a/docs/models/components/benefitads.md +++ b/docs/models/components/benefitads.md @@ -10,10 +10,10 @@ Use it so your backers can display ads on your README, website, etc. import { BenefitAds } from "@polar-sh/sdk/models/components"; let value: BenefitAds = { - createdAt: new Date("2024-03-16T17:11:00.930Z"), - modifiedAt: new Date("2022-02-16T06:35:54.024Z"), + createdAt: new Date("2023-01-20T05:18:56.751Z"), + modifiedAt: new Date("2022-06-22T12:10:56.971Z"), id: "", - description: "quart carefully quicker sometimes um phew about helpless", + description: "dependency if singing", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitadscreate.md b/docs/models/components/benefitadscreate.md index b3dec7e7..80214e96 100644 --- a/docs/models/components/benefitadscreate.md +++ b/docs/models/components/benefitadscreate.md @@ -6,7 +6,7 @@ import { BenefitAdsCreate } from "@polar-sh/sdk/models/components"; let value: BenefitAdsCreate = { - description: "apologise um handy into", + description: "clearly afore uproot wide-eyed shrill where", properties: {}, }; ``` diff --git a/docs/models/components/benefitadssubscriber.md b/docs/models/components/benefitadssubscriber.md index 18abb62e..d9b84d87 100644 --- a/docs/models/components/benefitadssubscriber.md +++ b/docs/models/components/benefitadssubscriber.md @@ -6,18 +6,17 @@ import { BenefitAdsSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitAdsSubscriber = { - createdAt: new Date("2024-08-06T23:09:15.332Z"), - modifiedAt: new Date("2024-02-08T20:24:45.233Z"), + createdAt: new Date("2024-11-28T16:58:32.600Z"), + modifiedAt: new Date("2023-01-18T02:26:54.532Z"), id: "", - description: - "ah unique interestingly throughout mixture scenario why grandiose vainly", + description: "little hmph flood", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-02-09T06:12:33.108Z"), - modifiedAt: new Date("2023-06-04T12:09:50.425Z"), + createdAt: new Date("2024-05-27T22:36:34.200Z"), + modifiedAt: new Date("2022-02-10T14:02:38.783Z"), id: "", isGranted: false, isRevoked: false, @@ -29,22 +28,21 @@ let value: BenefitAdsSubscriber = { }, ], organization: { - createdAt: new Date("2023-04-15T14:47:40.530Z"), - modifiedAt: new Date("2022-05-08T15:09:38.886Z"), + createdAt: new Date("2022-03-22T20:53:34.094Z"), + modifiedAt: new Date("2023-09-26T23:35:22.282Z"), id: "", name: "", slug: "", - avatarUrl: "https://sick-airline.com/", + avatarUrl: "https://pretty-doorpost.org/", bio: "", - company: "Stiedemann - Morissette", + company: "Bernhard, Sawayn and Wisozk", blog: "", location: "", - email: "Odessa.Weber-Waelchi58@gmail.com", + email: "Mya97@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 564647, + pledgeMinimumAmount: 610766, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 318030, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 695088, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitarticlessubscriber.md b/docs/models/components/benefitarticlessubscriber.md index c1da3db9..330cd517 100644 --- a/docs/models/components/benefitarticlessubscriber.md +++ b/docs/models/components/benefitarticlessubscriber.md @@ -6,17 +6,17 @@ import { BenefitArticlesSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitArticlesSubscriber = { - createdAt: new Date("2022-12-02T16:06:08.205Z"), - modifiedAt: new Date("2024-07-05T06:36:23.390Z"), + createdAt: new Date("2023-05-08T12:12:24.685Z"), + modifiedAt: new Date("2022-06-15T01:33:14.819Z"), id: "", - description: "if carefully eek clavicle cantaloupe inside towards ignorance", + description: "however for suckle along although boohoo consequently", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-04-22T00:36:49.607Z"), - modifiedAt: new Date("2022-11-02T04:50:51.282Z"), + createdAt: new Date("2024-09-15T03:58:39.261Z"), + modifiedAt: new Date("2024-12-17T17:51:01.747Z"), id: "", isGranted: false, isRevoked: false, @@ -27,22 +27,21 @@ let value: BenefitArticlesSubscriber = { }, ], organization: { - createdAt: new Date("2022-01-06T12:53:03.799Z"), - modifiedAt: new Date("2022-07-24T04:31:39.728Z"), + createdAt: new Date("2022-12-25T20:13:46.460Z"), + modifiedAt: new Date("2024-02-10T23:02:01.882Z"), id: "", name: "", slug: "", - avatarUrl: "https://trim-doorpost.org", + avatarUrl: "https://caring-grandson.name/", bio: "", - company: "Gulgowski Group", + company: "Schuppe - Kuphal", blog: "", location: "", - email: "Wyman.Prosacco@hotmail.com", + email: "Larue42@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 551570, + pledgeMinimumAmount: 770940, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 123016, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 356351, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitcustom.md b/docs/models/components/benefitcustom.md index 2cc198aa..4d19406f 100644 --- a/docs/models/components/benefitcustom.md +++ b/docs/models/components/benefitcustom.md @@ -10,10 +10,10 @@ Use it to grant any kind of benefit that doesn't fit in the other types. import { BenefitCustom } from "@polar-sh/sdk/models/components"; let value: BenefitCustom = { - createdAt: new Date("2022-01-09T20:21:22.672Z"), - modifiedAt: new Date("2022-04-26T15:33:11.600Z"), + createdAt: new Date("2024-01-01T21:10:10.994Z"), + modifiedAt: new Date("2023-10-24T11:48:21.731Z"), id: "", - description: "ack including angrily venom forenenst", + description: "up aside beard cruelly tectonics for off bah", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitcustomcreate.md b/docs/models/components/benefitcustomcreate.md index 2bfa21ea..2971cbd0 100644 --- a/docs/models/components/benefitcustomcreate.md +++ b/docs/models/components/benefitcustomcreate.md @@ -8,7 +8,7 @@ Schema to create a benefit of type `custom`. import { BenefitCustomCreate } from "@polar-sh/sdk/models/components"; let value: BenefitCustomCreate = { - description: "now yawningly properly reconsideration", + description: "rudely save miserably", isTaxApplicable: false, properties: {}, }; diff --git a/docs/models/components/benefitcustomsubscriber.md b/docs/models/components/benefitcustomsubscriber.md index b6b46327..eee15004 100644 --- a/docs/models/components/benefitcustomsubscriber.md +++ b/docs/models/components/benefitcustomsubscriber.md @@ -6,17 +6,17 @@ import { BenefitCustomSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitCustomSubscriber = { - createdAt: new Date("2022-04-13T15:39:03.902Z"), - modifiedAt: new Date("2022-11-04T15:42:22.170Z"), + createdAt: new Date("2023-09-15T07:57:16.201Z"), + modifiedAt: new Date("2022-06-02T21:32:40.622Z"), id: "", - description: "rudely blah glossy substantial supposing gee", + description: "yowza upliftingly whoa fuel oof matter under indolent and", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-11-25T20:02:18.063Z"), - modifiedAt: new Date("2024-11-13T22:33:54.853Z"), + createdAt: new Date("2022-08-08T09:17:22.587Z"), + modifiedAt: new Date("2023-11-14T17:27:52.001Z"), id: "", isGranted: false, isRevoked: false, @@ -27,22 +27,21 @@ let value: BenefitCustomSubscriber = { }, ], organization: { - createdAt: new Date("2023-03-03T14:29:48.031Z"), - modifiedAt: new Date("2024-02-04T11:30:23.298Z"), + createdAt: new Date("2022-05-06T16:52:19.881Z"), + modifiedAt: new Date("2023-10-24T06:27:18.505Z"), id: "", name: "", slug: "", - avatarUrl: "https://well-groomed-toaster.com", + avatarUrl: "https://internal-eyebrow.com/", bio: "", - company: "Schowalter - Ullrich", + company: "Windler LLC", blog: "", location: "", - email: "Maryse.Erdman60@yahoo.com", + email: "Verlie95@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 59846, + pledgeMinimumAmount: 148004, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 302207, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 85685, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitdiscord.md b/docs/models/components/benefitdiscord.md index 1279f032..e53f5f7f 100644 --- a/docs/models/components/benefitdiscord.md +++ b/docs/models/components/benefitdiscord.md @@ -10,10 +10,10 @@ Use it to automatically invite your backers to a Discord server. import { BenefitDiscord } from "@polar-sh/sdk/models/components"; let value: BenefitDiscord = { - createdAt: new Date("2024-09-21T17:53:36.055Z"), - modifiedAt: new Date("2024-02-16T06:40:47.027Z"), + createdAt: new Date("2023-09-20T16:28:52.728Z"), + modifiedAt: new Date("2023-05-18T22:46:14.781Z"), id: "", - description: "up chapel peppery woot handy ew ew", + description: "divert despite drab eek", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdiscordcreate.md b/docs/models/components/benefitdiscordcreate.md index 0dd718de..089706a0 100644 --- a/docs/models/components/benefitdiscordcreate.md +++ b/docs/models/components/benefitdiscordcreate.md @@ -6,8 +6,7 @@ import { BenefitDiscordCreate } from "@polar-sh/sdk/models/components"; let value: BenefitDiscordCreate = { - description: - "heating stage what embossing than glittering sauerkraut off splurge", + description: "greedily once patiently", properties: { guildToken: "", roleId: "", diff --git a/docs/models/components/benefitdiscordinput.md b/docs/models/components/benefitdiscordinput.md deleted file mode 100644 index ef385bfe..00000000 --- a/docs/models/components/benefitdiscordinput.md +++ /dev/null @@ -1,40 +0,0 @@ -# BenefitDiscordInput - -A benefit of type `discord`. - -Use it to automatically invite your backers to a Discord server. - -## Example Usage - -```typescript -import { BenefitDiscordInput } from "@polar-sh/sdk/models/components"; - -let value: BenefitDiscordInput = { - createdAt: new Date("2023-09-24T14:39:14.681Z"), - modifiedAt: new Date("2022-02-11T22:59:09.682Z"), - id: "", - description: - "instead likewise afford truthfully around while petal forenenst", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the benefit. | -| `type` | [components.BenefitDiscordType](../../models/components/benefitdiscordtype.md) | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_check_mark: | The description of the benefit. | -| `selectable` | *boolean* | :heavy_check_mark: | Whether the benefit is selectable when creating a product. | -| `deletable` | *boolean* | :heavy_check_mark: | Whether the benefit is deletable. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the benefit. | -| `properties` | [components.BenefitDiscordPropertiesInput](../../models/components/benefitdiscordpropertiesinput.md) | :heavy_check_mark: | Properties for a benefit of type `discord`. | \ No newline at end of file diff --git a/docs/models/components/benefitdiscordpropertiesinput.md b/docs/models/components/benefitdiscordpropertiesinput.md deleted file mode 100644 index 21a4dc86..00000000 --- a/docs/models/components/benefitdiscordpropertiesinput.md +++ /dev/null @@ -1,21 +0,0 @@ -# BenefitDiscordPropertiesInput - -Properties for a benefit of type `discord`. - -## Example Usage - -```typescript -import { BenefitDiscordPropertiesInput } from "@polar-sh/sdk/models/components"; - -let value: BenefitDiscordPropertiesInput = { - guildId: "", - roleId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `guildId` | *string* | :heavy_check_mark: | The ID of the Discord server. | -| `roleId` | *string* | :heavy_check_mark: | The ID of the Discord role to grant. | \ No newline at end of file diff --git a/docs/models/components/benefitdiscordsubscriber.md b/docs/models/components/benefitdiscordsubscriber.md index e2cc40d6..d703d97e 100644 --- a/docs/models/components/benefitdiscordsubscriber.md +++ b/docs/models/components/benefitdiscordsubscriber.md @@ -6,17 +6,17 @@ import { BenefitDiscordSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitDiscordSubscriber = { - createdAt: new Date("2023-06-27T15:00:49.644Z"), - modifiedAt: new Date("2024-12-20T18:47:30.812Z"), + createdAt: new Date("2024-10-22T15:16:19.696Z"), + modifiedAt: new Date("2022-12-30T19:00:40.873Z"), id: "", - description: "made-up brr carelessly", + description: "gestate correctly trick", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-02-07T09:13:36.865Z"), - modifiedAt: new Date("2023-12-30T07:02:08.293Z"), + createdAt: new Date("2024-10-07T00:23:12.112Z"), + modifiedAt: new Date("2022-01-09T13:26:23.661Z"), id: "", isGranted: false, isRevoked: false, @@ -27,22 +27,21 @@ let value: BenefitDiscordSubscriber = { }, ], organization: { - createdAt: new Date("2024-08-08T23:38:36.457Z"), - modifiedAt: new Date("2023-01-05T23:27:19.376Z"), + createdAt: new Date("2023-10-08T13:24:38.931Z"), + modifiedAt: new Date("2022-10-09T06:27:51.653Z"), id: "", name: "", slug: "", - avatarUrl: "https://clear-cut-descendant.org", + avatarUrl: "https://glass-citizen.info", bio: "", - company: "Mohr Group", + company: "Zboncak Group", blog: "", location: "", - email: "Ana35@gmail.com", + email: "Roxanne_Shields@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 365043, + pledgeMinimumAmount: 204877, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 267684, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 810004, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitdownloadables.md b/docs/models/components/benefitdownloadables.md index 88d9070b..7dd58ea4 100644 --- a/docs/models/components/benefitdownloadables.md +++ b/docs/models/components/benefitdownloadables.md @@ -6,10 +6,10 @@ import { BenefitDownloadables } from "@polar-sh/sdk/models/components"; let value: BenefitDownloadables = { - createdAt: new Date("2022-01-11T16:29:34.953Z"), - modifiedAt: new Date("2023-09-17T08:05:44.716Z"), + createdAt: new Date("2023-04-20T19:22:55.409Z"), + modifiedAt: new Date("2022-04-25T05:44:28.693Z"), id: "", - description: "bore rotten fooey now incidentally saloon", + description: "peppery woot handy ew", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdownloadablescreate.md b/docs/models/components/benefitdownloadablescreate.md index 2c5fc310..b2becf0b 100644 --- a/docs/models/components/benefitdownloadablescreate.md +++ b/docs/models/components/benefitdownloadablescreate.md @@ -6,7 +6,7 @@ import { BenefitDownloadablesCreate } from "@polar-sh/sdk/models/components"; let value: BenefitDownloadablesCreate = { - description: "quit boyfriend cruel so ethical than lawmaker considering", + description: "grizzled fencing although", properties: { files: [ "", diff --git a/docs/models/components/benefitdownloadablessubscriber.md b/docs/models/components/benefitdownloadablessubscriber.md index 830e4e18..ed78612b 100644 --- a/docs/models/components/benefitdownloadablessubscriber.md +++ b/docs/models/components/benefitdownloadablessubscriber.md @@ -6,17 +6,17 @@ import { BenefitDownloadablesSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitDownloadablesSubscriber = { - createdAt: new Date("2024-01-30T03:46:18.998Z"), - modifiedAt: new Date("2023-03-14T20:59:08.982Z"), + createdAt: new Date("2024-12-08T03:20:01.695Z"), + modifiedAt: new Date("2024-05-29T04:45:03.855Z"), id: "", - description: "minus pish up", + description: "hence damaged and minus confute", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2024-04-10T11:26:32.069Z"), - modifiedAt: new Date("2022-03-09T04:27:11.348Z"), + createdAt: new Date("2023-02-20T15:25:02.227Z"), + modifiedAt: new Date("2024-03-30T02:29:26.135Z"), id: "", isGranted: false, isRevoked: false, @@ -27,22 +27,21 @@ let value: BenefitDownloadablesSubscriber = { }, ], organization: { - createdAt: new Date("2023-09-20T14:32:18.040Z"), - modifiedAt: new Date("2023-09-14T21:57:59.380Z"), + createdAt: new Date("2024-06-30T02:36:41.216Z"), + modifiedAt: new Date("2022-06-28T11:34:52.703Z"), id: "", name: "", slug: "", - avatarUrl: "https://gray-impostor.com/", + avatarUrl: "https://recent-tail.org", bio: "", - company: "Cruickshank - Hoeger", + company: "Bode - Schmidt", blog: "", location: "", - email: "Ricky89@hotmail.com", + email: "Clemmie84@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 124460, + pledgeMinimumAmount: 605391, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 80673, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 566089, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitgithubrepository.md b/docs/models/components/benefitgithubrepository.md index ca03d92e..e6934cdd 100644 --- a/docs/models/components/benefitgithubrepository.md +++ b/docs/models/components/benefitgithubrepository.md @@ -10,10 +10,10 @@ Use it to automatically invite your backers to a private GitHub repository. import { BenefitGitHubRepository } from "@polar-sh/sdk/models/components"; let value: BenefitGitHubRepository = { - createdAt: new Date("2023-06-09T00:28:28.491Z"), - modifiedAt: new Date("2022-10-08T06:48:53.375Z"), + createdAt: new Date("2023-10-27T09:16:53.066Z"), + modifiedAt: new Date("2024-10-28T01:53:16.789Z"), id: "", - description: "great chromakey gadzooks briefly between", + description: "huzzah oxygenate productive behold", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitgithubrepositorycreate.md b/docs/models/components/benefitgithubrepositorycreate.md index d0381884..325362c3 100644 --- a/docs/models/components/benefitgithubrepositorycreate.md +++ b/docs/models/components/benefitgithubrepositorycreate.md @@ -6,11 +6,12 @@ import { BenefitGitHubRepositoryCreate } from "@polar-sh/sdk/models/components"; let value: BenefitGitHubRepositoryCreate = { - description: "despite defendant reward", + description: + "mid given coordinated genuine tensely commandeer but record widow consequently", properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "push", + permission: "maintain", }, }; ``` diff --git a/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md b/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md index 937b0aa3..78095d2e 100644 --- a/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md +++ b/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md @@ -7,7 +7,7 @@ The permission level to grant. Read more about roles and their permissions on [G ```typescript import { BenefitGitHubRepositoryCreatePropertiesPermission } from "@polar-sh/sdk/models/components"; -let value: BenefitGitHubRepositoryCreatePropertiesPermission = "maintain"; +let value: BenefitGitHubRepositoryCreatePropertiesPermission = "push"; ``` ## Values diff --git a/docs/models/components/benefitgithubrepositoryproperties.md b/docs/models/components/benefitgithubrepositoryproperties.md index 61b29c53..171c0d83 100644 --- a/docs/models/components/benefitgithubrepositoryproperties.md +++ b/docs/models/components/benefitgithubrepositoryproperties.md @@ -11,7 +11,7 @@ let value: BenefitGitHubRepositoryProperties = { repositoryId: "", repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "admin", + permission: "maintain", }; ``` diff --git a/docs/models/components/benefitgithubrepositorysubscriber.md b/docs/models/components/benefitgithubrepositorysubscriber.md index 570636cc..53289ee1 100644 --- a/docs/models/components/benefitgithubrepositorysubscriber.md +++ b/docs/models/components/benefitgithubrepositorysubscriber.md @@ -6,17 +6,17 @@ import { BenefitGitHubRepositorySubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitGitHubRepositorySubscriber = { - createdAt: new Date("2024-01-13T05:23:44.648Z"), - modifiedAt: new Date("2023-09-26T08:07:38.651Z"), + createdAt: new Date("2024-06-06T08:49:54.446Z"), + modifiedAt: new Date("2024-09-18T19:37:34.618Z"), id: "", - description: "huzzah impressive times inborn above", + description: "as pfft grandson inexperienced pike investigate", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-02-23T19:41:54.637Z"), - modifiedAt: new Date("2023-04-11T06:18:21.553Z"), + createdAt: new Date("2022-10-05T03:45:09.190Z"), + modifiedAt: new Date("2024-09-04T18:08:56.987Z"), id: "", isGranted: false, isRevoked: false, @@ -27,22 +27,21 @@ let value: BenefitGitHubRepositorySubscriber = { }, ], organization: { - createdAt: new Date("2024-08-02T08:31:07.216Z"), - modifiedAt: new Date("2024-05-25T21:42:54.382Z"), + createdAt: new Date("2023-02-24T14:34:24.056Z"), + modifiedAt: new Date("2022-02-12T21:10:23.646Z"), id: "", name: "", slug: "", - avatarUrl: "https://tedious-diagram.info/", + avatarUrl: "https://insistent-straw.net/", bio: "", - company: "Bednar - Parker", + company: "Smitham - Franey", blog: "", location: "", - email: "Jerel97@hotmail.com", + email: "Ardith49@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 274844, + pledgeMinimumAmount: 793752, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 789015, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 664679, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/benefitgrant.md b/docs/models/components/benefitgrant.md index 1ec26b9e..4d295dc8 100644 --- a/docs/models/components/benefitgrant.md +++ b/docs/models/components/benefitgrant.md @@ -6,8 +6,8 @@ import { BenefitGrant } from "@polar-sh/sdk/models/components"; let value: BenefitGrant = { - createdAt: new Date("2023-03-21T19:22:19.568Z"), - modifiedAt: new Date("2022-07-03T17:14:11.045Z"), + createdAt: new Date("2022-12-10T02:49:59.396Z"), + modifiedAt: new Date("2022-04-25T02:10:45.992Z"), id: "", isGranted: false, isRevoked: false, @@ -15,9 +15,7 @@ let value: BenefitGrant = { orderId: "", userId: "", benefitId: "", - properties: { - advertisementCampaignId: "", - }, + properties: {}, }; ``` diff --git a/docs/models/components/benefitgrantads.md b/docs/models/components/benefitgrantads.md index 78a08ff4..bb4bd70a 100644 --- a/docs/models/components/benefitgrantads.md +++ b/docs/models/components/benefitgrantads.md @@ -6,8 +6,8 @@ import { BenefitGrantAds } from "@polar-sh/sdk/models/components"; let value: BenefitGrantAds = { - createdAt: new Date("2022-06-18T10:02:41.068Z"), - modifiedAt: new Date("2023-05-03T03:57:46.437Z"), + createdAt: new Date("2023-04-26T00:36:10.844Z"), + modifiedAt: new Date("2023-02-13T12:28:03.035Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantgithubrepositorypropertiespermission.md b/docs/models/components/benefitgrantgithubrepositorypropertiespermission.md index bc6b928b..445a6b33 100644 --- a/docs/models/components/benefitgrantgithubrepositorypropertiespermission.md +++ b/docs/models/components/benefitgrantgithubrepositorypropertiespermission.md @@ -5,7 +5,7 @@ ```typescript import { BenefitGrantGitHubRepositoryPropertiesPermission } from "@polar-sh/sdk/models/components"; -let value: BenefitGrantGitHubRepositoryPropertiesPermission = "triage"; +let value: BenefitGrantGitHubRepositoryPropertiesPermission = "pull"; ``` ## Values diff --git a/docs/models/components/benefitgrantlicensekeys.md b/docs/models/components/benefitgrantlicensekeys.md index 47d6757a..93acfdf5 100644 --- a/docs/models/components/benefitgrantlicensekeys.md +++ b/docs/models/components/benefitgrantlicensekeys.md @@ -6,8 +6,8 @@ import { BenefitGrantLicenseKeys } from "@polar-sh/sdk/models/components"; let value: BenefitGrantLicenseKeys = { - createdAt: new Date("2022-11-30T19:27:00.258Z"), - modifiedAt: new Date("2022-01-16T00:03:35.865Z"), + createdAt: new Date("2022-06-30T23:00:15.056Z"), + modifiedAt: new Date("2024-11-16T15:02:53.915Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantsubscriber.md b/docs/models/components/benefitgrantsubscriber.md index 5feb6de5..9d5751ce 100644 --- a/docs/models/components/benefitgrantsubscriber.md +++ b/docs/models/components/benefitgrantsubscriber.md @@ -6,8 +6,8 @@ import { BenefitGrantSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitGrantSubscriber = { - createdAt: new Date("2022-06-30T19:52:08.607Z"), - modifiedAt: new Date("2023-05-17T14:56:25.246Z"), + createdAt: new Date("2023-03-16T02:53:33.205Z"), + modifiedAt: new Date("2022-11-15T02:07:18.027Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantwebhook.md b/docs/models/components/benefitgrantwebhook.md index 1c67bfb4..71f65d48 100644 --- a/docs/models/components/benefitgrantwebhook.md +++ b/docs/models/components/benefitgrantwebhook.md @@ -6,8 +6,8 @@ import { BenefitGrantWebhook } from "@polar-sh/sdk/models/components"; let value: BenefitGrantWebhook = { - createdAt: new Date("2023-06-12T10:03:01.658Z"), - modifiedAt: new Date("2023-09-18T07:49:46.907Z"), + createdAt: new Date("2024-07-31T12:00:00.723Z"), + modifiedAt: new Date("2023-01-14T21:46:23.229Z"), id: "", isGranted: false, isRevoked: false, @@ -17,24 +17,24 @@ let value: BenefitGrantWebhook = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2024-09-08T22:46:10.175Z"), - modifiedAt: new Date("2024-12-18T04:45:58.619Z"), + createdAt: new Date("2024-10-09T00:59:04.462Z"), + modifiedAt: new Date("2024-08-17T05:25:06.310Z"), id: "", - description: "light mechanically distorted onto", + description: "pale midst pants times", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 611534, + ttl: 832839, timeframe: "year", }, activations: { - limit: 348198, + limit: 422299, enableUserAdmin: false, }, - limitUsage: 382920, + limitUsage: 819270, }, }, }; @@ -56,5 +56,5 @@ let value: BenefitGrantWebhook = { | `userId` | *string* | :heavy_check_mark: | The ID of the user concerned by this grant. | | `benefitId` | *string* | :heavy_check_mark: | The ID of the benefit concerned by this grant. | | `properties` | *components.BenefitGrantWebhookProperties* | :heavy_check_mark: | N/A | -| `benefit` | *components.BenefitInput* | :heavy_check_mark: | N/A | +| `benefit` | *components.Benefit* | :heavy_check_mark: | N/A | | `previousProperties` | *components.PreviousProperties* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/benefitinput.md b/docs/models/components/benefitinput.md deleted file mode 100644 index 48d66c88..00000000 --- a/docs/models/components/benefitinput.md +++ /dev/null @@ -1,143 +0,0 @@ -# BenefitInput - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2024-09-18T01:50:30.231Z"), - modifiedAt: new Date("2022-01-09T21:40:07.070Z"), - id: "", - description: - "conjecture gah harmful unimpressively tarry wherever hypothesise helpfully", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2022-04-07T02:23:10.765Z"), - modifiedAt: new Date("2024-12-13T22:49:51.164Z"), - id: "", - description: "whopping dramatic glum but", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2022-12-18T17:37:05.328Z"), - modifiedAt: new Date("2023-05-01T14:21:51.139Z"), - id: "", - description: "gosh huzzah until above tag grandpa", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscordInput` - -```typescript -const value: components.BenefitDiscordInput = { - createdAt: new Date("2022-10-19T12:42:33.166Z"), - modifiedAt: new Date("2022-04-21T21:53:00.072Z"), - id: "", - description: "hassle whoever instead rubric thorny forenenst till", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2022-10-04T12:08:13.052Z"), - modifiedAt: new Date("2023-02-18T05:45:49.390Z"), - id: "", - description: "till ouch tuber soon gosh out lightly and pace crocodile", - selectable: false, - deletable: false, - organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "push", - }, -}; -``` - -### `components.BenefitDownloadables` - -```typescript -const value: components.BenefitDownloadables = { - createdAt: new Date("2024-02-05T08:02:46.013Z"), - modifiedAt: new Date("2024-09-07T05:56:52.203Z"), - id: "", - description: - "obnoxiously when incidentally helplessly malfunction evenly put under casement the", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2023-08-18T06:37:46.018Z"), - modifiedAt: new Date("2023-03-25T02:27:25.840Z"), - id: "", - description: "irritably consequently soap rule", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 69978, - timeframe: "day", - }, - activations: { - limit: 257914, - enableUserAdmin: false, - }, - limitUsage: 374102, - }, -}; -``` - diff --git a/docs/models/components/benefitlicensekeyactivationproperties.md b/docs/models/components/benefitlicensekeyactivationproperties.md index fffe9e04..0eb747fa 100644 --- a/docs/models/components/benefitlicensekeyactivationproperties.md +++ b/docs/models/components/benefitlicensekeyactivationproperties.md @@ -6,7 +6,7 @@ import { BenefitLicenseKeyActivationProperties } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeyActivationProperties = { - limit: 865806, + limit: 397667, enableUserAdmin: false, }; ``` diff --git a/docs/models/components/benefitlicensekeyexpirationproperties.md b/docs/models/components/benefitlicensekeyexpirationproperties.md index fd7c73a2..e45ba769 100644 --- a/docs/models/components/benefitlicensekeyexpirationproperties.md +++ b/docs/models/components/benefitlicensekeyexpirationproperties.md @@ -6,8 +6,8 @@ import { BenefitLicenseKeyExpirationProperties } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeyExpirationProperties = { - ttl: 795337, - timeframe: "month", + ttl: 910984, + timeframe: "year", }; ``` diff --git a/docs/models/components/benefitlicensekeys.md b/docs/models/components/benefitlicensekeys.md index 59002daa..bb59d058 100644 --- a/docs/models/components/benefitlicensekeys.md +++ b/docs/models/components/benefitlicensekeys.md @@ -6,24 +6,25 @@ import { BenefitLicenseKeys } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeys = { - createdAt: new Date("2022-02-01T17:24:49.733Z"), - modifiedAt: new Date("2022-02-19T00:25:38.865Z"), + createdAt: new Date("2023-02-17T11:30:44.964Z"), + modifiedAt: new Date("2023-06-05T18:26:07.487Z"), id: "", - description: "stratify noisily delightfully ill-fated phooey baritone", + description: + "incidentally great chromakey gadzooks briefly between than yahoo able", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 379054, - timeframe: "month", + ttl: 813007, + timeframe: "day", }, activations: { - limit: 646822, + limit: 19398, enableUserAdmin: false, }, - limitUsage: 887921, + limitUsage: 598294, }, }; ``` diff --git a/docs/models/components/benefitlicensekeyscreate.md b/docs/models/components/benefitlicensekeyscreate.md index be293080..d0912885 100644 --- a/docs/models/components/benefitlicensekeyscreate.md +++ b/docs/models/components/benefitlicensekeyscreate.md @@ -6,7 +6,7 @@ import { BenefitLicenseKeysCreate } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeysCreate = { - description: "because agreeable worth geez", + description: "gadzooks between sanity throughout hold", properties: {}, }; ``` diff --git a/docs/models/components/benefitlicensekeysproperties.md b/docs/models/components/benefitlicensekeysproperties.md index 0364f4cb..3b9565ec 100644 --- a/docs/models/components/benefitlicensekeysproperties.md +++ b/docs/models/components/benefitlicensekeysproperties.md @@ -8,14 +8,14 @@ import { BenefitLicenseKeysProperties } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeysProperties = { prefix: "", expires: { - ttl: 142989, - timeframe: "day", + ttl: 676576, + timeframe: "year", }, activations: { - limit: 609724, + limit: 838212, enableUserAdmin: false, }, - limitUsage: 29242, + limitUsage: 625832, }; ``` diff --git a/docs/models/components/benefitlicensekeyssubscriber.md b/docs/models/components/benefitlicensekeyssubscriber.md index 3e83c509..3b78689a 100644 --- a/docs/models/components/benefitlicensekeyssubscriber.md +++ b/docs/models/components/benefitlicensekeyssubscriber.md @@ -6,17 +6,17 @@ import { BenefitLicenseKeysSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeysSubscriber = { - createdAt: new Date("2024-05-26T12:06:04.723Z"), - modifiedAt: new Date("2022-06-27T17:44:33.524Z"), + createdAt: new Date("2023-09-24T02:51:12.661Z"), + modifiedAt: new Date("2022-11-27T05:06:38.850Z"), id: "", - description: "obvious past energetically gentle", + description: "puny zowie lend ew after scoff swiftly", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-10-15T20:28:38.974Z"), - modifiedAt: new Date("2022-07-10T19:03:58.934Z"), + createdAt: new Date("2023-12-16T20:57:59.104Z"), + modifiedAt: new Date("2022-11-30T19:27:00.258Z"), id: "", isGranted: false, isRevoked: false, @@ -28,36 +28,35 @@ let value: BenefitLicenseKeysSubscriber = { }, ], organization: { - createdAt: new Date("2023-06-07T06:55:01.621Z"), - modifiedAt: new Date("2022-07-09T16:29:33.851Z"), + createdAt: new Date("2022-01-16T00:03:35.865Z"), + modifiedAt: new Date("2022-08-19T01:44:07.509Z"), id: "", name: "", slug: "", - avatarUrl: "https://impartial-hovel.biz/", + avatarUrl: "https://ornate-drug.info", bio: "", - company: "Gorczany - Fisher", + company: "Champlin Inc", blog: "", location: "", - email: "Mikayla_Bosco7@hotmail.com", + email: "Kari_Hilll6@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 352596, + pledgeMinimumAmount: 420259, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 240545, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 896695, profileSettings: {}, featureSettings: {}, }, properties: { prefix: "", expires: { - ttl: 594648, - timeframe: "day", + ttl: 277569, + timeframe: "year", }, activations: { - limit: 719852, + limit: 928209, enableUserAdmin: false, }, - limitUsage: 767361, + limitUsage: 168223, }, }; ``` diff --git a/docs/models/components/benefitlicensekeyssubscriberproperties.md b/docs/models/components/benefitlicensekeyssubscriberproperties.md index 62f74185..c9b4d35b 100644 --- a/docs/models/components/benefitlicensekeyssubscriberproperties.md +++ b/docs/models/components/benefitlicensekeyssubscriberproperties.md @@ -8,14 +8,14 @@ import { BenefitLicenseKeysSubscriberProperties } from "@polar-sh/sdk/models/com let value: BenefitLicenseKeysSubscriberProperties = { prefix: "", expires: { - ttl: 950894, - timeframe: "month", + ttl: 374840, + timeframe: "day", }, activations: { - limit: 577731, + limit: 260924, enableUserAdmin: false, }, - limitUsage: 601868, + limitUsage: 229849, }; ``` diff --git a/docs/models/components/benefits.md b/docs/models/components/benefits.md index 46b80017..d6b5a71f 100644 --- a/docs/models/components/benefits.md +++ b/docs/models/components/benefits.md @@ -7,11 +7,11 @@ ```typescript const value: components.BenefitBase = { - createdAt: new Date("2022-01-19T22:47:13.292Z"), - modifiedAt: new Date("2023-09-14T07:38:37.187Z"), + createdAt: new Date("2022-06-04T23:45:24.476Z"), + modifiedAt: new Date("2022-05-28T17:43:25.762Z"), id: "", - type: "github_repository", - description: "why during jealously psst", + type: "downloadables", + description: "yum exterior pfft throughout absent", selectable: false, deletable: false, organizationId: "", @@ -22,10 +22,11 @@ const value: components.BenefitBase = { ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2022-02-27T14:50:27.994Z"), - modifiedAt: new Date("2024-01-18T12:44:39.181Z"), + createdAt: new Date("2022-07-29T12:02:54.413Z"), + modifiedAt: new Date("2022-10-02T04:44:05.671Z"), id: "", - description: "though meanwhile sprinkles sanity idle", + description: + "gee drat phew deliberately phooey across perfectly boo triumphantly", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefittype.md b/docs/models/components/benefittype.md index dad1a7bc..ac9c9713 100644 --- a/docs/models/components/benefittype.md +++ b/docs/models/components/benefittype.md @@ -5,7 +5,7 @@ ```typescript import { BenefitType } from "@polar-sh/sdk/models/components"; -let value: BenefitType = "discord"; +let value: BenefitType = "custom"; ``` ## Values diff --git a/docs/models/components/bylineprofile.md b/docs/models/components/bylineprofile.md index 49bde19b..a37826ae 100644 --- a/docs/models/components/bylineprofile.md +++ b/docs/models/components/bylineprofile.md @@ -7,7 +7,7 @@ import { BylineProfile } from "@polar-sh/sdk/models/components"; let value: BylineProfile = { name: "", - avatarUrl: "https://sophisticated-in-joke.biz", + avatarUrl: "https://difficult-fledgling.name/", }; ``` diff --git a/docs/models/components/checkoutlink.md b/docs/models/components/checkoutlink.md index cf0d9994..9755808f 100644 --- a/docs/models/components/checkoutlink.md +++ b/docs/models/components/checkoutlink.md @@ -8,39 +8,42 @@ Checkout link data. import { CheckoutLink } from "@polar-sh/sdk/models/components"; let value: CheckoutLink = { - createdAt: new Date("2024-04-15T02:43:00.812Z"), - modifiedAt: new Date("2024-04-05T22:09:08.993Z"), + createdAt: new Date("2023-08-24T08:05:58.593Z"), + modifiedAt: new Date("2022-08-23T01:09:24.286Z"), id: "", metadata: { - "key": "", + "key": 735506, }, clientSecret: "", - successUrl: "https://putrid-iridescence.com/", + successUrl: "https://snappy-riser.net", productPriceId: "", productPrice: { - createdAt: new Date("2022-01-15T04:22:51.791Z"), - modifiedAt: new Date("2023-12-07T04:57:49.901Z"), + createdAt: new Date("2023-06-11T06:39:09.896Z"), + modifiedAt: new Date("2022-03-10T01:14:25.475Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 172105, + minimumAmount: 835054, + maximumAmount: 219715, + presetAmount: 12940, + recurringInterval: "year", }, - url: "https://vivacious-chops.name/", + url: "https://beloved-tributary.com/", }; ``` ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | N/A | -| `clientSecret` | *string* | :heavy_check_mark: | Client secret used to access the checkout link. | -| `successUrl` | *string* | :heavy_check_mark: | URL where the customer will be redirected after a successful payment. | -| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | -| `productPrice` | *components.ProductPrice* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `paymentProcessor` | [components.PaymentProcessor](../../models/components/paymentprocessor.md) | :heavy_check_mark: | N/A | +| `clientSecret` | *string* | :heavy_check_mark: | Client secret used to access the checkout link. | +| `successUrl` | *string* | :heavy_check_mark: | URL where the customer will be redirected after a successful payment. | +| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | +| `productPrice` | *components.ProductPrice* | :heavy_check_mark: | N/A | +| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/checkoutlinkcreate.md b/docs/models/components/checkoutlinkcreate.md index b719cfdc..93b0564d 100644 --- a/docs/models/components/checkoutlinkcreate.md +++ b/docs/models/components/checkoutlinkcreate.md @@ -14,9 +14,9 @@ let value: CheckoutLinkCreate = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `paymentProcessor` | [components.CheckoutLinkCreatePaymentProcessor](../../models/components/checkoutlinkcreatepaymentprocessor.md) | :heavy_check_mark: | Payment processor to use. Currently only Stripe is supported. | -| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | -| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `paymentProcessor` | [components.CheckoutLinkCreatePaymentProcessor](../../models/components/checkoutlinkcreatepaymentprocessor.md) | :heavy_check_mark: | Payment processor to use. Currently only Stripe is supported. | +| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | +| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | \ No newline at end of file diff --git a/docs/models/components/checkoutlinkcreatemetadata.md b/docs/models/components/checkoutlinkcreatemetadata.md new file mode 100644 index 00000000..c4b046b4 --- /dev/null +++ b/docs/models/components/checkoutlinkcreatemetadata.md @@ -0,0 +1,23 @@ +# CheckoutLinkCreateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 367299; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/checkoutlinkmetadata.md b/docs/models/components/checkoutlinkmetadata.md new file mode 100644 index 00000000..7a30c3cf --- /dev/null +++ b/docs/models/components/checkoutlinkmetadata.md @@ -0,0 +1,23 @@ +# CheckoutLinkMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 407877; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/checkoutlinksortproperty.md b/docs/models/components/checkoutlinksortproperty.md index 25aecc00..caa81d84 100644 --- a/docs/models/components/checkoutlinksortproperty.md +++ b/docs/models/components/checkoutlinksortproperty.md @@ -5,7 +5,7 @@ ```typescript import { CheckoutLinkSortProperty } from "@polar-sh/sdk/models/components"; -let value: CheckoutLinkSortProperty = "created_at"; +let value: CheckoutLinkSortProperty = "-created_at"; ``` ## Values diff --git a/docs/models/components/checkoutlinkupdate.md b/docs/models/components/checkoutlinkupdate.md index 9131cde5..c0ad6a27 100644 --- a/docs/models/components/checkoutlinkupdate.md +++ b/docs/models/components/checkoutlinkupdate.md @@ -12,7 +12,7 @@ let value: CheckoutLinkUpdate = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | \ No newline at end of file diff --git a/docs/models/components/checkoutlinkupdatemetadata.md b/docs/models/components/checkoutlinkupdatemetadata.md new file mode 100644 index 00000000..92083735 --- /dev/null +++ b/docs/models/components/checkoutlinkupdatemetadata.md @@ -0,0 +1,23 @@ +# CheckoutLinkUpdateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 44740; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/checkoutproduct.md b/docs/models/components/checkoutproduct.md index 9ddc4ecb..0c174143 100644 --- a/docs/models/components/checkoutproduct.md +++ b/docs/models/components/checkoutproduct.md @@ -8,38 +8,38 @@ Product data for a checkout session. import { CheckoutProduct } from "@polar-sh/sdk/models/components"; let value: CheckoutProduct = { - createdAt: new Date("2024-04-24T06:18:14.536Z"), - modifiedAt: new Date("2022-09-28T06:11:19.187Z"), + createdAt: new Date("2024-12-16T18:47:24.230Z"), + modifiedAt: new Date("2024-01-01T11:35:03.806Z"), id: "", name: "", - description: - "covenant precious mozzarella cricket help knowledgeably whoever", + description: "helpful submitter woot", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-06-24T16:06:28.408Z"), - modifiedAt: new Date("2022-03-10T01:13:51.874Z"), + createdAt: new Date("2023-06-19T17:26:23.980Z"), + modifiedAt: new Date("2023-12-06T02:22:06.346Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 839373, - maximumAmount: 780488, - presetAmount: 393289, + priceAmount: 569604, }, ], benefits: [ { - createdAt: new Date("2023-12-24T15:51:09.728Z"), - modifiedAt: new Date("2023-05-26T06:35:27.544Z"), + createdAt: new Date("2024-01-20T16:48:57.666Z"), + modifiedAt: new Date("2024-06-23T05:40:17.320Z"), id: "", - type: "articles", - description: "arrogantly fail upon private whoa", + description: + "supportive patiently contrast spectacles positively that till uh-huh", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -47,19 +47,19 @@ let value: CheckoutProduct = { id: "", organizationId: "", name: "", - path: "/sys", + path: "/usr/libdata", mimeType: "", - size: 782608, + size: 95862, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-09T00:32:24.908Z"), + lastModifiedAt: new Date("2024-08-25T15:14:01.863Z"), version: "", isUploaded: false, - createdAt: new Date("2024-09-30T13:32:34.699Z"), + createdAt: new Date("2023-02-18T20:51:07.229Z"), sizeReadable: "", - publicUrl: "https://lucky-pantyhose.name/", + publicUrl: "https://odd-fog.net/", }, ], }; diff --git a/docs/models/components/checkoutproductbenefits.md b/docs/models/components/checkoutproductbenefits.md index 95c24ece..a9216b1d 100644 --- a/docs/models/components/checkoutproductbenefits.md +++ b/docs/models/components/checkoutproductbenefits.md @@ -7,11 +7,12 @@ ```typescript const value: components.BenefitBase = { - createdAt: new Date("2023-12-06T08:47:09.306Z"), - modifiedAt: new Date("2023-05-27T10:58:25.218Z"), + createdAt: new Date("2023-11-12T05:07:40.672Z"), + modifiedAt: new Date("2023-12-04T20:46:32.398Z"), id: "", - type: "downloadables", - description: "about sternly translation how", + type: "license_keys", + description: + "waver even toothpick woefully mysteriously badly whereas justly strategy neaten", selectable: false, deletable: false, organizationId: "", @@ -22,10 +23,10 @@ const value: components.BenefitBase = { ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2024-12-02T12:30:01.615Z"), - modifiedAt: new Date("2022-09-03T13:07:24.254Z"), + createdAt: new Date("2022-05-16T23:24:22.710Z"), + modifiedAt: new Date("2024-05-11T15:36:51.992Z"), id: "", - description: "quarrelsomely materialise blah lost wherever", + description: "while ha gift wherever ah arrogantly fail", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/checkoutproductinput.md b/docs/models/components/checkoutproductinput.md deleted file mode 100644 index a7573061..00000000 --- a/docs/models/components/checkoutproductinput.md +++ /dev/null @@ -1,77 +0,0 @@ -# CheckoutProductInput - -Product data for a checkout session. - -## Example Usage - -```typescript -import { CheckoutProductInput } from "@polar-sh/sdk/models/components"; - -let value: CheckoutProductInput = { - createdAt: new Date("2024-01-13T22:28:31.850Z"), - modifiedAt: new Date("2022-11-08T19:50:53.693Z"), - id: "", - name: "", - description: "why hmph whoever recent aha crossly unfortunate toward", - isRecurring: false, - isArchived: false, - organizationId: "", - prices: [ - { - createdAt: new Date("2024-03-27T18:09:35.560Z"), - modifiedAt: new Date("2023-02-06T10:05:18.965Z"), - id: "", - isArchived: false, - productId: "", - }, - ], - benefits: [ - { - createdAt: new Date("2023-02-10T05:06:21.763Z"), - modifiedAt: new Date("2024-10-07T00:51:30.483Z"), - id: "", - description: "when seal cannon", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, - }, - ], - medias: [ - { - id: "", - organizationId: "", - name: "", - path: "/usr/ports", - mimeType: "", - size: 678419, - storageVersion: "", - checksumEtag: "", - checksumSha256Base64: "", - checksumSha256Hex: "", - lastModifiedAt: new Date("2024-02-20T05:44:31.280Z"), - version: "", - isUploaded: false, - createdAt: new Date("2023-06-19T05:19:44.942Z"), - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the product. | -| `name` | *string* | :heavy_check_mark: | The name of the product. | -| `description` | *string* | :heavy_check_mark: | The description of the product. | -| `isRecurring` | *boolean* | :heavy_check_mark: | Whether the product is a subscription tier. | -| `isArchived` | *boolean* | :heavy_check_mark: | Whether the product is archived and no longer available. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the product. | -| `prices` | *components.ProductPrice*[] | :heavy_check_mark: | List of prices for this product. | -| `benefits` | *components.CheckoutProductBenefits*[] | :heavy_check_mark: | List of benefits granted by the product. | -| `medias` | [components.ProductMediaFileReadInput](../../models/components/productmediafilereadinput.md)[] | :heavy_check_mark: | List of medias associated to the product. | \ No newline at end of file diff --git a/docs/models/components/checkoutpublic.md b/docs/models/components/checkoutpublic.md index 8ea9a5b5..ae1c38f2 100644 --- a/docs/models/components/checkoutpublic.md +++ b/docs/models/components/checkoutpublic.md @@ -8,59 +8,57 @@ Checkout session data retrieved using the client secret. import { CheckoutPublic } from "@polar-sh/sdk/models/components"; let value: CheckoutPublic = { - createdAt: new Date("2022-05-07T01:41:54.981Z"), - modifiedAt: new Date("2023-02-08T16:54:04.413Z"), + createdAt: new Date("2023-02-16T02:40:03.243Z"), + modifiedAt: new Date("2022-04-08T19:32:02.022Z"), id: "", - status: "expired", + status: "confirmed", clientSecret: "", - url: "https://memorable-tomography.info", - expiresAt: new Date("2022-03-15T09:25:01.845Z"), - successUrl: "https://inconsequential-marathon.name/", + url: "https://blind-lobster.info", + expiresAt: new Date("2024-04-12T08:56:14.488Z"), + successUrl: "https://decent-provision.net/", embedOrigin: "", - amount: 58904, - taxAmount: 617530, - currency: "Bahamian Dollar", - totalAmount: 431813, + amount: 517683, + taxAmount: 4558, + currency: "Turkish Lira", + totalAmount: 987398, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Brett.Kassulke28@hotmail.com", + customerEmail: "Torrey.Paucek7@hotmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Democratic People's Republic of Korea", + country: "Japan", }, customerTaxId: "", paymentProcessorMetadata: {}, product: { - createdAt: new Date("2023-09-21T10:09:14.320Z"), - modifiedAt: new Date("2024-04-01T05:07:23.085Z"), + createdAt: new Date("2023-05-19T15:37:41.330Z"), + modifiedAt: new Date("2023-02-28T06:12:59.898Z"), id: "", name: "", - description: - "ghost round stock brightly yowza while before victoriously mechanically wrongly", + description: "buzzing eek swiftly", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-02-12T05:28:18.955Z"), - modifiedAt: new Date("2022-09-05T04:07:53.610Z"), + createdAt: new Date("2024-01-23T22:36:36.484Z"), + modifiedAt: new Date("2022-06-11T07:02:23.326Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 778856, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2023-07-08T21:03:19.722Z"), - modifiedAt: new Date("2024-08-14T06:28:14.989Z"), + createdAt: new Date("2024-02-21T02:35:30.835Z"), + modifiedAt: new Date("2022-01-12T13:17:30.759Z"), id: "", - type: "license_keys", - description: "swanling cauliflower whose insert loose reassuringly", + type: "discord", + description: "procrastinate under on ick lovingly paintwork versus", selectable: false, deletable: false, organizationId: "", @@ -71,46 +69,47 @@ let value: CheckoutPublic = { id: "", organizationId: "", name: "", - path: "/media", + path: "/private/var", mimeType: "", - size: 625403, + size: 485972, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-11-28T05:20:13.228Z"), + lastModifiedAt: new Date("2023-01-15T17:02:16.943Z"), version: "", isUploaded: false, - createdAt: new Date("2023-07-16T02:59:18.334Z"), + createdAt: new Date("2023-11-28T02:55:43.193Z"), sizeReadable: "", - publicUrl: "https://serpentine-fat.info/", + publicUrl: "https://sinful-sustenance.info/", }, ], }, productPrice: { - createdAt: new Date("2022-04-01T14:34:31.000Z"), - modifiedAt: new Date("2023-09-12T15:43:53.558Z"), + createdAt: new Date("2023-11-17T10:35:42.718Z"), + modifiedAt: new Date("2023-11-28T05:20:13.228Z"), id: "", isArchived: false, productId: "", + priceCurrency: "", + priceAmount: 511975, }, organization: { - createdAt: new Date("2022-04-06T06:20:48.081Z"), - modifiedAt: new Date("2023-12-09T10:05:15.071Z"), + createdAt: new Date("2022-06-25T04:35:26.551Z"), + modifiedAt: new Date("2024-03-05T22:33:02.662Z"), id: "", name: "", slug: "", - avatarUrl: "https://sturdy-scaffold.org/", + avatarUrl: "https://ill-fated-step-mother.net/", bio: "", - company: "Daniel - Denesik", + company: "Mann - Bogisich", blog: "", location: "", - email: "Estevan_Block@yahoo.com", + email: "Godfrey_Sauer29@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 587824, + pledgeMinimumAmount: 185318, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 530259, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 598919, profileSettings: {}, featureSettings: {}, }, @@ -118,25 +117,18 @@ let value: CheckoutPublic = { { customFieldId: "", customField: { - createdAt: new Date("2023-08-22T02:15:34.328Z"), - modifiedAt: new Date("2024-10-08T00:41:43.929Z"), + createdAt: new Date("2024-09-20T21:54:34.005Z"), + modifiedAt: new Date("2022-03-28T23:23:12.546Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", - properties: { - options: [ - { - value: "", - label: "", - }, - ], - }, + properties: {}, }, - order: 551678, + order: 489711, required: false, }, ], @@ -151,7 +143,7 @@ let value: CheckoutPublic = { | `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | | `id` | *string* | :heavy_check_mark: | The ID of the object. | | `customFieldData` | [components.CheckoutPublicCustomFieldData](../../models/components/checkoutpubliccustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | N/A | +| `paymentProcessor` | [components.PaymentProcessor](../../models/components/paymentprocessor.md) | :heavy_check_mark: | N/A | | `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | N/A | | `clientSecret` | *string* | :heavy_check_mark: | Client secret used to update and complete the checkout session from the client. | | `url` | *string* | :heavy_check_mark: | URL where the customer can access the checkout session. | diff --git a/docs/models/components/checkoutsortproperty.md b/docs/models/components/checkoutsortproperty.md index 73bb9e42..3049472b 100644 --- a/docs/models/components/checkoutsortproperty.md +++ b/docs/models/components/checkoutsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { CheckoutSortProperty } from "@polar-sh/sdk/models/components"; -let value: CheckoutSortProperty = "created_at"; +let value: CheckoutSortProperty = "-created_at"; ``` ## Values diff --git a/docs/models/components/checkoutstatus.md b/docs/models/components/checkoutstatus.md index adc1226c..12a54523 100644 --- a/docs/models/components/checkoutstatus.md +++ b/docs/models/components/checkoutstatus.md @@ -5,7 +5,7 @@ ```typescript import { CheckoutStatus } from "@polar-sh/sdk/models/components"; -let value: CheckoutStatus = "failed"; +let value: CheckoutStatus = "open"; ``` ## Values diff --git a/docs/models/components/checkoutupdate.md b/docs/models/components/checkoutupdate.md index 03bb20fd..43f674eb 100644 --- a/docs/models/components/checkoutupdate.md +++ b/docs/models/components/checkoutupdate.md @@ -12,16 +12,16 @@ let value: CheckoutUpdate = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `customFieldData` | [components.CustomFieldData](../../models/components/customfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `productPriceId` | *string* | :heavy_minus_sign: | ID of the product price to checkout. Must correspond to a price linked to the same product. | -| `amount` | *number* | :heavy_minus_sign: | N/A | -| `customerName` | *string* | :heavy_minus_sign: | N/A | -| `customerEmail` | *string* | :heavy_minus_sign: | N/A | -| `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_minus_sign: | N/A | -| `customerTaxId` | *string* | :heavy_minus_sign: | N/A | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `customerIpAddress` | *string* | :heavy_minus_sign: | N/A | -| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | -| `embedOrigin` | *string* | :heavy_minus_sign: | If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `customFieldData` | [components.CustomFieldData](../../models/components/customfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | +| `productPriceId` | *string* | :heavy_minus_sign: | ID of the product price to checkout. Must correspond to a price linked to the same product. | +| `amount` | *number* | :heavy_minus_sign: | N/A | +| `customerName` | *string* | :heavy_minus_sign: | N/A | +| `customerEmail` | *string* | :heavy_minus_sign: | N/A | +| `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_minus_sign: | N/A | +| `customerTaxId` | *string* | :heavy_minus_sign: | N/A | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `customerIpAddress` | *string* | :heavy_minus_sign: | N/A | +| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | +| `embedOrigin` | *string* | :heavy_minus_sign: | If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page. | \ No newline at end of file diff --git a/docs/models/components/checkoutupdatemetadata.md b/docs/models/components/checkoutupdatemetadata.md new file mode 100644 index 00000000..e09913cd --- /dev/null +++ b/docs/models/components/checkoutupdatemetadata.md @@ -0,0 +1,23 @@ +# CheckoutUpdateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 592279; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/currencyamount.md b/docs/models/components/currencyamount.md index 13d0d683..880b91cc 100644 --- a/docs/models/components/currencyamount.md +++ b/docs/models/components/currencyamount.md @@ -6,8 +6,8 @@ import { CurrencyAmount } from "@polar-sh/sdk/models/components"; let value: CurrencyAmount = { - currency: "Philippine Peso", - amount: 637764, + currency: "Sri Lanka Rupee", + amount: 971348, }; ``` diff --git a/docs/models/components/customfield.md b/docs/models/components/customfield.md index a978c824..48d05071 100644 --- a/docs/models/components/customfield.md +++ b/docs/models/components/customfield.md @@ -7,8 +7,8 @@ ```typescript const value: components.CustomFieldCheckbox = { - createdAt: new Date("2024-10-19T21:29:25.463Z"), - modifiedAt: new Date("2024-02-23T12:12:14.708Z"), + createdAt: new Date("2022-04-24T05:56:52.679Z"), + modifiedAt: new Date("2022-09-20T16:27:39.107Z"), id: "", metadata: { "key": "", @@ -24,8 +24,8 @@ const value: components.CustomFieldCheckbox = { ```typescript const value: components.CustomFieldDate = { - createdAt: new Date("2023-10-18T08:22:17.195Z"), - modifiedAt: new Date("2024-02-15T22:04:01.869Z"), + createdAt: new Date("2023-07-06T00:01:05.389Z"), + modifiedAt: new Date("2022-10-16T17:25:09.716Z"), id: "", metadata: { "key": "", @@ -41,11 +41,11 @@ const value: components.CustomFieldDate = { ```typescript const value: components.CustomFieldNumber = { - createdAt: new Date("2022-01-03T23:42:04.530Z"), - modifiedAt: new Date("2022-06-09T11:47:38.531Z"), + createdAt: new Date("2024-08-23T10:42:20.718Z"), + modifiedAt: new Date("2022-08-06T17:41:01.540Z"), id: "", metadata: { - "key": "", + "key": 271465, }, slug: "", name: "", @@ -58,11 +58,11 @@ const value: components.CustomFieldNumber = { ```typescript const value: components.CustomFieldSelect = { - createdAt: new Date("2024-01-29T03:47:52.443Z"), - modifiedAt: new Date("2024-02-23T14:31:52.929Z"), + createdAt: new Date("2023-10-17T20:37:43.818Z"), + modifiedAt: new Date("2023-12-19T02:37:07.150Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", @@ -82,11 +82,11 @@ const value: components.CustomFieldSelect = { ```typescript const value: components.CustomFieldText = { - createdAt: new Date("2024-07-23T20:35:59.037Z"), - modifiedAt: new Date("2023-10-04T18:18:47.556Z"), + createdAt: new Date("2022-11-21T02:46:43.586Z"), + modifiedAt: new Date("2022-02-21T18:59:55.083Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", diff --git a/docs/models/components/customfieldcheckbox.md b/docs/models/components/customfieldcheckbox.md index 60d5799f..18577116 100644 --- a/docs/models/components/customfieldcheckbox.md +++ b/docs/models/components/customfieldcheckbox.md @@ -8,11 +8,11 @@ Schema for a custom field of type checkbox. import { CustomFieldCheckbox } from "@polar-sh/sdk/models/components"; let value: CustomFieldCheckbox = { - createdAt: new Date("2022-02-25T05:51:19.973Z"), - modifiedAt: new Date("2024-05-18T02:46:56.122Z"), + createdAt: new Date("2024-11-22T22:46:02.766Z"), + modifiedAt: new Date("2024-05-17T18:00:28.664Z"), id: "", metadata: { - "key": "", + "key": 917168, }, slug: "", name: "", @@ -23,14 +23,14 @@ let value: CustomFieldCheckbox = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `type` | [components.CustomFieldCheckboxType](../../models/components/customfieldcheckboxtype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | -| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `type` | [components.CustomFieldCheckboxType](../../models/components/customfieldcheckboxtype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | +| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcheckboxmetadata.md b/docs/models/components/customfieldcheckboxmetadata.md new file mode 100644 index 00000000..560afb11 --- /dev/null +++ b/docs/models/components/customfieldcheckboxmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCheckboxMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 753496; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldcreatecheckbox.md b/docs/models/components/customfieldcreatecheckbox.md index bbd99a99..55b2e107 100644 --- a/docs/models/components/customfieldcreatecheckbox.md +++ b/docs/models/components/customfieldcreatecheckbox.md @@ -16,11 +16,11 @@ let value: CustomFieldCreateCheckbox = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `type` | [components.CustomFieldCreateCheckboxType](../../models/components/customfieldcreatecheckboxtype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | -| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `type` | [components.CustomFieldCreateCheckboxType](../../models/components/customfieldcreatecheckboxtype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | +| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatecheckboxmetadata.md b/docs/models/components/customfieldcreatecheckboxmetadata.md new file mode 100644 index 00000000..814dde99 --- /dev/null +++ b/docs/models/components/customfieldcreatecheckboxmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCreateCheckboxMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 260562; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldcreatedate.md b/docs/models/components/customfieldcreatedate.md index c5e8bf93..225275de 100644 --- a/docs/models/components/customfieldcreatedate.md +++ b/docs/models/components/customfieldcreatedate.md @@ -16,11 +16,11 @@ let value: CustomFieldCreateDate = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `type` | [components.CustomFieldCreateDateType](../../models/components/customfieldcreatedatetype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | -| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `type` | [components.CustomFieldCreateDateType](../../models/components/customfieldcreatedatetype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | +| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatedatemetadata.md b/docs/models/components/customfieldcreatedatemetadata.md new file mode 100644 index 00000000..0a263a01 --- /dev/null +++ b/docs/models/components/customfieldcreatedatemetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCreateDateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 570826; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldcreatenumber.md b/docs/models/components/customfieldcreatenumber.md index 4eedc262..602dee12 100644 --- a/docs/models/components/customfieldcreatenumber.md +++ b/docs/models/components/customfieldcreatenumber.md @@ -16,11 +16,11 @@ let value: CustomFieldCreateNumber = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `type` | [components.CustomFieldCreateNumberType](../../models/components/customfieldcreatenumbertype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | -| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `type` | [components.CustomFieldCreateNumberType](../../models/components/customfieldcreatenumbertype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | +| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatenumbermetadata.md b/docs/models/components/customfieldcreatenumbermetadata.md new file mode 100644 index 00000000..effc4547 --- /dev/null +++ b/docs/models/components/customfieldcreatenumbermetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCreateNumberMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 139067; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldcreateselect.md b/docs/models/components/customfieldcreateselect.md index 8e5e366a..53d17368 100644 --- a/docs/models/components/customfieldcreateselect.md +++ b/docs/models/components/customfieldcreateselect.md @@ -23,11 +23,11 @@ let value: CustomFieldCreateSelect = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `type` | [components.CustomFieldCreateSelectType](../../models/components/customfieldcreateselecttype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | -| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `type` | [components.CustomFieldCreateSelectType](../../models/components/customfieldcreateselecttype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | +| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcreateselectmetadata.md b/docs/models/components/customfieldcreateselectmetadata.md new file mode 100644 index 00000000..07b06133 --- /dev/null +++ b/docs/models/components/customfieldcreateselectmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCreateSelectMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 274048; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldcreatetext.md b/docs/models/components/customfieldcreatetext.md index a5ca58db..5576b72c 100644 --- a/docs/models/components/customfieldcreatetext.md +++ b/docs/models/components/customfieldcreatetext.md @@ -16,11 +16,11 @@ let value: CustomFieldCreateText = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `type` | [components.CustomFieldCreateTextType](../../models/components/customfieldcreatetexttype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | -| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `type` | [components.CustomFieldCreateTextType](../../models/components/customfieldcreatetexttype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the custom field. **Required unless you use an organization token.** | +| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldcreatetextmetadata.md b/docs/models/components/customfieldcreatetextmetadata.md new file mode 100644 index 00000000..5c30369d --- /dev/null +++ b/docs/models/components/customfieldcreatetextmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldCreateTextMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 593682; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfielddate.md b/docs/models/components/customfielddate.md index 0f9c09e9..9a9ead47 100644 --- a/docs/models/components/customfielddate.md +++ b/docs/models/components/customfielddate.md @@ -8,11 +8,11 @@ Schema for a custom field of type date. import { CustomFieldDate } from "@polar-sh/sdk/models/components"; let value: CustomFieldDate = { - createdAt: new Date("2023-05-10T22:42:04.682Z"), - modifiedAt: new Date("2023-02-16T15:35:40.674Z"), + createdAt: new Date("2023-09-25T05:13:11.902Z"), + modifiedAt: new Date("2022-06-06T12:51:23.470Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", @@ -23,14 +23,14 @@ let value: CustomFieldDate = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `type` | [components.CustomFieldDateType](../../models/components/customfielddatetype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | -| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `type` | [components.CustomFieldDateType](../../models/components/customfielddatetype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | +| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfielddatemetadata.md b/docs/models/components/customfielddatemetadata.md new file mode 100644 index 00000000..62483095 --- /dev/null +++ b/docs/models/components/customfielddatemetadata.md @@ -0,0 +1,23 @@ +# CustomFieldDateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 616322; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldnumber.md b/docs/models/components/customfieldnumber.md index 6ad996e9..0b5b17b9 100644 --- a/docs/models/components/customfieldnumber.md +++ b/docs/models/components/customfieldnumber.md @@ -8,11 +8,11 @@ Schema for a custom field of type number. import { CustomFieldNumber } from "@polar-sh/sdk/models/components"; let value: CustomFieldNumber = { - createdAt: new Date("2024-06-13T22:41:28.103Z"), - modifiedAt: new Date("2024-07-22T19:36:51.710Z"), + createdAt: new Date("2023-11-24T19:19:10.725Z"), + modifiedAt: new Date("2023-11-02T10:33:28.631Z"), id: "", metadata: { - "key": "", + "key": 675078, }, slug: "", name: "", @@ -23,14 +23,14 @@ let value: CustomFieldNumber = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `type` | [components.CustomFieldNumberType](../../models/components/customfieldnumbertype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | -| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `type` | [components.CustomFieldNumberType](../../models/components/customfieldnumbertype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | +| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldnumbermetadata.md b/docs/models/components/customfieldnumbermetadata.md new file mode 100644 index 00000000..6556ec62 --- /dev/null +++ b/docs/models/components/customfieldnumbermetadata.md @@ -0,0 +1,23 @@ +# CustomFieldNumberMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 486003; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldselect.md b/docs/models/components/customfieldselect.md index b82a35ea..d50db7b4 100644 --- a/docs/models/components/customfieldselect.md +++ b/docs/models/components/customfieldselect.md @@ -8,11 +8,11 @@ Schema for a custom field of type select. import { CustomFieldSelect } from "@polar-sh/sdk/models/components"; let value: CustomFieldSelect = { - createdAt: new Date("2024-01-08T16:05:33.519Z"), - modifiedAt: new Date("2023-04-27T08:46:07.096Z"), + createdAt: new Date("2022-12-06T21:39:04.890Z"), + modifiedAt: new Date("2022-07-12T08:26:30.494Z"), id: "", metadata: { - "key": "", + "key": 736174, }, slug: "", name: "", @@ -30,14 +30,14 @@ let value: CustomFieldSelect = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `type` | [components.CustomFieldSelectType](../../models/components/customfieldselecttype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | -| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `type` | [components.CustomFieldSelectType](../../models/components/customfieldselecttype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | +| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldselectmetadata.md b/docs/models/components/customfieldselectmetadata.md new file mode 100644 index 00000000..32722f23 --- /dev/null +++ b/docs/models/components/customfieldselectmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldSelectMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 654263; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldtext.md b/docs/models/components/customfieldtext.md index 10801ebd..361a4433 100644 --- a/docs/models/components/customfieldtext.md +++ b/docs/models/components/customfieldtext.md @@ -8,11 +8,11 @@ Schema for a custom field of type text. import { CustomFieldText } from "@polar-sh/sdk/models/components"; let value: CustomFieldText = { - createdAt: new Date("2023-09-03T17:54:18.563Z"), - modifiedAt: new Date("2023-03-12T19:27:47.119Z"), + createdAt: new Date("2024-08-29T07:15:18.011Z"), + modifiedAt: new Date("2022-04-01T12:58:28.992Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", @@ -23,14 +23,14 @@ let value: CustomFieldText = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `type` | [components.CustomFieldTextType](../../models/components/customfieldtexttype.md) | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. | -| `name` | *string* | :heavy_check_mark: | Name of the custom field. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | -| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | +| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *string* | :heavy_check_mark: | The ID of the object. | +| `metadata` | Record | :heavy_check_mark: | N/A | +| `type` | [components.CustomFieldTextType](../../models/components/customfieldtexttype.md) | :heavy_check_mark: | N/A | +| `slug` | *string* | :heavy_check_mark: | Identifier of the custom field. It'll be used as key when storing the value. | +| `name` | *string* | :heavy_check_mark: | Name of the custom field. | +| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the custom field. | +| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldtextmetadata.md b/docs/models/components/customfieldtextmetadata.md new file mode 100644 index 00000000..e68ba583 --- /dev/null +++ b/docs/models/components/customfieldtextmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldTextMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 969294; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldupdatecheckbox.md b/docs/models/components/customfieldupdatecheckbox.md index b0cef91a..32d2a9e6 100644 --- a/docs/models/components/customfieldupdatecheckbox.md +++ b/docs/models/components/customfieldupdatecheckbox.md @@ -12,10 +12,10 @@ let value: CustomFieldUpdateCheckbox = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `slug` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomFieldUpdateCheckboxType](../../models/components/customfieldupdatecheckboxtype.md) | :heavy_check_mark: | N/A | -| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `slug` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomFieldUpdateCheckboxType](../../models/components/customfieldupdatecheckboxtype.md) | :heavy_check_mark: | N/A | +| `properties` | [components.CustomFieldCheckboxProperties](../../models/components/customfieldcheckboxproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldupdatecheckboxmetadata.md b/docs/models/components/customfieldupdatecheckboxmetadata.md new file mode 100644 index 00000000..161b11b6 --- /dev/null +++ b/docs/models/components/customfieldupdatecheckboxmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldUpdateCheckboxMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 306275; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldupdatedate.md b/docs/models/components/customfieldupdatedate.md index c4040248..75bb31db 100644 --- a/docs/models/components/customfieldupdatedate.md +++ b/docs/models/components/customfieldupdatedate.md @@ -12,10 +12,10 @@ let value: CustomFieldUpdateDate = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `slug` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomFieldUpdateDateType](../../models/components/customfieldupdatedatetype.md) | :heavy_check_mark: | N/A | -| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `slug` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomFieldUpdateDateType](../../models/components/customfieldupdatedatetype.md) | :heavy_check_mark: | N/A | +| `properties` | [components.CustomFieldDateProperties](../../models/components/customfielddateproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldupdatedatemetadata.md b/docs/models/components/customfieldupdatedatemetadata.md new file mode 100644 index 00000000..2b3eae0f --- /dev/null +++ b/docs/models/components/customfieldupdatedatemetadata.md @@ -0,0 +1,23 @@ +# CustomFieldUpdateDateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 617330; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldupdatenumber.md b/docs/models/components/customfieldupdatenumber.md index ee790a24..0e4e7538 100644 --- a/docs/models/components/customfieldupdatenumber.md +++ b/docs/models/components/customfieldupdatenumber.md @@ -12,10 +12,10 @@ let value: CustomFieldUpdateNumber = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `slug` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomFieldUpdateNumberType](../../models/components/customfieldupdatenumbertype.md) | :heavy_check_mark: | N/A | -| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `slug` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomFieldUpdateNumberType](../../models/components/customfieldupdatenumbertype.md) | :heavy_check_mark: | N/A | +| `properties` | [components.CustomFieldNumberProperties](../../models/components/customfieldnumberproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldupdatenumbermetadata.md b/docs/models/components/customfieldupdatenumbermetadata.md new file mode 100644 index 00000000..e9849e9a --- /dev/null +++ b/docs/models/components/customfieldupdatenumbermetadata.md @@ -0,0 +1,23 @@ +# CustomFieldUpdateNumberMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 653738; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldupdateselect.md b/docs/models/components/customfieldupdateselect.md index 94b0c3f8..51882e64 100644 --- a/docs/models/components/customfieldupdateselect.md +++ b/docs/models/components/customfieldupdateselect.md @@ -12,10 +12,10 @@ let value: CustomFieldUpdateSelect = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `slug` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomFieldUpdateSelectType](../../models/components/customfieldupdateselecttype.md) | :heavy_check_mark: | N/A | -| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `slug` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomFieldUpdateSelectType](../../models/components/customfieldupdateselecttype.md) | :heavy_check_mark: | N/A | +| `properties` | [components.CustomFieldSelectProperties](../../models/components/customfieldselectproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldupdateselectmetadata.md b/docs/models/components/customfieldupdateselectmetadata.md new file mode 100644 index 00000000..ce36fcff --- /dev/null +++ b/docs/models/components/customfieldupdateselectmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldUpdateSelectMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 28751; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/customfieldupdatetext.md b/docs/models/components/customfieldupdatetext.md index 29c78a34..e14c6ad3 100644 --- a/docs/models/components/customfieldupdatetext.md +++ b/docs/models/components/customfieldupdatetext.md @@ -12,10 +12,10 @@ let value: CustomFieldUpdateText = {}; ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `slug` | *string* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomFieldUpdateTextType](../../models/components/customfieldupdatetexttype.md) | :heavy_check_mark: | N/A | -| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `slug` | *string* | :heavy_minus_sign: | N/A | +| `type` | [components.CustomFieldUpdateTextType](../../models/components/customfieldupdatetexttype.md) | :heavy_check_mark: | N/A | +| `properties` | [components.CustomFieldTextProperties](../../models/components/customfieldtextproperties.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/customfieldupdatetextmetadata.md b/docs/models/components/customfieldupdatetextmetadata.md new file mode 100644 index 00000000..0242406a --- /dev/null +++ b/docs/models/components/customfieldupdatetextmetadata.md @@ -0,0 +1,23 @@ +# CustomFieldUpdateTextMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 433878; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/donationorganization.md b/docs/models/components/donationorganization.md deleted file mode 100644 index c79c2c73..00000000 --- a/docs/models/components/donationorganization.md +++ /dev/null @@ -1,24 +0,0 @@ -# DonationOrganization - -## Example Usage - -```typescript -import { DonationOrganization } from "@polar-sh/sdk/models/components"; - -let value: DonationOrganization = { - id: "", - name: "", - avatarUrl: "https://scaly-cannon.com", - isPersonal: false, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `platform` | [components.Platforms](../../models/components/platforms.md) | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `avatarUrl` | *string* | :heavy_check_mark: | N/A | -| `isPersonal` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/donor.md b/docs/models/components/donor.md deleted file mode 100644 index 6571c990..00000000 --- a/docs/models/components/donor.md +++ /dev/null @@ -1,26 +0,0 @@ -# Donor - - -## Supported Types - -### `components.DonationOrganization` - -```typescript -const value: components.DonationOrganization = { - id: "", - name: "", - avatarUrl: "https://subdued-inspection.com/", - isPersonal: false, -}; -``` - -### `components.DonationUser` - -```typescript -const value: components.DonationUser = { - id: "", - publicName: "", - avatarUrl: "https://hollow-blowgun.info/", -}; -``` - diff --git a/docs/models/components/downloadablefilecreate.md b/docs/models/components/downloadablefilecreate.md index 6a953209..21a9abcf 100644 --- a/docs/models/components/downloadablefilecreate.md +++ b/docs/models/components/downloadablefilecreate.md @@ -10,13 +10,13 @@ import { DownloadableFileCreate } from "@polar-sh/sdk/models/components"; let value: DownloadableFileCreate = { name: "", mimeType: "", - size: 735432, + size: 389104, upload: { parts: [ { - number: 628062, - chunkStart: 306, - chunkEnd: 16877, + number: 835707, + chunkStart: 623092, + chunkEnd: 71075, }, ], }, diff --git a/docs/models/components/downloadablefileread.md b/docs/models/components/downloadablefileread.md index a3dc7168..c5756c68 100644 --- a/docs/models/components/downloadablefileread.md +++ b/docs/models/components/downloadablefileread.md @@ -11,17 +11,17 @@ let value: DownloadableFileRead = { id: "", organizationId: "", name: "", - path: "/usr/ports", + path: "/System", mimeType: "", - size: 973257, + size: 987897, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-02-08T08:31:50.784Z"), + lastModifiedAt: new Date("2024-08-28T08:37:13.354Z"), version: "", isUploaded: false, - createdAt: new Date("2023-10-24T19:46:51.933Z"), + createdAt: new Date("2023-07-22T06:05:22.331Z"), sizeReadable: "", }; ``` diff --git a/docs/models/components/fileread.md b/docs/models/components/fileread.md index db5bdb4a..1a35ebf5 100644 --- a/docs/models/components/fileread.md +++ b/docs/models/components/fileread.md @@ -10,17 +10,17 @@ const value: components.DownloadableFileRead = { id: "", organizationId: "", name: "", - path: "/var/log", + path: "/tmp", mimeType: "", - size: 806335, + size: 587824, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-07-17T21:53:55.767Z"), + lastModifiedAt: new Date("2023-08-05T03:55:20.343Z"), version: "", isUploaded: false, - createdAt: new Date("2024-09-10T10:14:58.997Z"), + createdAt: new Date("2024-02-05T09:19:43.771Z"), sizeReadable: "", }; ``` @@ -32,19 +32,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/home/user", + path: "/root", mimeType: "", - size: 342554, + size: 922472, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-09-12T17:07:56.815Z"), + lastModifiedAt: new Date("2023-08-28T15:19:37.990Z"), version: "", isUploaded: false, - createdAt: new Date("2022-06-13T12:56:45.154Z"), + createdAt: new Date("2024-10-04T22:53:14.732Z"), sizeReadable: "", - publicUrl: "https://caring-circumference.name/", + publicUrl: "https://these-technologist.biz", }; ``` @@ -55,19 +55,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/opt/include", + path: "/Network", mimeType: "", - size: 423692, + size: 899374, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-07-11T21:53:22.945Z"), + lastModifiedAt: new Date("2022-06-13T12:56:45.154Z"), version: "", isUploaded: false, - createdAt: new Date("2023-12-26T03:47:13.190Z"), + createdAt: new Date("2023-06-22T04:46:16.477Z"), sizeReadable: "", - publicUrl: "https://grouchy-cornet.info/", + publicUrl: "https://crooked-mortise.info/", }; ``` diff --git a/docs/models/components/fileupload.md b/docs/models/components/fileupload.md index ad6f355b..87573583 100644 --- a/docs/models/components/fileupload.md +++ b/docs/models/components/fileupload.md @@ -9,29 +9,29 @@ let value: FileUpload = { id: "", organizationId: "", name: "", - path: "/opt/lib", + path: "/tmp", mimeType: "", - size: 64760, + size: 1789, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-01-31T14:30:14.581Z"), + lastModifiedAt: new Date("2023-02-10T11:23:09.076Z"), upload: { id: "", - path: "/etc/mail", + path: "/net", parts: [ { - number: 37360, - chunkStart: 683453, - chunkEnd: 24684, - url: "https://instructive-cemetery.info/", - expiresAt: new Date("2023-02-06T04:10:00.114Z"), + number: 977934, + chunkStart: 726, + chunkEnd: 736345, + url: "https://better-fowl.com/", + expiresAt: new Date("2022-02-10T22:42:59.328Z"), }, ], }, version: "", - service: "downloadable", + service: "organization_avatar", sizeReadable: "", }; ``` diff --git a/docs/models/components/fileuploadcompleted.md b/docs/models/components/fileuploadcompleted.md index d1da26b4..dcf3ba23 100644 --- a/docs/models/components/fileuploadcompleted.md +++ b/docs/models/components/fileuploadcompleted.md @@ -7,10 +7,10 @@ import { FileUploadCompleted } from "@polar-sh/sdk/models/components"; let value: FileUploadCompleted = { id: "", - path: "/dev", + path: "/var", parts: [ { - number: 467579, + number: 76555, checksumEtag: "", checksumSha256Base64: "", }, diff --git a/docs/models/components/introspecttokenresponse.md b/docs/models/components/introspecttokenresponse.md index 58482183..f90ff434 100644 --- a/docs/models/components/introspecttokenresponse.md +++ b/docs/models/components/introspecttokenresponse.md @@ -10,12 +10,12 @@ let value: IntrospectTokenResponse = { clientId: "", tokenType: "refresh_token", scope: "", - subType: "organization", + subType: "user", sub: "", aud: "", iss: "", - exp: 663724, - iat: 767479, + exp: 829517, + iat: 650918, }; ``` diff --git a/docs/models/components/issue.md b/docs/models/components/issue.md index 910fc4ab..425d6858 100644 --- a/docs/models/components/issue.md +++ b/docs/models/components/issue.md @@ -6,54 +6,52 @@ import { Issue } from "@polar-sh/sdk/models/components"; let value: Issue = { - id: "c5b133a3-44ff-4d77-9572-42eb2650b752", - number: 271639, + id: "d0c8d36b-d7d8-4fe6-8fc8-fb314b86c0db", + number: 389023, title: "", - state: "closed", - issueCreatedAt: new Date("2022-10-02T10:20:48.033Z"), + state: "open", + issueCreatedAt: new Date("2022-01-13T22:03:52.889Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "469d45af-33dc-4506-a8ca-acc71d90c658", + id: "f753cb0c-1f57-40d4-b8e2-d8ed710d7ae4", isPrivate: false, name: "MyOrg", - description: - "sans fluctuate mortally so shirk via big minister pinstripe apologise", + description: "yet beside healthily", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "514e3c65-d6f3-4e48-8105-2730b52f79f1", + id: "59afe908-680f-4041-a856-ce247164e3b3", name: "", - avatarUrl: "https://noteworthy-heartache.com", + avatarUrl: "https://lavish-skean.biz", isPersonal: false, bio: "", prettyName: "", - company: "Kiehn LLC", + company: "Wunsch Group", blog: "", location: "", - email: "Grover_Douglas82@gmail.com", + email: "Elda_Stark@yahoo.com", twitterUsername: "", organizationId: "", }, internalOrganization: { - createdAt: new Date("2023-06-16T23:24:38.141Z"), - modifiedAt: new Date("2024-04-04T07:16:34.900Z"), + createdAt: new Date("2022-07-22T04:14:56.694Z"), + modifiedAt: new Date("2023-09-16T05:19:36.435Z"), id: "", name: "", slug: "", - avatarUrl: "https://yellowish-backbone.com", + avatarUrl: "https://rewarding-atrium.biz/", bio: "", - company: "Abshire - Leannon", + company: "Gottlieb - Schulist", blog: "", location: "", - email: "Heather_Terry26@yahoo.com", + email: "April.Cormier19@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 200824, + pledgeMinimumAmount: 183975, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 264643, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 298735, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/label.md b/docs/models/components/label.md index 81f59d5c..894024f3 100644 --- a/docs/models/components/label.md +++ b/docs/models/components/label.md @@ -7,7 +7,7 @@ import { Label } from "@polar-sh/sdk/models/components"; let value: Label = { name: "", - color: "violet", + color: "blue", }; ``` diff --git a/docs/models/components/listresource.md b/docs/models/components/listresource.md index 275f792c..3e40e445 100644 --- a/docs/models/components/listresource.md +++ b/docs/models/components/listresource.md @@ -8,11 +8,11 @@ import { ListResource } from "@polar-sh/sdk/models/components"; let value: ListResource = { items: [ { - createdAt: new Date("2022-12-11T12:45:41.520Z"), - modifiedAt: new Date("2023-01-20T02:46:22.982Z"), + createdAt: new Date("2023-01-20T02:46:22.982Z"), + modifiedAt: new Date("2023-06-25T19:23:05.706Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", @@ -21,8 +21,8 @@ let value: ListResource = { }, ], pagination: { - totalCount: 493438, - maxPage: 706735, + totalCount: 999978, + maxPage: 518571, }, }; ``` diff --git a/docs/models/components/listresourcearticle.md b/docs/models/components/listresourcearticle.md index d4fcceb7..9b3e1bad 100644 --- a/docs/models/components/listresourcearticle.md +++ b/docs/models/components/listresourcearticle.md @@ -14,46 +14,45 @@ let value: ListResourceArticle = { body: "", byline: { name: "", - avatarUrl: "https://unwieldy-cake.biz/", + avatarUrl: "https://any-deployment.net/", }, visibility: "private", userId: "", organizationId: "", organization: { - createdAt: new Date("2022-10-06T03:14:11.675Z"), - modifiedAt: new Date("2022-06-30T09:23:23.018Z"), + createdAt: new Date("2022-09-13T21:23:26.372Z"), + modifiedAt: new Date("2024-04-27T14:10:19.519Z"), id: "", name: "", slug: "", - avatarUrl: "https://black-worth.org", + avatarUrl: "https://assured-granny.com/", bio: "", - company: "Murphy, Fahey and Schmeler", + company: "Murazik - Stiedemann", blog: "", location: "", - email: "Kristofer.Rohan@gmail.com", + email: "Ethelyn_Spencer47@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 152359, + pledgeMinimumAmount: 150525, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 414720, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 85413, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2024-09-24T21:12:18.195Z"), + publishedAt: new Date("2023-08-01T08:13:26.020Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2023-05-29T14:57:16.680Z"), + paidSubscribersOnlyEndsAt: new Date("2024-01-12T14:17:56.418Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2022-10-03T22:43:14.073Z"), - emailSentToCount: 532335, - ogImageUrl: "https://free-scenario.name/", + notificationsSentAt: new Date("2023-11-10T04:26:31.210Z"), + emailSentToCount: 872886, + ogImageUrl: "https://svelte-character.biz", ogDescription: "", }, ], pagination: { - totalCount: 23984, - maxPage: 569876, + totalCount: 918413, + maxPage: 354705, }, }; ``` diff --git a/docs/models/components/listresourcebenefit.md b/docs/models/components/listresourcebenefit.md index 5b42e1e4..1cb1e984 100644 --- a/docs/models/components/listresourcebenefit.md +++ b/docs/models/components/listresourcebenefit.md @@ -8,19 +8,24 @@ import { ListResourceBenefit } from "@polar-sh/sdk/models/components"; let value: ListResourceBenefit = { items: [ { - createdAt: new Date("2022-10-22T21:26:13.900Z"), - modifiedAt: new Date("2022-07-28T00:35:58.416Z"), + createdAt: new Date("2022-09-03T22:41:08.280Z"), + modifiedAt: new Date("2024-04-27T10:53:52.931Z"), id: "", - description: "yippee carefully shadowy lobster including", + description: + "eek suspiciously preheat lanky politely feminize deduction sometimes", selectable: false, deletable: false, organizationId: "", - properties: {}, + properties: { + guildId: "", + roleId: "", + guildToken: "", + }, }, ], pagination: { - totalCount: 346632, - maxPage: 199238, + totalCount: 806504, + maxPage: 920481, }, }; ``` diff --git a/docs/models/components/listresourcebenefitgrant.md b/docs/models/components/listresourcebenefitgrant.md index d63d41f5..4a98dd1f 100644 --- a/docs/models/components/listresourcebenefitgrant.md +++ b/docs/models/components/listresourcebenefitgrant.md @@ -8,8 +8,8 @@ import { ListResourceBenefitGrant } from "@polar-sh/sdk/models/components"; let value: ListResourceBenefitGrant = { items: [ { - createdAt: new Date("2022-07-21T01:23:23.506Z"), - modifiedAt: new Date("2022-04-20T16:04:19.195Z"), + createdAt: new Date("2024-02-16T09:24:38.615Z"), + modifiedAt: new Date("2022-01-15T11:49:02.871Z"), id: "", isGranted: false, isRevoked: false, @@ -21,8 +21,8 @@ let value: ListResourceBenefitGrant = { }, ], pagination: { - totalCount: 322574, - maxPage: 78738, + totalCount: 498330, + maxPage: 741743, }, }; ``` diff --git a/docs/models/components/listresourcecheckout.md b/docs/models/components/listresourcecheckout.md index e3faf6a1..66ef4a67 100644 --- a/docs/models/components/listresourcecheckout.md +++ b/docs/models/components/listresourcecheckout.md @@ -8,28 +8,28 @@ import { ListResourceCheckout } from "@polar-sh/sdk/models/components"; let value: ListResourceCheckout = { items: [ { - createdAt: new Date("2023-01-13T06:58:49.050Z"), - modifiedAt: new Date("2022-10-26T18:02:39.058Z"), + createdAt: new Date("2022-06-05T03:18:14.991Z"), + modifiedAt: new Date("2024-04-15T20:33:21.883Z"), id: "", - status: "expired", + status: "confirmed", clientSecret: "", - url: "https://supportive-programme.net/", - expiresAt: new Date("2024-10-10T22:47:15.949Z"), - successUrl: "https://white-unique.biz", + url: "https://grim-coast.biz", + expiresAt: new Date("2022-03-05T03:05:50.686Z"), + successUrl: "https://silent-stool.net", embedOrigin: "", - amount: 392307, - taxAmount: 575206, - currency: "Guarani", - totalAmount: 464706, + amount: 167786, + taxAmount: 735959, + currency: "Tugrik", + totalAmount: 108673, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Lonzo31@hotmail.com", + customerEmail: "Sterling9@hotmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Bangladesh", + country: "Venezuela", }, customerTaxId: "", paymentProcessorMetadata: {}, @@ -37,33 +37,30 @@ let value: ListResourceCheckout = { "key": "", }, product: { - createdAt: new Date("2024-11-18T10:26:54.805Z"), - modifiedAt: new Date("2023-06-07T21:49:43.015Z"), + createdAt: new Date("2023-06-10T09:07:09.454Z"), + modifiedAt: new Date("2022-04-27T05:09:55.285Z"), id: "", name: "", - description: "before bashfully able whenever since coordinated", + description: "highlight ouch thyme override bah zowie", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-09-10T05:55:09.703Z"), - modifiedAt: new Date("2023-01-05T14:54:34.065Z"), + createdAt: new Date("2024-04-13T13:33:13.010Z"), + modifiedAt: new Date("2024-09-05T19:40:25.993Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 160733, - maximumAmount: 173052, - presetAmount: 57599, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2024-03-26T08:49:10.019Z"), - modifiedAt: new Date("2024-07-27T23:23:21.475Z"), + createdAt: new Date("2023-01-22T23:18:37.610Z"), + modifiedAt: new Date("2023-03-02T13:30:13.678Z"), id: "", - description: "gee from translation onset serene where before soon", + description: "atop beneficial ugh ravage warped so obediently", selectable: false, deletable: false, organizationId: "", @@ -77,41 +74,36 @@ let value: ListResourceCheckout = { id: "", organizationId: "", name: "", - path: "/dev", + path: "/boot", mimeType: "", - size: 894398, + size: 714830, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-08-29T00:14:02.289Z"), + lastModifiedAt: new Date("2024-11-10T12:13:29.060Z"), version: "", isUploaded: false, - createdAt: new Date("2024-02-26T22:59:52.460Z"), + createdAt: new Date("2022-02-17T11:30:13.324Z"), sizeReadable: "", - publicUrl: "https://unknown-crocodile.net", + publicUrl: "https://milky-whack.info/", }, ], }, productPrice: { - createdAt: new Date("2023-07-12T02:38:25.234Z"), - modifiedAt: new Date("2022-05-24T18:23:37.331Z"), + createdAt: new Date("2024-10-14T00:00:36.097Z"), + modifiedAt: new Date("2022-07-14T00:14:45.565Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 358724, - maximumAmount: 940490, - presetAmount: 180628, - recurringInterval: "month", }, subscriptionId: "", attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-10-01T23:26:22.306Z"), - modifiedAt: new Date("2022-06-30T14:38:50.223Z"), + createdAt: new Date("2023-11-18T13:27:48.229Z"), + modifiedAt: new Date("2024-06-01T22:41:03.562Z"), id: "", metadata: { "key": "", @@ -121,15 +113,15 @@ let value: ListResourceCheckout = { organizationId: "", properties: {}, }, - order: 190514, + order: 500101, required: false, }, ], }, ], pagination: { - totalCount: 985677, - maxPage: 413308, + totalCount: 208959, + maxPage: 854604, }, }; ``` diff --git a/docs/models/components/listresourcecheckoutlink.md b/docs/models/components/listresourcecheckoutlink.md index 37b16727..65629192 100644 --- a/docs/models/components/listresourcecheckoutlink.md +++ b/docs/models/components/listresourcecheckoutlink.md @@ -8,30 +8,28 @@ import { ListResourceCheckoutLink } from "@polar-sh/sdk/models/components"; let value: ListResourceCheckoutLink = { items: [ { - createdAt: new Date("2024-02-16T00:15:32.715Z"), - modifiedAt: new Date("2024-01-10T10:45:06.401Z"), + createdAt: new Date("2024-02-28T16:31:31.253Z"), + modifiedAt: new Date("2022-12-28T14:16:16.603Z"), id: "", metadata: { - "key": "", + "key": false, }, clientSecret: "", - successUrl: "https://scientific-tentacle.net/", + successUrl: "https://great-representation.com/", productPriceId: "", productPrice: { - createdAt: new Date("2024-09-05T00:05:28.311Z"), - modifiedAt: new Date("2023-06-21T17:32:39.701Z"), + createdAt: new Date("2022-11-30T04:59:07.344Z"), + modifiedAt: new Date("2024-02-21T04:41:02.985Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 407877, }, - url: "https://earnest-fishery.net", + url: "https://stormy-league.com", }, ], pagination: { - totalCount: 563474, - maxPage: 762279, + totalCount: 892340, + maxPage: 489718, }, }; ``` diff --git a/docs/models/components/listresourcefileread.md b/docs/models/components/listresourcefileread.md index 765e7cd6..d7d31631 100644 --- a/docs/models/components/listresourcefileread.md +++ b/docs/models/components/listresourcefileread.md @@ -11,24 +11,24 @@ let value: ListResourceFileRead = { id: "", organizationId: "", name: "", - path: "/usr/local/src", + path: "/proc", mimeType: "", - size: 15297, + size: 660728, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-09-18T03:44:36.212Z"), + lastModifiedAt: new Date("2023-07-02T06:21:44.983Z"), version: "", isUploaded: false, - createdAt: new Date("2023-11-09T19:57:09.022Z"), + createdAt: new Date("2023-01-10T13:58:51.311Z"), sizeReadable: "", - publicUrl: "https://unfit-league.biz", + publicUrl: "https://legal-ghost.net/", }, ], pagination: { - totalCount: 10185, - maxPage: 240781, + totalCount: 15297, + maxPage: 570398, }, }; ``` diff --git a/docs/models/components/listresourceoauth2client.md b/docs/models/components/listresourceoauth2client.md index 03f8188f..5e55ced2 100644 --- a/docs/models/components/listresourceoauth2client.md +++ b/docs/models/components/listresourceoauth2client.md @@ -9,20 +9,20 @@ let value: ListResourceOAuth2Client = { items: [ { redirectUris: [ - "https://unruly-possession.info", + "https://shy-cafe.biz", ], clientName: "", - createdAt: new Date("2022-11-03T20:32:51.033Z"), - modifiedAt: new Date("2023-11-30T08:31:54.256Z"), + createdAt: new Date("2023-12-02T04:42:08.759Z"), + modifiedAt: new Date("2023-02-22T02:38:09.369Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 631429, - clientSecretExpiresAt: 23910, + clientIdIssuedAt: 765245, + clientSecretExpiresAt: 536042, }, ], pagination: { - totalCount: 747110, - maxPage: 221874, + totalCount: 856997, + maxPage: 111026, }, }; ``` diff --git a/docs/models/components/listresourceorder.md b/docs/models/components/listresourceorder.md index 369a7444..3c190859 100644 --- a/docs/models/components/listresourceorder.md +++ b/docs/models/components/listresourceorder.md @@ -8,16 +8,16 @@ import { ListResourceOrder } from "@polar-sh/sdk/models/components"; let value: ListResourceOrder = { items: [ { - createdAt: new Date("2024-09-20T03:09:49.442Z"), - modifiedAt: new Date("2023-06-21T01:11:23.657Z"), + createdAt: new Date("2024-02-13T00:39:06.977Z"), + modifiedAt: new Date("2024-09-20T03:09:49.442Z"), id: "", metadata: { - "key": "", + "key": 169341, }, - amount: 169341, - taxAmount: 409633, - currency: "Mexican Peso", - billingReason: "subscription_cycle", + amount: 409633, + taxAmount: 593679, + currency: "Denar", + billingReason: "subscription_update", userId: "", productId: "", productPriceId: "", @@ -25,47 +25,46 @@ let value: ListResourceOrder = { checkoutId: "", user: { id: "", - email: "Larry47@hotmail.com", + email: "Deshawn_Daniel-Kreiger@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://musty-poetry.info", + avatarUrl: "https://jealous-gripper.name", }, product: { - createdAt: new Date("2023-03-11T21:34:54.948Z"), - modifiedAt: new Date("2023-11-20T02:39:06.531Z"), + createdAt: new Date("2024-03-18T18:15:52.333Z"), + modifiedAt: new Date("2024-10-24T10:57:13.571Z"), id: "", name: "", description: - "briskly pink behest yet huzzah than magnificent chainstay", + "till other blaspheme blah into translation corrupt because yet", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2022-02-17T00:20:01.255Z"), - modifiedAt: new Date("2023-08-06T19:15:57.742Z"), + createdAt: new Date("2024-08-17T05:51:35.005Z"), + modifiedAt: new Date("2023-04-25T14:16:21.503Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 224411, + recurringInterval: "year", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2022-11-23T04:46:09.251Z"), - modifiedAt: new Date("2023-11-09T05:04:32.559Z"), + createdAt: new Date("2022-04-10T19:20:25.958Z"), + modifiedAt: new Date("2023-09-14T15:29:47.794Z"), id: "", - amount: 351246, - currency: "Zimbabwe Dollar", - recurringInterval: "month", - status: "unpaid", - currentPeriodStart: new Date("2024-08-17T05:51:35.005Z"), - currentPeriodEnd: new Date("2023-04-25T14:16:21.503Z"), + amount: 7471, + currency: "Cayman Islands Dollar", + recurringInterval: "year", + status: "trialing", + currentPeriodStart: new Date("2022-08-12T13:48:54.990Z"), + currentPeriodEnd: new Date("2022-10-08T04:45:48.967Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-12-29T01:56:03.510Z"), - endedAt: new Date("2022-11-06T22:46:44.719Z"), + startedAt: new Date("2024-09-28T12:48:41.806Z"), + endedAt: new Date("2023-12-27T18:50:34.690Z"), userId: "", productId: "", priceId: "", @@ -74,8 +73,8 @@ let value: ListResourceOrder = { }, ], pagination: { - totalCount: 91063, - maxPage: 567195, + totalCount: 161312, + maxPage: 463193, }, }; ``` diff --git a/docs/models/components/listresourceorganization.md b/docs/models/components/listresourceorganization.md index 5687dd64..6d2e9f6b 100644 --- a/docs/models/components/listresourceorganization.md +++ b/docs/models/components/listresourceorganization.md @@ -23,7 +23,6 @@ let value: ListResourceOrganization = { pledgeMinimumAmount: 613286, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 486162, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/listresourceproduct.md b/docs/models/components/listresourceproduct.md index a5cd9b0a..c54ce127 100644 --- a/docs/models/components/listresourceproduct.md +++ b/docs/models/components/listresourceproduct.md @@ -8,36 +8,45 @@ import { ListResourceProduct } from "@polar-sh/sdk/models/components"; let value: ListResourceProduct = { items: [ { - createdAt: new Date("2023-12-03T01:24:28.573Z"), - modifiedAt: new Date("2024-04-30T15:57:54.017Z"), + createdAt: new Date("2024-08-14T22:50:28.709Z"), + modifiedAt: new Date("2022-04-27T17:18:40.571Z"), id: "", name: "", - description: "elevator blah boo", + description: "outnumber decriminalize psst expatiate", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": false, + }, prices: [ { - createdAt: new Date("2024-08-14T22:50:28.709Z"), - modifiedAt: new Date("2022-04-27T17:18:40.571Z"), + createdAt: new Date("2023-08-09T10:13:51.600Z"), + modifiedAt: new Date("2023-04-18T14:04:46.675Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 125701, + minimumAmount: 209169, + maximumAmount: 427526, + presetAmount: 844283, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2022-06-12T14:00:52.276Z"), - modifiedAt: new Date("2024-05-21T01:52:05.438Z"), + createdAt: new Date("2024-11-26T11:27:09.590Z"), + modifiedAt: new Date("2024-05-10T16:19:06.783Z"), id: "", - description: - "phew pro pace provided with inspection boo incidentally alarmed", + description: "meanwhile once uh-huh", selectable: false, deletable: false, organizationId: "", - properties: {}, + properties: { + guildId: "", + roleId: "", + guildToken: "", + }, }, ], medias: [ @@ -45,27 +54,27 @@ let value: ListResourceProduct = { id: "", organizationId: "", name: "", - path: "/etc/periodic", + path: "/usr/local/bin", mimeType: "", - size: 459888, + size: 744991, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-11-04T15:15:56.312Z"), + lastModifiedAt: new Date("2023-11-19T21:03:32.194Z"), version: "", isUploaded: false, - createdAt: new Date("2022-11-18T12:31:27.009Z"), + createdAt: new Date("2024-11-12T00:40:22.457Z"), sizeReadable: "", - publicUrl: "https://assured-airman.org", + publicUrl: "https://crooked-in-joke.biz/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-02-17T02:28:27.960Z"), - modifiedAt: new Date("2023-05-18T13:34:30.080Z"), + createdAt: new Date("2024-12-10T09:42:46.729Z"), + modifiedAt: new Date("2022-02-18T11:10:32.278Z"), id: "", metadata: { "key": "", @@ -75,15 +84,15 @@ let value: ListResourceProduct = { organizationId: "", properties: {}, }, - order: 881891, + order: 935145, required: false, }, ], }, ], pagination: { - totalCount: 306065, - maxPage: 932252, + totalCount: 160090, + maxPage: 42977, }, }; ``` diff --git a/docs/models/components/listresourcerepository.md b/docs/models/components/listresourcerepository.md index 017fbfcd..aa859033 100644 --- a/docs/models/components/listresourcerepository.md +++ b/docs/models/components/listresourcerepository.md @@ -46,7 +46,6 @@ let value: ListResourceRepository = { pledgeMinimumAmount: 640046, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 666273, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/listresourcesubscription.md b/docs/models/components/listresourcesubscription.md index c632cb85..a08d00db 100644 --- a/docs/models/components/listresourcesubscription.md +++ b/docs/models/components/listresourcesubscription.md @@ -28,44 +28,56 @@ let value: ListResourceSubscription = { "key": "", }, user: { - email: "Kailyn.Satterfield@gmail.com", + email: "Burdette39@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://right-meander.org", + avatarUrl: "https://noxious-statue.name", }, product: { - createdAt: new Date("2023-10-01T09:23:05.568Z"), - modifiedAt: new Date("2023-09-26T14:36:58.483Z"), + createdAt: new Date("2023-09-26T14:36:58.483Z"), + modifiedAt: new Date("2022-12-04T13:11:15.560Z"), id: "", name: "", - description: "executor hunt till sheepishly duh", + description: + "needily forenenst ugh privilege resource cumbersome drag battle briskly nor", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": false, + }, prices: [ { - createdAt: new Date("2023-01-26T18:17:02.928Z"), - modifiedAt: new Date("2024-04-24T07:58:02.328Z"), + createdAt: new Date("2022-01-02T14:38:26.655Z"), + modifiedAt: new Date("2023-06-14T05:21:09.862Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 380130, - maximumAmount: 622192, - presetAmount: 893406, + priceAmount: 894109, }, ], benefits: [ { - createdAt: new Date("2022-01-10T18:16:03.467Z"), - modifiedAt: new Date("2022-10-09T09:43:33.243Z"), + createdAt: new Date("2022-05-18T07:48:42.632Z"), + modifiedAt: new Date("2024-08-01T07:14:49.018Z"), id: "", - description: - "sugary incline regarding behind about after hence belabor search", + description: "after hence belabor", selectable: false, deletable: false, organizationId: "", - properties: {}, + properties: { + prefix: "", + expires: { + ttl: 354533, + timeframe: "year", + }, + activations: { + limit: 982197, + enableUserAdmin: false, + }, + limitUsage: 143971, + }, }, ], medias: [ @@ -73,61 +85,54 @@ let value: ListResourceSubscription = { id: "", organizationId: "", name: "", - path: "/lost+found", + path: "/private/tmp", mimeType: "", - size: 737774, + size: 480043, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-01-29T20:48:34.054Z"), + lastModifiedAt: new Date("2024-05-06T04:06:41.754Z"), version: "", isUploaded: false, - createdAt: new Date("2024-10-13T03:45:54.403Z"), + createdAt: new Date("2022-10-26T06:31:29.994Z"), sizeReadable: "", - publicUrl: "https://lonely-comparison.info/", + publicUrl: "https://altruistic-transparency.com", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-06-06T03:35:17.126Z"), - modifiedAt: new Date("2022-11-13T20:42:37.829Z"), + createdAt: new Date("2022-07-10T01:53:42.639Z"), + modifiedAt: new Date("2023-02-09T00:05:44.146Z"), id: "", metadata: { - "key": "", + "key": 142472, }, slug: "", name: "", organizationId: "", - properties: { - options: [ - { - value: "", - label: "", - }, - ], - }, + properties: {}, }, - order: 679183, + order: 289108, required: false, }, ], }, price: { - createdAt: new Date("2023-10-12T19:34:57.872Z"), - modifiedAt: new Date("2023-07-28T04:35:19.088Z"), + createdAt: new Date("2024-07-14T14:53:59.208Z"), + modifiedAt: new Date("2023-10-12T19:34:57.872Z"), id: "", isArchived: false, productId: "", - recurringInterval: "month", + recurringInterval: "year", }, }, ], pagination: { - totalCount: 146540, - maxPage: 958192, + totalCount: 109609, + maxPage: 146540, }, }; ``` diff --git a/docs/models/components/listresourceuserbenefit.md b/docs/models/components/listresourceuserbenefit.md index 17888dff..03e4a2e7 100644 --- a/docs/models/components/listresourceuserbenefit.md +++ b/docs/models/components/listresourceuserbenefit.md @@ -8,17 +8,17 @@ import { ListResourceUserBenefit } from "@polar-sh/sdk/models/components"; let value: ListResourceUserBenefit = { items: [ { - createdAt: new Date("2023-05-27T22:49:24.592Z"), - modifiedAt: new Date("2024-04-05T08:01:37.302Z"), + createdAt: new Date("2024-10-26T05:58:24.759Z"), + modifiedAt: new Date("2022-05-22T13:19:47.503Z"), id: "", - description: "repeatedly supposing ferociously", + description: "from throughout undergo", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-10-12T20:51:35.951Z"), - modifiedAt: new Date("2023-11-03T05:14:01.508Z"), + createdAt: new Date("2023-05-29T04:05:53.462Z"), + modifiedAt: new Date("2023-01-04T09:22:53.989Z"), id: "", isGranted: false, isRevoked: false, @@ -29,35 +29,32 @@ let value: ListResourceUserBenefit = { }, ], organization: { - createdAt: new Date("2022-09-12T22:21:35.224Z"), - modifiedAt: new Date("2023-06-21T04:35:15.122Z"), + createdAt: new Date("2022-05-09T00:29:29.459Z"), + modifiedAt: new Date("2023-04-20T03:01:19.557Z"), id: "", name: "", slug: "", - avatarUrl: "https://kosher-settler.info/", + avatarUrl: "https://burdensome-executor.org", bio: "", - company: "Cummerata, Lemke and Senger", + company: "DuBuque Group", blog: "", location: "", - email: "Jamel7@gmail.com", + email: "Edmund.Zulauf@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 468221, + pledgeMinimumAmount: 434345, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 336123, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 926803, profileSettings: {}, featureSettings: {}, }, properties: { - activeFiles: [ - "", - ], + guildId: "", }, }, ], pagination: { - totalCount: 116807, - maxPage: 432597, + totalCount: 134205, + maxPage: 91136, }, }; ``` diff --git a/docs/models/components/listresourceuserorder.md b/docs/models/components/listresourceuserorder.md index 937efdc8..3d4fc23d 100644 --- a/docs/models/components/listresourceuserorder.md +++ b/docs/models/components/listresourceuserorder.md @@ -8,44 +8,45 @@ import { ListResourceUserOrder } from "@polar-sh/sdk/models/components"; let value: ListResourceUserOrder = { items: [ { - createdAt: new Date("2023-12-26T14:51:25.668Z"), - modifiedAt: new Date("2022-05-20T06:52:25.822Z"), + createdAt: new Date("2024-11-26T08:57:48.541Z"), + modifiedAt: new Date("2024-06-27T02:43:23.928Z"), id: "", - amount: 432280, - taxAmount: 416624, - currency: "Denar", + amount: 747382, + taxAmount: 155700, + currency: "Cayman Islands Dollar", userId: "", productId: "", productPriceId: "", subscriptionId: "", product: { - createdAt: new Date("2023-07-27T00:25:02.800Z"), - modifiedAt: new Date("2023-02-08T00:40:57.806Z"), + createdAt: new Date("2024-10-24T06:34:09.259Z"), + modifiedAt: new Date("2024-10-20T05:24:13.548Z"), id: "", name: "", - description: - "viciously scorn silk meaningfully likewise hmph angrily order cautiously", + description: "ah without yowza", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-02-24T18:09:40.072Z"), - modifiedAt: new Date("2023-03-03T23:09:58.976Z"), + createdAt: new Date("2024-07-31T20:50:15.524Z"), + modifiedAt: new Date("2023-11-20T04:44:06.594Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 920234, + minimumAmount: 774567, + maximumAmount: 485097, + presetAmount: 648414, recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2024-08-30T08:52:26.881Z"), - modifiedAt: new Date("2023-04-30T13:46:10.741Z"), + createdAt: new Date("2022-01-02T21:42:42.464Z"), + modifiedAt: new Date("2022-04-20T11:58:55.097Z"), id: "", - description: "incidentally deduce with", + description: "sunder embossing up till congregate", selectable: false, deletable: false, organizationId: "", @@ -59,63 +60,62 @@ let value: ListResourceUserOrder = { id: "", organizationId: "", name: "", - path: "/private", + path: "/Applications", mimeType: "", - size: 979665, + size: 237875, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-07-27T18:33:03.482Z"), + lastModifiedAt: new Date("2023-03-18T21:26:22.971Z"), version: "", isUploaded: false, - createdAt: new Date("2023-06-15T05:10:45.704Z"), + createdAt: new Date("2023-04-18T12:27:46.530Z"), sizeReadable: "", - publicUrl: "https://adolescent-descendant.info/", + publicUrl: "https://primary-hovercraft.org", }, ], organization: { - createdAt: new Date("2023-04-18T12:27:46.530Z"), - modifiedAt: new Date("2024-08-29T14:37:53.760Z"), + createdAt: new Date("2023-11-05T04:33:24.549Z"), + modifiedAt: new Date("2022-12-20T15:19:35.871Z"), id: "", name: "", slug: "", - avatarUrl: "https://jagged-willow.name", + avatarUrl: "https://major-swine.org", bio: "", - company: "Pollich - Kunze", + company: "MacGyver Inc", blog: "", location: "", - email: "Sophie62@hotmail.com", + email: "Zachery.Hilll@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 832589, + pledgeMinimumAmount: 293381, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 366410, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 316335, profileSettings: {}, featureSettings: {}, }, }, productPrice: { - createdAt: new Date("2023-03-03T23:38:16.866Z"), - modifiedAt: new Date("2022-11-18T13:05:27.659Z"), + createdAt: new Date("2024-12-17T08:06:48.746Z"), + modifiedAt: new Date("2022-11-21T13:19:02.770Z"), id: "", isArchived: false, productId: "", recurringInterval: "month", }, subscription: { - createdAt: new Date("2023-06-21T22:56:39.250Z"), - modifiedAt: new Date("2024-11-14T14:23:19.654Z"), + createdAt: new Date("2023-07-15T22:33:35.122Z"), + modifiedAt: new Date("2022-01-09T23:21:30.384Z"), id: "", - amount: 986623, - currency: "Lari", + amount: 174836, + currency: "CFA Franc BEAC", recurringInterval: "month", - status: "active", - currentPeriodStart: new Date("2022-01-09T23:21:30.384Z"), - currentPeriodEnd: new Date("2022-07-11T14:54:03.454Z"), + status: "incomplete", + currentPeriodStart: new Date("2023-04-07T00:41:56.890Z"), + currentPeriodEnd: new Date("2024-03-12T16:04:02.474Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-10-22T22:05:47.312Z"), - endedAt: new Date("2022-02-02T06:15:52.112Z"), + startedAt: new Date("2022-10-22T16:34:22.700Z"), + endedAt: new Date("2022-12-02T08:07:08.018Z"), userId: "", productId: "", priceId: "", @@ -124,8 +124,8 @@ let value: ListResourceUserOrder = { }, ], pagination: { - totalCount: 100976, - maxPage: 420647, + totalCount: 305473, + maxPage: 872602, }, }; ``` diff --git a/docs/models/components/listresourceusersubscription.md b/docs/models/components/listresourceusersubscription.md index bd290c28..c9d99c39 100644 --- a/docs/models/components/listresourceusersubscription.md +++ b/docs/models/components/listresourceusersubscription.md @@ -94,7 +94,6 @@ let value: ListResourceUserSubscription = { pledgeMinimumAmount: 798619, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 961171, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/loc.md b/docs/models/components/loc.md index 718b22a4..677b6528 100644 --- a/docs/models/components/loc.md +++ b/docs/models/components/loc.md @@ -12,6 +12,6 @@ const value: string = ""; ### `number` ```typescript -const value: number = 209920; +const value: number = 592791; ``` diff --git a/docs/models/components/metadata.md b/docs/models/components/metadata.md new file mode 100644 index 00000000..08a8f09a --- /dev/null +++ b/docs/models/components/metadata.md @@ -0,0 +1,23 @@ +# Metadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 958192; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/metric.md b/docs/models/components/metric.md index 17acc005..ff63e705 100644 --- a/docs/models/components/metric.md +++ b/docs/models/components/metric.md @@ -9,8 +9,8 @@ import { Metric } from "@polar-sh/sdk/models/components"; let value: Metric = { slug: "", - displayName: "Devonte.Gutkowski", - type: "currency", + displayName: "Jefferey.Sawayn49", + type: "scalar", }; ``` diff --git a/docs/models/components/metricperiod.md b/docs/models/components/metricperiod.md index 64e7c7d7..2b4323ba 100644 --- a/docs/models/components/metricperiod.md +++ b/docs/models/components/metricperiod.md @@ -6,18 +6,18 @@ import { MetricPeriod } from "@polar-sh/sdk/models/components"; let value: MetricPeriod = { - timestamp: new Date("2023-09-20T10:21:04.413Z"), - orders: 126999, - revenue: 788582, - averageOrderValue: 774664, - oneTimeProducts: 404610, - oneTimeProductsRevenue: 539394, - newSubscriptions: 424886, - newSubscriptionsRevenue: 224244, - renewedSubscriptions: 762922, - renewedSubscriptionsRevenue: 744435, - activeSubscriptions: 647056, - monthlyRecurringRevenue: 455640, + timestamp: new Date("2023-03-04T12:22:36.931Z"), + orders: 300893, + revenue: 159739, + averageOrderValue: 941731, + oneTimeProducts: 429279, + oneTimeProductsRevenue: 637803, + newSubscriptions: 926762, + newSubscriptionsRevenue: 572474, + renewedSubscriptions: 126999, + renewedSubscriptionsRevenue: 788582, + activeSubscriptions: 774664, + monthlyRecurringRevenue: 404610, }; ``` diff --git a/docs/models/components/metrics.md b/docs/models/components/metrics.md index a8d62311..e4df410f 100644 --- a/docs/models/components/metrics.md +++ b/docs/models/components/metrics.md @@ -8,57 +8,57 @@ import { Metrics } from "@polar-sh/sdk/models/components"; let value: Metrics = { orders: { slug: "", - displayName: "Harmony_Lockman47", - type: "scalar", + displayName: "Rubye_Balistreri", + type: "currency", }, revenue: { slug: "", - displayName: "Skylar31", + displayName: "Harmony_Lockman47", type: "scalar", }, averageOrderValue: { slug: "", - displayName: "Lela_Connelly", - type: "currency", + displayName: "Skylar31", + type: "scalar", }, oneTimeProducts: { slug: "", - displayName: "Collin_Tremblay2", + displayName: "Lela_Connelly", type: "currency", }, oneTimeProductsRevenue: { slug: "", - displayName: "Amber_Lesch22", - type: "scalar", + displayName: "Collin_Tremblay2", + type: "currency", }, newSubscriptions: { slug: "", - displayName: "Immanuel_Tromp", + displayName: "Amber_Lesch22", type: "scalar", }, newSubscriptionsRevenue: { slug: "", - displayName: "Anthony.Dietrich", + displayName: "Immanuel_Tromp", type: "scalar", }, renewedSubscriptions: { slug: "", - displayName: "Ethyl7", + displayName: "Anthony.Dietrich", type: "scalar", }, renewedSubscriptionsRevenue: { slug: "", - displayName: "Kianna_Luettgen", + displayName: "Ethyl7", type: "scalar", }, activeSubscriptions: { slug: "", - displayName: "Chet2", + displayName: "Kianna_Luettgen", type: "scalar", }, monthlyRecurringRevenue: { slug: "", - displayName: "Jefferey.Sawayn49", + displayName: "Chet2", type: "scalar", }, }; diff --git a/docs/models/components/metricsintervallimit.md b/docs/models/components/metricsintervallimit.md index 02a2db73..45ebd41c 100644 --- a/docs/models/components/metricsintervallimit.md +++ b/docs/models/components/metricsintervallimit.md @@ -8,7 +8,7 @@ Date interval limit to get metrics for a given interval. import { MetricsIntervalLimit } from "@polar-sh/sdk/models/components"; let value: MetricsIntervalLimit = { - maxDays: 74099, + maxDays: 15344, }; ``` diff --git a/docs/models/components/metricsintervalslimits.md b/docs/models/components/metricsintervalslimits.md index a6101f58..ad4db29a 100644 --- a/docs/models/components/metricsintervalslimits.md +++ b/docs/models/components/metricsintervalslimits.md @@ -9,19 +9,19 @@ import { MetricsIntervalsLimits } from "@polar-sh/sdk/models/components"; let value: MetricsIntervalsLimits = { hour: { - maxDays: 329922, + maxDays: 464806, }, day: { - maxDays: 919348, + maxDays: 298444, }, week: { - maxDays: 242120, + maxDays: 265724, }, month: { - maxDays: 335403, + maxDays: 848972, }, year: { - maxDays: 747336, + maxDays: 859375, }, }; ``` diff --git a/docs/models/components/metricslimits.md b/docs/models/components/metricslimits.md index d46ffde2..4a6ddcad 100644 --- a/docs/models/components/metricslimits.md +++ b/docs/models/components/metricslimits.md @@ -9,22 +9,22 @@ import { MetricsLimits } from "@polar-sh/sdk/models/components"; import { RFCDate } from "@polar-sh/sdk/types"; let value: MetricsLimits = { - minDate: new RFCDate("2022-11-24"), + minDate: new RFCDate("2023-04-11"), intervals: { hour: { - maxDays: 265724, + maxDays: 224244, }, day: { - maxDays: 848972, + maxDays: 762922, }, week: { - maxDays: 859375, + maxDays: 744435, }, month: { - maxDays: 15344, + maxDays: 647056, }, year: { - maxDays: 719607, + maxDays: 455640, }, }, }; diff --git a/docs/models/components/metricsresponse.md b/docs/models/components/metricsresponse.md index ad84dbb3..aa4acf38 100644 --- a/docs/models/components/metricsresponse.md +++ b/docs/models/components/metricsresponse.md @@ -10,76 +10,76 @@ import { MetricsResponse } from "@polar-sh/sdk/models/components"; let value: MetricsResponse = { periods: [ { - timestamp: new Date("2024-08-23T22:10:48.974Z"), - orders: 315591, - revenue: 822577, - averageOrderValue: 4891, - oneTimeProducts: 949209, - oneTimeProductsRevenue: 54329, - newSubscriptions: 262883, - newSubscriptionsRevenue: 24886, - renewedSubscriptions: 959355, - renewedSubscriptionsRevenue: 51685, - activeSubscriptions: 349003, - monthlyRecurringRevenue: 663840, + timestamp: new Date("2023-04-01T15:25:04.349Z"), + orders: 42665, + revenue: 533171, + averageOrderValue: 116704, + oneTimeProducts: 79114, + oneTimeProductsRevenue: 467579, + newSubscriptions: 314769, + newSubscriptionsRevenue: 881318, + renewedSubscriptions: 315591, + renewedSubscriptionsRevenue: 822577, + activeSubscriptions: 4891, + monthlyRecurringRevenue: 949209, }, ], metrics: { orders: { slug: "", - displayName: "Emory37", + displayName: "Amos_Bailey", type: "currency", }, revenue: { slug: "", - displayName: "Kylee_Wunsch", + displayName: "Emory37", type: "currency", }, averageOrderValue: { + slug: "", + displayName: "Kylee_Wunsch", + type: "currency", + }, + oneTimeProducts: { slug: "", displayName: "Jammie68", type: "scalar", }, - oneTimeProducts: { + oneTimeProductsRevenue: { slug: "", displayName: "Josiane.Ledner", type: "currency", }, - oneTimeProductsRevenue: { + newSubscriptions: { slug: "", displayName: "Zena.Fay", type: "currency", }, - newSubscriptions: { + newSubscriptionsRevenue: { slug: "", displayName: "Giovani_Cummerata69", type: "currency", }, - newSubscriptionsRevenue: { + renewedSubscriptions: { slug: "", displayName: "Dylan37", type: "scalar", }, - renewedSubscriptions: { + renewedSubscriptionsRevenue: { slug: "", displayName: "Lucile18", type: "scalar", }, - renewedSubscriptionsRevenue: { + activeSubscriptions: { slug: "", displayName: "Maryam53", type: "scalar", }, - activeSubscriptions: { + monthlyRecurringRevenue: { slug: "", displayName: "Garth.Durgan", type: "scalar", }, - monthlyRecurringRevenue: { - slug: "", - displayName: "Rubye_Balistreri", - type: "currency", - }, }, }; ``` diff --git a/docs/models/components/metrictype.md b/docs/models/components/metrictype.md index c26679e1..7c6c9526 100644 --- a/docs/models/components/metrictype.md +++ b/docs/models/components/metrictype.md @@ -5,7 +5,7 @@ ```typescript import { MetricType } from "@polar-sh/sdk/models/components"; -let value: MetricType = "currency"; +let value: MetricType = "scalar"; ``` ## Values diff --git a/docs/models/components/oauth2client.md b/docs/models/components/oauth2client.md index 53012553..6ab15f4c 100644 --- a/docs/models/components/oauth2client.md +++ b/docs/models/components/oauth2client.md @@ -7,15 +7,15 @@ import { OAuth2Client } from "@polar-sh/sdk/models/components"; let value: OAuth2Client = { redirectUris: [ - "https://moist-status.com", + "https://fond-draw.biz", ], clientName: "", - createdAt: new Date("2024-06-28T03:36:20.568Z"), - modifiedAt: new Date("2023-12-15T09:44:39.987Z"), + createdAt: new Date("2023-02-14T04:29:05.402Z"), + modifiedAt: new Date("2022-09-19T22:20:10.589Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 214929, - clientSecretExpiresAt: 736906, + clientIdIssuedAt: 189728, + clientSecretExpiresAt: 961796, }; ``` diff --git a/docs/models/components/oauth2clientconfiguration.md b/docs/models/components/oauth2clientconfiguration.md index 8dbb32e6..5595af07 100644 --- a/docs/models/components/oauth2clientconfiguration.md +++ b/docs/models/components/oauth2clientconfiguration.md @@ -7,7 +7,7 @@ import { OAuth2ClientConfiguration } from "@polar-sh/sdk/models/components"; let value: OAuth2ClientConfiguration = { redirectUris: [ - "https://probable-gloom.net/", + "https://official-kit.name/", ], clientName: "", }; diff --git a/docs/models/components/oauth2clientconfigurationgranttypes.md b/docs/models/components/oauth2clientconfigurationgranttypes.md index 8a13b57a..e56dc464 100644 --- a/docs/models/components/oauth2clientconfigurationgranttypes.md +++ b/docs/models/components/oauth2clientconfigurationgranttypes.md @@ -5,7 +5,7 @@ ```typescript import { OAuth2ClientConfigurationGrantTypes } from "@polar-sh/sdk/models/components"; -let value: OAuth2ClientConfigurationGrantTypes = "authorization_code"; +let value: OAuth2ClientConfigurationGrantTypes = "refresh_token"; ``` ## Values diff --git a/docs/models/components/oauth2clientconfigurationtokenendpointauthmethod.md b/docs/models/components/oauth2clientconfigurationtokenendpointauthmethod.md index f8bd2241..58d6aa86 100644 --- a/docs/models/components/oauth2clientconfigurationtokenendpointauthmethod.md +++ b/docs/models/components/oauth2clientconfigurationtokenendpointauthmethod.md @@ -5,7 +5,8 @@ ```typescript import { OAuth2ClientConfigurationTokenEndpointAuthMethod } from "@polar-sh/sdk/models/components"; -let value: OAuth2ClientConfigurationTokenEndpointAuthMethod = "none"; +let value: OAuth2ClientConfigurationTokenEndpointAuthMethod = + "client_secret_post"; ``` ## Values diff --git a/docs/models/components/oauth2clientconfigurationupdate.md b/docs/models/components/oauth2clientconfigurationupdate.md index c66fbea5..83299b60 100644 --- a/docs/models/components/oauth2clientconfigurationupdate.md +++ b/docs/models/components/oauth2clientconfigurationupdate.md @@ -7,7 +7,7 @@ import { OAuth2ClientConfigurationUpdate } from "@polar-sh/sdk/models/components let value: OAuth2ClientConfigurationUpdate = { redirectUris: [ - "https://shimmering-injunction.name/", + "https://crafty-bowler.info", ], clientName: "", clientId: "", diff --git a/docs/models/components/oauth2clientconfigurationupdatetokenendpointauthmethod.md b/docs/models/components/oauth2clientconfigurationupdatetokenendpointauthmethod.md index e972b077..c35d4b04 100644 --- a/docs/models/components/oauth2clientconfigurationupdatetokenendpointauthmethod.md +++ b/docs/models/components/oauth2clientconfigurationupdatetokenendpointauthmethod.md @@ -5,8 +5,7 @@ ```typescript import { OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod } from "@polar-sh/sdk/models/components"; -let value: OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod = - "client_secret_post"; +let value: OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod = "none"; ``` ## Values diff --git a/docs/models/components/donation.md b/docs/models/components/oauth2clientpublic.md similarity index 52% rename from docs/models/components/donation.md rename to docs/models/components/oauth2clientpublic.md index 28913cee..cac9743b 100644 --- a/docs/models/components/donation.md +++ b/docs/models/components/oauth2clientpublic.md @@ -1,78 +1,19 @@ -# Donation +# OAuth2ClientPublic ## Example Usage ```typescript -import { Donation } from "@polar-sh/sdk/models/components"; +import { OAuth2ClientPublic } from "@polar-sh/sdk/models/components"; -let value: Donation = { - createdAt: new Date("2024-11-17T07:20:20.409Z"), - modifiedAt: new Date("2024-10-12T09:58:31.166Z"), - id: "", - amount: 969138, - currency: "Mauritius Rupee", - message: "", - donor: { - id: "", - name: "", - avatarUrl: "https://descriptive-coordination.org/", - isPersonal: false, - }, - email: "Genesis_Bashirian@gmail.com", - issue: { - id: "2f681442-e30f-4fbd-b21d-55bc91501b42", - number: 820355, - title: "", - state: "closed", - issueCreatedAt: new Date("2022-12-23T20:27:41.424Z"), - needsConfirmationSolved: false, - funding: {}, - repository: { - id: "2ded418c-fe00-4a29-90b6-cb781aad03a8", - isPrivate: false, - name: "MyOrg", - description: "once any lest", - stars: 1337, - license: "", - homepage: "", - profileSettings: {}, - organization: { - id: "b681b8fd-55a7-48f1-89a3-9c4f27b78705", - name: "", - avatarUrl: "https://lively-hamburger.net", - isPersonal: false, - bio: "", - prettyName: "", - company: "Jerde Group", - blog: "", - location: "", - email: "Claudine.Thompson43@yahoo.com", - twitterUsername: "", - organizationId: "", - }, - internalOrganization: { - createdAt: new Date("2024-09-06T20:33:57.388Z"), - modifiedAt: new Date("2022-03-29T04:02:08.271Z"), - id: "", - name: "", - slug: "", - avatarUrl: "https://winding-tinderbox.com", - bio: "", - company: "Breitenberg - Jakubowski", - blog: "", - location: "", - email: "Caterina.Heller29@yahoo.com", - twitterUsername: "", - pledgeMinimumAmount: 419990, - pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 410248, - donationsEnabled: false, - profileSettings: {}, - featureSettings: {}, - }, - }, - pledgeBadgeCurrentlyEmbedded: false, - }, +let value: OAuth2ClientPublic = { + createdAt: new Date("2022-10-07T01:25:03.205Z"), + modifiedAt: new Date("2023-06-17T08:39:45.405Z"), + clientId: "", + clientName: "", + clientUri: "https://strange-scrap.org", + logoUri: "https://worst-hoof.biz/", + tosUri: "https://superior-travel.name", + policyUri: "https://miserable-maestro.org", }; ``` @@ -82,10 +23,9 @@ let value: Donation = { | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | | `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `amount` | *number* | :heavy_check_mark: | N/A | -| `currency` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `donor` | *components.Donor* | :heavy_check_mark: | N/A | -| `email` | *string* | :heavy_check_mark: | N/A | -| `issue` | [components.Issue](../../models/components/issue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `clientId` | *string* | :heavy_check_mark: | N/A | +| `clientName` | *string* | :heavy_check_mark: | N/A | +| `clientUri` | *string* | :heavy_check_mark: | N/A | +| `logoUri` | *string* | :heavy_check_mark: | N/A | +| `tosUri` | *string* | :heavy_check_mark: | N/A | +| `policyUri` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md b/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md index c67e5dbb..260fbf57 100644 --- a/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md +++ b/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md @@ -9,7 +9,7 @@ let value: Onev11oauth21tokenPostXComponentsAuthorizationCodeTokenRequest = { clientId: "", clientSecret: "", code: "", - redirectUri: "https://precious-morbidity.org/", + redirectUri: "https://awful-citizen.name/", }; ``` diff --git a/docs/models/components/order.md b/docs/models/components/order.md index 56893aeb..cc0bcb67 100644 --- a/docs/models/components/order.md +++ b/docs/models/components/order.md @@ -6,16 +6,16 @@ import { Order } from "@polar-sh/sdk/models/components"; let value: Order = { - createdAt: new Date("2022-01-09T04:32:15.217Z"), - modifiedAt: new Date("2023-06-04T16:24:12.271Z"), + createdAt: new Date("2023-07-08T15:12:48.113Z"), + modifiedAt: new Date("2024-05-10T10:58:39.596Z"), id: "", metadata: { "key": "", }, - amount: 836804, - taxAmount: 419707, - currency: "Cuban Peso", - billingReason: "subscription_create", + amount: 281064, + taxAmount: 574591, + currency: "Malagasy Ariary", + billingReason: "purchase", userId: "", productId: "", productPriceId: "", @@ -23,46 +23,50 @@ let value: Order = { checkoutId: "", user: { id: "", - email: "Major50@hotmail.com", + email: "Nicholaus_Nikolaus58@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://fluffy-minion.name/", + avatarUrl: "https://compassionate-dress.name", }, product: { - createdAt: new Date("2022-04-25T01:43:31.801Z"), - modifiedAt: new Date("2022-07-12T00:53:04.419Z"), + createdAt: new Date("2022-02-15T01:23:01.586Z"), + modifiedAt: new Date("2022-01-01T22:22:58.693Z"), id: "", name: "", - description: "among until mmm word lean from quarrel finally altruistic", + description: + "where though sarcastic godparent weird patiently married alliance sonar keenly", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2024-08-21T18:47:35.544Z"), - modifiedAt: new Date("2022-06-07T04:12:06.961Z"), + createdAt: new Date("2022-08-20T06:58:32.848Z"), + modifiedAt: new Date("2022-09-05T20:51:23.814Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 30643, + minimumAmount: 690696, + maximumAmount: 151557, + presetAmount: 281986, + recurringInterval: "month", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2022-03-08T19:15:27.321Z"), - modifiedAt: new Date("2023-07-27T07:33:30.803Z"), + createdAt: new Date("2022-02-11T10:30:57.987Z"), + modifiedAt: new Date("2024-02-05T09:06:07.394Z"), id: "", - amount: 215248, - currency: "Sudanese Pound", + amount: 404429, + currency: "Bhutanese Ngultrum", recurringInterval: "month", status: "incomplete_expired", - currentPeriodStart: new Date("2024-06-28T22:40:32.191Z"), - currentPeriodEnd: new Date("2022-02-20T00:32:42.159Z"), + currentPeriodStart: new Date("2023-01-30T22:12:53.323Z"), + currentPeriodEnd: new Date("2023-10-10T16:45:39.713Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-05-13T05:22:03.123Z"), - endedAt: new Date("2022-05-03T11:52:05.226Z"), + startedAt: new Date("2022-09-04T01:52:32.823Z"), + endedAt: new Date("2023-05-22T07:36:17.577Z"), userId: "", productId: "", priceId: "", @@ -78,7 +82,7 @@ let value: Order = { | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | | `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | | `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `metadata` | Record | :heavy_check_mark: | N/A | +| `metadata` | Record | :heavy_check_mark: | N/A | | `customFieldData` | [components.OrderCustomFieldData](../../models/components/ordercustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | | `amount` | *number* | :heavy_check_mark: | N/A | | `taxAmount` | *number* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/orderbillingreason.md b/docs/models/components/orderbillingreason.md index df62d6d0..6bc31e67 100644 --- a/docs/models/components/orderbillingreason.md +++ b/docs/models/components/orderbillingreason.md @@ -5,7 +5,7 @@ ```typescript import { OrderBillingReason } from "@polar-sh/sdk/models/components"; -let value: OrderBillingReason = "subscription_cycle"; +let value: OrderBillingReason = "purchase"; ``` ## Values diff --git a/docs/models/components/orderinvoice.md b/docs/models/components/orderinvoice.md index 82c89094..29df60a3 100644 --- a/docs/models/components/orderinvoice.md +++ b/docs/models/components/orderinvoice.md @@ -8,7 +8,7 @@ Order's invoice data. import { OrderInvoice } from "@polar-sh/sdk/models/components"; let value: OrderInvoice = { - url: "https://super-someplace.name/", + url: "https://awful-antelope.info/", }; ``` diff --git a/docs/models/components/ordermetadata.md b/docs/models/components/ordermetadata.md new file mode 100644 index 00000000..bba91aed --- /dev/null +++ b/docs/models/components/ordermetadata.md @@ -0,0 +1,23 @@ +# OrderMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 614594; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/orderproduct.md b/docs/models/components/orderproduct.md index 600ff88c..9e76fee2 100644 --- a/docs/models/components/orderproduct.md +++ b/docs/models/components/orderproduct.md @@ -6,11 +6,11 @@ import { OrderProduct } from "@polar-sh/sdk/models/components"; let value: OrderProduct = { - createdAt: new Date("2022-11-06T01:22:31.085Z"), - modifiedAt: new Date("2022-03-11T01:49:52.647Z"), + createdAt: new Date("2023-06-10T21:43:08.762Z"), + modifiedAt: new Date("2023-11-28T22:56:04.984Z"), id: "", name: "", - description: "circa mid zowie coolly", + description: "aw or perfumed justly shirk where now", isRecurring: false, isArchived: false, organizationId: "", diff --git a/docs/models/components/ordersortproperty.md b/docs/models/components/ordersortproperty.md index e9dd4c6c..6b16d3a0 100644 --- a/docs/models/components/ordersortproperty.md +++ b/docs/models/components/ordersortproperty.md @@ -5,7 +5,7 @@ ```typescript import { OrderSortProperty } from "@polar-sh/sdk/models/components"; -let value: OrderSortProperty = "user"; +let value: OrderSortProperty = "-user"; ``` ## Values diff --git a/docs/models/components/ordersubscription.md b/docs/models/components/ordersubscription.md index 46940bba..57f98586 100644 --- a/docs/models/components/ordersubscription.md +++ b/docs/models/components/ordersubscription.md @@ -9,18 +9,18 @@ let value: OrderSubscription = { metadata: { "key": "", }, - createdAt: new Date("2024-07-12T15:55:58.752Z"), - modifiedAt: new Date("2024-05-09T07:26:43.620Z"), + createdAt: new Date("2022-12-03T10:32:14.023Z"), + modifiedAt: new Date("2023-08-29T05:23:30.237Z"), id: "", - amount: 218756, - currency: "Iranian Rial", + amount: 401260, + currency: "Russian Ruble", recurringInterval: "month", - status: "trialing", - currentPeriodStart: new Date("2022-08-20T06:58:32.848Z"), - currentPeriodEnd: new Date("2022-09-05T20:51:23.814Z"), + status: "active", + currentPeriodStart: new Date("2024-06-18T20:47:45.015Z"), + currentPeriodEnd: new Date("2022-06-06T11:24:14.782Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-01-28T00:03:50.601Z"), - endedAt: new Date("2022-06-16T02:33:31.041Z"), + startedAt: new Date("2024-09-07T20:11:01.826Z"), + endedAt: new Date("2023-05-06T04:21:20.735Z"), userId: "", productId: "", priceId: "", @@ -32,7 +32,7 @@ let value: OrderSubscription = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_check_mark: | N/A | +| `metadata` | Record | :heavy_check_mark: | N/A | | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | | `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | | `id` | *string* | :heavy_check_mark: | The ID of the object. | diff --git a/docs/models/components/ordersubscriptionmetadata.md b/docs/models/components/ordersubscriptionmetadata.md new file mode 100644 index 00000000..b3096329 --- /dev/null +++ b/docs/models/components/ordersubscriptionmetadata.md @@ -0,0 +1,23 @@ +# OrderSubscriptionMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 574923; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/orderuser.md b/docs/models/components/orderuser.md index 29412a95..7f1e94bf 100644 --- a/docs/models/components/orderuser.md +++ b/docs/models/components/orderuser.md @@ -7,10 +7,10 @@ import { OrderUser } from "@polar-sh/sdk/models/components"; let value: OrderUser = { id: "", - email: "Zoe83@gmail.com", + email: "Eusebio.Cole53@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://next-designation.name", + avatarUrl: "https://exotic-remark.org/", }; ``` diff --git a/docs/models/components/organization.md b/docs/models/components/organization.md index 656b8d61..3697f14c 100644 --- a/docs/models/components/organization.md +++ b/docs/models/components/organization.md @@ -6,22 +6,21 @@ import { Organization } from "@polar-sh/sdk/models/components"; let value: Organization = { - createdAt: new Date("2024-06-15T19:50:49.445Z"), - modifiedAt: new Date("2023-06-30T02:38:21.936Z"), + createdAt: new Date("2022-01-20T10:50:32.334Z"), + modifiedAt: new Date("2023-12-22T15:24:11.981Z"), id: "", name: "", slug: "", - avatarUrl: "https://pale-seagull.biz/", + avatarUrl: "https://clueless-trench.org/", bio: "", - company: "Keebler, Windler and Russel", + company: "Gutkowski - Cummerata", blog: "", location: "", - email: "Ahmed93@yahoo.com", + email: "Samir73@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 269889, + pledgeMinimumAmount: 281416, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 301768, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 690654, profileSettings: {}, featureSettings: {}, }; @@ -46,6 +45,5 @@ let value: Organization = { | `pledgeMinimumAmount` | *number* | :heavy_check_mark: | N/A | | `pledgeBadgeShowAmount` | *boolean* | :heavy_check_mark: | N/A | | `defaultUpfrontSplitToContributors` | *number* | :heavy_check_mark: | N/A | -| `donationsEnabled` | *boolean* | :heavy_check_mark: | If this organizations accepts donations | | `profileSettings` | [components.OrganizationProfileSettings](../../models/components/organizationprofilesettings.md) | :heavy_check_mark: | Settings for the organization profile | | `featureSettings` | [components.OrganizationFeatureSettings](../../models/components/organizationfeaturesettings.md) | :heavy_check_mark: | Settings for the organization features | \ No newline at end of file diff --git a/docs/models/components/organizationavatarfilecreate.md b/docs/models/components/organizationavatarfilecreate.md index 9366a391..4714206d 100644 --- a/docs/models/components/organizationavatarfilecreate.md +++ b/docs/models/components/organizationavatarfilecreate.md @@ -10,13 +10,13 @@ import { OrganizationAvatarFileCreate } from "@polar-sh/sdk/models/components"; let value: OrganizationAvatarFileCreate = { name: "", mimeType: "", - size: 415732, + size: 940497, upload: { parts: [ { - number: 42665, - chunkStart: 533171, - chunkEnd: 116704, + number: 966607, + chunkStart: 844253, + chunkEnd: 888924, }, ], }, diff --git a/docs/models/components/organizationavatarfileread.md b/docs/models/components/organizationavatarfileread.md index 82dc3a99..b696f66c 100644 --- a/docs/models/components/organizationavatarfileread.md +++ b/docs/models/components/organizationavatarfileread.md @@ -11,19 +11,19 @@ let value: OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/sys", + path: "/media", mimeType: "", - size: 649908, + size: 10185, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-01-02T23:03:39.516Z"), + lastModifiedAt: new Date("2022-09-21T21:29:51.348Z"), version: "", isUploaded: false, - createdAt: new Date("2023-02-10T11:23:09.076Z"), + createdAt: new Date("2024-07-17T18:56:25.683Z"), sizeReadable: "", - publicUrl: "https://woeful-cd.net/", + publicUrl: "https://rusty-newsprint.name", }; ``` diff --git a/docs/models/components/organizationcreate.md b/docs/models/components/organizationcreate.md index 529633bb..c7bcc95e 100644 --- a/docs/models/components/organizationcreate.md +++ b/docs/models/components/organizationcreate.md @@ -18,5 +18,4 @@ let value: OrganizationCreate = { | `name` | *string* | :heavy_check_mark: | N/A | | `slug` | *string* | :heavy_check_mark: | N/A | | `avatarUrl` | *string* | :heavy_minus_sign: | N/A | -| `donationsEnabled` | *boolean* | :heavy_minus_sign: | N/A | | `featureSettings` | [components.OrganizationFeatureSettings](../../models/components/organizationfeaturesettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/organizationupdate.md b/docs/models/components/organizationupdate.md index c1d54793..d2615930 100644 --- a/docs/models/components/organizationupdate.md +++ b/docs/models/components/organizationupdate.md @@ -21,6 +21,5 @@ let value: OrganizationUpdate = {}; | `pledgeMinimumAmount` | *number* | :heavy_minus_sign: | N/A | | `totalMonthlySpendingLimit` | *number* | :heavy_minus_sign: | N/A | | `perUserMonthlySpendingLimit` | *number* | :heavy_minus_sign: | N/A | -| `donationsEnabled` | *boolean* | :heavy_minus_sign: | N/A | | `profileSettings` | [components.OrganizationProfileSettings](../../models/components/organizationprofilesettings.md) | :heavy_minus_sign: | N/A | | `featureSettings` | [components.OrganizationFeatureSettings](../../models/components/organizationfeaturesettings.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/pagination.md b/docs/models/components/pagination.md index 0810c482..bdf029cc 100644 --- a/docs/models/components/pagination.md +++ b/docs/models/components/pagination.md @@ -6,8 +6,8 @@ import { Pagination } from "@polar-sh/sdk/models/components"; let value: Pagination = { - totalCount: 659804, - maxPage: 94487, + totalCount: 92978, + maxPage: 904288, }; ``` diff --git a/docs/models/components/paymentprocessor.md b/docs/models/components/paymentprocessor.md index 8a150a40..c047f2b2 100644 --- a/docs/models/components/paymentprocessor.md +++ b/docs/models/components/paymentprocessor.md @@ -1,7 +1,5 @@ # PaymentProcessor -Payment processor to use. Currently only Stripe is supported. - ## Example Usage ```typescript diff --git a/docs/models/components/permission.md b/docs/models/components/permission.md index 52ae5f7b..7d1901c7 100644 --- a/docs/models/components/permission.md +++ b/docs/models/components/permission.md @@ -7,7 +7,7 @@ The permission level to grant. Read more about roles and their permissions on [G ```typescript import { Permission } from "@polar-sh/sdk/models/components"; -let value: Permission = "push"; +let value: Permission = "maintain"; ``` ## Values diff --git a/docs/models/components/pledge.md b/docs/models/components/pledge.md index 50c94c3d..539260ee 100644 --- a/docs/models/components/pledge.md +++ b/docs/models/components/pledge.md @@ -6,62 +6,61 @@ import { Pledge } from "@polar-sh/sdk/models/components"; let value: Pledge = { - createdAt: new Date("2024-06-16T22:04:20.447Z"), - modifiedAt: new Date("2024-03-16T09:04:21.592Z"), + createdAt: new Date("2024-11-20T14:57:47.889Z"), + modifiedAt: new Date("2023-02-13T09:46:48.968Z"), id: "", - amount: 844388, - currency: "Brazilian Real", - state: "refunded", + amount: 630837, + currency: "Som", + state: "pending", type: "pay_directly", issue: { - id: "b1ba5406-46b2-47c3-9de1-1a8ec81174fa", - number: 356958, + id: "97028f7a-de52-4f8e-841e-67f69b34bc34", + number: 384833, title: "", - state: "open", - issueCreatedAt: new Date("2022-10-01T15:47:39.560Z"), + state: "closed", + issueCreatedAt: new Date("2023-03-16T20:51:34.627Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "5a2a1ea9-2b3c-4cfc-b58a-4c520a4dc18f", + id: "c09ff90d-b0cb-4188-ae78-88dfe3d50817", isPrivate: false, name: "MyOrg", description: - "that form hospitable consequently greedily upside-down consequently bah deploy", + "cork lavish suffice quantify archive regularly yippee enraged whoever", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "94351be0-a9ea-4692-8237-418b1b0bf714", + id: "934ab942-a322-4bbe-949e-37ff87f93898", name: "", - avatarUrl: "https://delicious-yin.info", + avatarUrl: "https://trivial-cantaloupe.com/", isPersonal: false, bio: "", prettyName: "", - company: "Bergnaum LLC", + company: "Batz - Stiedemann", blog: "", location: "", - email: "Devonte_Boyle@gmail.com", + email: "Boris86@hotmail.com", twitterUsername: "", organizationId: "", }, internalOrganization: { - createdAt: new Date("2022-11-13T19:30:07.544Z"), - modifiedAt: new Date("2022-09-17T06:04:05.728Z"), + createdAt: new Date("2024-03-22T22:29:10.462Z"), + modifiedAt: new Date("2022-07-02T13:20:48.734Z"), id: "", name: "", slug: "", - avatarUrl: "https://reasonable-seagull.info/", + avatarUrl: "https://digital-sonnet.info/", bio: "", - company: "Renner - Glover", + company: "Altenwerth - Gottlieb", blog: "", location: "", - email: "Eldred.Kovacek46@hotmail.com", + email: "Alexandria_Beer@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 987015, + pledgeMinimumAmount: 221139, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 974537, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 338526, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/pledger.md b/docs/models/components/pledger.md index f676dd9d..a2138011 100644 --- a/docs/models/components/pledger.md +++ b/docs/models/components/pledger.md @@ -8,7 +8,7 @@ import { Pledger } from "@polar-sh/sdk/models/components"; let value: Pledger = { name: "", githubUsername: "", - avatarUrl: "https://untimely-extension.net", + avatarUrl: "https://scaly-sundae.info/", }; ``` diff --git a/docs/models/components/pledgetype.md b/docs/models/components/pledgetype.md index 985d6654..bb9fbb67 100644 --- a/docs/models/components/pledgetype.md +++ b/docs/models/components/pledgetype.md @@ -5,7 +5,7 @@ ```typescript import { PledgeType } from "@polar-sh/sdk/models/components"; -let value: PledgeType = "pay_directly"; +let value: PledgeType = "pay_on_completion"; ``` ## Values diff --git a/docs/models/components/polarcheckoutlegacyschemascheckout.md b/docs/models/components/polarcheckoutlegacyschemascheckout.md index 1c5862d2..71ee3cd7 100644 --- a/docs/models/components/polarcheckoutlegacyschemascheckout.md +++ b/docs/models/components/polarcheckoutlegacyschemascheckout.md @@ -12,36 +12,31 @@ let value: PolarCheckoutLegacySchemasCheckout = { customerEmail: "", customerName: "", product: { - createdAt: new Date("2023-10-22T07:26:03.546Z"), - modifiedAt: new Date("2023-07-17T20:00:09.846Z"), + createdAt: new Date("2023-04-12T03:41:23.498Z"), + modifiedAt: new Date("2023-12-29T22:55:04.311Z"), id: "", name: "", - description: - "whether border boo fledgling developmental arrogantly midwife out substitution", + description: "digit loyally internal pastel healthily per", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-09-08T01:04:48.170Z"), - modifiedAt: new Date("2023-04-16T04:46:35.940Z"), + createdAt: new Date("2022-11-29T16:28:43.939Z"), + modifiedAt: new Date("2024-03-14T21:12:21.541Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 670168, - maximumAmount: 424591, - presetAmount: 708007, - recurringInterval: "year", + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2023-08-25T17:28:28.690Z"), - modifiedAt: new Date("2023-10-18T13:42:30.603Z"), + createdAt: new Date("2022-05-18T21:51:08.310Z"), + modifiedAt: new Date("2022-04-28T02:22:10.521Z"), id: "", - type: "license_keys", - description: "furthermore saturate aw sadly ah and poor right", + type: "discord", + description: "as across haversack hasty wee regularly for premier", selectable: false, deletable: false, organizationId: "", @@ -52,30 +47,30 @@ let value: PolarCheckoutLegacySchemasCheckout = { id: "", organizationId: "", name: "", - path: "/var/mail", + path: "/private", mimeType: "", - size: 407209, + size: 33295, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-04-26T21:45:53.740Z"), + lastModifiedAt: new Date("2022-03-31T01:33:21.843Z"), version: "", isUploaded: false, - createdAt: new Date("2023-07-13T01:37:39.797Z"), + createdAt: new Date("2024-10-15T15:41:01.316Z"), sizeReadable: "", - publicUrl: "https://afraid-honesty.name/", + publicUrl: "https://negative-cruelty.com", }, ], }, productPrice: { - createdAt: new Date("2024-10-29T06:16:02.069Z"), - modifiedAt: new Date("2024-08-27T16:44:25.827Z"), + createdAt: new Date("2022-08-23T14:07:24.267Z"), + modifiedAt: new Date("2022-07-08T20:28:56.674Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 873618, + priceAmount: 808797, }, }; ``` diff --git a/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md b/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md index 42aa43e8..051e1c88 100644 --- a/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md +++ b/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md @@ -7,7 +7,7 @@ import { PolarCheckoutLegacySchemasCheckoutCreate } from "@polar-sh/sdk/models/c let value: PolarCheckoutLegacySchemasCheckoutCreate = { productPriceId: "", - successUrl: "https://right-sock.name", + successUrl: "https://thorny-yak.net", }; ``` diff --git a/docs/models/components/polarcheckoutschemascheckout.md b/docs/models/components/polarcheckoutschemascheckout.md index 34e46123..1dc4ea71 100644 --- a/docs/models/components/polarcheckoutschemascheckout.md +++ b/docs/models/components/polarcheckoutschemascheckout.md @@ -8,63 +8,58 @@ Checkout session data retrieved using an access token. import { PolarCheckoutSchemasCheckout } from "@polar-sh/sdk/models/components"; let value: PolarCheckoutSchemasCheckout = { - createdAt: new Date("2023-03-10T23:31:28.664Z"), - modifiedAt: new Date("2024-04-09T16:36:06.881Z"), + createdAt: new Date("2023-08-24T23:11:15.301Z"), + modifiedAt: new Date("2023-04-04T00:47:20.992Z"), id: "", status: "open", clientSecret: "", - url: "https://self-assured-fat.net/", - expiresAt: new Date("2022-01-26T01:19:06.557Z"), - successUrl: "https://necessary-chasuble.com", + url: "https://spiffy-litter.biz/", + expiresAt: new Date("2023-05-04T04:09:06.657Z"), + successUrl: "https://realistic-calculus.name", embedOrigin: "", - amount: 928155, - taxAmount: 505017, - currency: "Australian Dollar", - totalAmount: 148557, + amount: 198695, + taxAmount: 978408, + currency: "Solomon Islands Dollar", + totalAmount: 81000, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Jasen82@hotmail.com", + customerEmail: "Arianna.Senger16@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "United Arab Emirates", + country: "Nepal", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { - "key": "", + "key": false, }, product: { - createdAt: new Date("2024-03-09T15:40:10.296Z"), - modifiedAt: new Date("2022-02-27T13:45:36.700Z"), + createdAt: new Date("2024-06-20T17:08:39.320Z"), + modifiedAt: new Date("2022-08-09T05:10:15.962Z"), id: "", name: "", - description: - "implode ick sans in aha cheerful after weary oval furthermore", + description: "verbally merrily legend punctually amid joyously gee hateful", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-06-13T17:02:40.832Z"), - modifiedAt: new Date("2022-05-21T23:41:53.158Z"), + createdAt: new Date("2022-01-18T18:59:13.114Z"), + modifiedAt: new Date("2024-10-05T21:58:09.997Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 28163, - maximumAmount: 759236, - presetAmount: 73989, }, ], benefits: [ { - createdAt: new Date("2023-08-13T03:13:38.266Z"), - modifiedAt: new Date("2023-07-23T06:22:31.196Z"), + createdAt: new Date("2022-08-14T05:05:54.788Z"), + modifiedAt: new Date("2023-03-26T01:06:23.500Z"), id: "", - description: "geez abnormally cleaner order mmm", + description: "bulky inwardly importance", selectable: false, deletable: false, organizationId: "", @@ -78,46 +73,49 @@ let value: PolarCheckoutSchemasCheckout = { id: "", organizationId: "", name: "", - path: "/var/mail", + path: "/opt/lib", mimeType: "", - size: 16232, + size: 549457, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-10-05T21:58:09.997Z"), + lastModifiedAt: new Date("2023-12-03T06:03:57.837Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-28T00:21:29.394Z"), + createdAt: new Date("2022-03-06T13:25:23.485Z"), sizeReadable: "", - publicUrl: "https://incomparable-cash.net/", + publicUrl: "https://complete-hose.org", }, ], }, productPrice: { - createdAt: new Date("2023-04-29T19:57:08.545Z"), - modifiedAt: new Date("2023-11-22T13:08:14.775Z"), + createdAt: new Date("2023-04-09T15:05:07.991Z"), + modifiedAt: new Date("2022-03-08T04:36:01.401Z"), id: "", isArchived: false, productId: "", + priceCurrency: "", + priceAmount: 286276, + recurringInterval: "month", }, subscriptionId: "", attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-04-13T08:13:23.724Z"), - modifiedAt: new Date("2022-05-11T14:20:11.184Z"), + createdAt: new Date("2023-09-21T10:09:14.320Z"), + modifiedAt: new Date("2024-04-01T05:07:23.085Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", properties: {}, }, - order: 817785, + order: 437621, required: false, }, ], @@ -132,7 +130,7 @@ let value: PolarCheckoutSchemasCheckout = { | `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | | `id` | *string* | :heavy_check_mark: | The ID of the object. | | `customFieldData` | [components.PolarCheckoutSchemasCheckoutCustomFieldData](../../models/components/polarcheckoutschemascheckoutcustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | N/A | +| `paymentProcessor` | [components.PaymentProcessor](../../models/components/paymentprocessor.md) | :heavy_check_mark: | N/A | | `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | N/A | | `clientSecret` | *string* | :heavy_check_mark: | Client secret used to update and complete the checkout session from the client. | | `url` | *string* | :heavy_check_mark: | URL where the customer can access the checkout session. | @@ -153,7 +151,7 @@ let value: PolarCheckoutSchemasCheckout = { | `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_check_mark: | N/A | | `customerTaxId` | *string* | :heavy_check_mark: | N/A | | `paymentProcessorMetadata` | [components.PaymentProcessorMetadata](../../models/components/paymentprocessormetadata.md) | :heavy_check_mark: | N/A | -| `metadata` | Record | :heavy_check_mark: | N/A | +| `metadata` | Record | :heavy_check_mark: | N/A | | `product` | [components.CheckoutProduct](../../models/components/checkoutproduct.md) | :heavy_check_mark: | Product data for a checkout session. | | `productPrice` | *components.ProductPrice* | :heavy_check_mark: | N/A | | `subscriptionId` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/polarcheckoutschemascheckoutcreate.md b/docs/models/components/polarcheckoutschemascheckoutcreate.md index c252ce03..e5f4470c 100644 --- a/docs/models/components/polarcheckoutschemascheckoutcreate.md +++ b/docs/models/components/polarcheckoutschemascheckoutcreate.md @@ -17,18 +17,18 @@ let value: PolarCheckoutSchemasCheckoutCreate = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be a string with a maximum length of **500 characters**.
You can store up to **50 key-value pairs**. | -| `customFieldData` | [components.PolarCheckoutSchemasCheckoutCreateCustomFieldData](../../models/components/polarcheckoutschemascheckoutcreatecustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `paymentProcessor` | [components.PaymentProcessor](../../models/components/paymentprocessor.md) | :heavy_check_mark: | Payment processor to use. Currently only Stripe is supported. | -| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | -| `amount` | *number* | :heavy_minus_sign: | N/A | -| `customerName` | *string* | :heavy_minus_sign: | N/A | -| `customerEmail` | *string* | :heavy_minus_sign: | N/A | -| `customerIpAddress` | *string* | :heavy_minus_sign: | N/A | -| `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_minus_sign: | N/A | -| `customerTaxId` | *string* | :heavy_minus_sign: | N/A | -| `subscriptionId` | *string* | :heavy_minus_sign: | ID of a subscription to upgrade. It must be on a free pricing. If checkout is successful, metadata set on this checkout will be copied to the subscription, and existing keys will be overwritten. | -| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | -| `embedOrigin` | *string* | :heavy_minus_sign: | If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `customFieldData` | [components.PolarCheckoutSchemasCheckoutCreateCustomFieldData](../../models/components/polarcheckoutschemascheckoutcreatecustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | +| `paymentProcessor` | [components.PolarCheckoutSchemasCheckoutCreatePaymentProcessor](../../models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md) | :heavy_check_mark: | Payment processor to use. Currently only Stripe is supported. | +| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | +| `amount` | *number* | :heavy_minus_sign: | N/A | +| `customerName` | *string* | :heavy_minus_sign: | N/A | +| `customerEmail` | *string* | :heavy_minus_sign: | N/A | +| `customerIpAddress` | *string* | :heavy_minus_sign: | N/A | +| `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_minus_sign: | N/A | +| `customerTaxId` | *string* | :heavy_minus_sign: | N/A | +| `subscriptionId` | *string* | :heavy_minus_sign: | ID of a subscription to upgrade. It must be on a free pricing. If checkout is successful, metadata set on this checkout will be copied to the subscription, and existing keys will be overwritten. | +| `successUrl` | *string* | :heavy_minus_sign: | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. | +| `embedOrigin` | *string* | :heavy_minus_sign: | If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page. | \ No newline at end of file diff --git a/docs/models/components/polarcheckoutschemascheckoutcreatemetadata.md b/docs/models/components/polarcheckoutschemascheckoutcreatemetadata.md new file mode 100644 index 00000000..56a0f264 --- /dev/null +++ b/docs/models/components/polarcheckoutschemascheckoutcreatemetadata.md @@ -0,0 +1,23 @@ +# PolarCheckoutSchemasCheckoutCreateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 870008; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md b/docs/models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md new file mode 100644 index 00000000..5d069395 --- /dev/null +++ b/docs/models/components/polarcheckoutschemascheckoutcreatepaymentprocessor.md @@ -0,0 +1,17 @@ +# PolarCheckoutSchemasCheckoutCreatePaymentProcessor + +Payment processor to use. Currently only Stripe is supported. + +## Example Usage + +```typescript +import { PolarCheckoutSchemasCheckoutCreatePaymentProcessor } from "@polar-sh/sdk/models/components"; + +let value: PolarCheckoutSchemasCheckoutCreatePaymentProcessor = "stripe"; +``` + +## Values + +```typescript +"stripe" +``` \ No newline at end of file diff --git a/docs/models/components/polarcheckoutschemascheckoutinput.md b/docs/models/components/polarcheckoutschemascheckoutinput.md deleted file mode 100644 index 11a44740..00000000 --- a/docs/models/components/polarcheckoutschemascheckoutinput.md +++ /dev/null @@ -1,155 +0,0 @@ -# PolarCheckoutSchemasCheckoutInput - -Checkout session data retrieved using an access token. - -## Example Usage - -```typescript -import { PolarCheckoutSchemasCheckoutInput } from "@polar-sh/sdk/models/components"; - -let value: PolarCheckoutSchemasCheckoutInput = { - createdAt: new Date("2023-02-08T14:10:26.713Z"), - modifiedAt: new Date("2022-03-03T22:35:13.208Z"), - id: "", - status: "succeeded", - clientSecret: "", - url: "https://light-haversack.name", - expiresAt: new Date("2024-10-02T02:04:23.656Z"), - successUrl: "https://ill-fraudster.biz/", - embedOrigin: "", - amount: 832764, - taxAmount: 230161, - currency: "Tugrik", - totalAmount: 781342, - productId: "", - productPriceId: "", - isPaymentRequired: false, - customerId: "", - customerName: "", - customerEmail: "Joanie_Bins@gmail.com", - customerIpAddress: "", - customerBillingAddress: { - country: "Oman", - }, - customerTaxId: "", - paymentProcessorMetadata: {}, - metadata: { - "key": "", - }, - product: { - createdAt: new Date("2023-05-02T01:12:09.041Z"), - modifiedAt: new Date("2023-02-12T19:18:02.060Z"), - id: "", - name: "", - description: "sugary broadcast whether fooey sesame hyena because", - isRecurring: false, - isArchived: false, - organizationId: "", - prices: [ - { - createdAt: new Date("2022-03-26T05:37:58.180Z"), - modifiedAt: new Date("2022-07-28T12:33:28.889Z"), - id: "", - isArchived: false, - productId: "", - }, - ], - benefits: [ - { - createdAt: new Date("2022-01-16T03:49:13.516Z"), - modifiedAt: new Date("2024-10-12T04:07:38.112Z"), - id: "", - description: "intend quiet augment", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, - }, - ], - medias: [ - { - id: "", - organizationId: "", - name: "", - path: "/usr/libexec", - mimeType: "", - size: 980859, - storageVersion: "", - checksumEtag: "", - checksumSha256Base64: "", - checksumSha256Hex: "", - lastModifiedAt: new Date("2024-05-16T15:26:37.196Z"), - version: "", - isUploaded: false, - createdAt: new Date("2023-03-13T01:49:16.383Z"), - }, - ], - }, - productPrice: { - createdAt: new Date("2023-12-22T21:21:58.162Z"), - modifiedAt: new Date("2023-07-22T04:52:15.720Z"), - id: "", - isArchived: false, - productId: "", - priceCurrency: "", - priceAmount: 662228, - }, - subscriptionId: "", - attachedCustomFields: [ - { - customFieldId: "", - customField: { - createdAt: new Date("2022-06-18T23:13:24.033Z"), - modifiedAt: new Date("2023-04-07T11:06:58.417Z"), - id: "", - metadata: { - "key": "", - }, - slug: "", - name: "", - organizationId: "", - properties: {}, - }, - order: 477409, - required: false, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `customFieldData` | [components.PolarCheckoutSchemasCheckoutCustomFieldData](../../models/components/polarcheckoutschemascheckoutcustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | N/A | -| `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | N/A | -| `clientSecret` | *string* | :heavy_check_mark: | Client secret used to update and complete the checkout session from the client. | -| `url` | *string* | :heavy_check_mark: | URL where the customer can access the checkout session. | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Expiration date and time of the checkout session. | -| `successUrl` | *string* | :heavy_check_mark: | URL where the customer will be redirected after a successful payment. | -| `embedOrigin` | *string* | :heavy_check_mark: | When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page. | -| `amount` | *number* | :heavy_check_mark: | N/A | -| `taxAmount` | *number* | :heavy_check_mark: | Computed tax amount to pay in cents. | -| `currency` | *string* | :heavy_check_mark: | Currency code of the checkout session. | -| `totalAmount` | *number* | :heavy_check_mark: | Total amount to pay in cents. | -| `productId` | *string* | :heavy_check_mark: | ID of the product to checkout. | -| `productPriceId` | *string* | :heavy_check_mark: | ID of the product price to checkout. | -| `isPaymentRequired` | *boolean* | :heavy_check_mark: | Whether the checkout requires payment. Useful to detect free products. | -| `customerId` | *string* | :heavy_check_mark: | N/A | -| `customerName` | *string* | :heavy_check_mark: | N/A | -| `customerEmail` | *string* | :heavy_check_mark: | N/A | -| `customerIpAddress` | *string* | :heavy_check_mark: | N/A | -| `customerBillingAddress` | [components.Address](../../models/components/address.md) | :heavy_check_mark: | N/A | -| `customerTaxId` | *string* | :heavy_check_mark: | N/A | -| `paymentProcessorMetadata` | [components.PaymentProcessorMetadata](../../models/components/paymentprocessormetadata.md) | :heavy_check_mark: | N/A | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `product` | [components.CheckoutProductInput](../../models/components/checkoutproductinput.md) | :heavy_check_mark: | Product data for a checkout session. | -| `productPrice` | *components.ProductPrice* | :heavy_check_mark: | N/A | -| `subscriptionId` | *string* | :heavy_check_mark: | N/A | -| `attachedCustomFields` | [components.AttachedCustomField](../../models/components/attachedcustomfield.md)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/polarcheckoutschemascheckoutmetadata.md b/docs/models/components/polarcheckoutschemascheckoutmetadata.md new file mode 100644 index 00000000..451de859 --- /dev/null +++ b/docs/models/components/polarcheckoutschemascheckoutmetadata.md @@ -0,0 +1,23 @@ +# PolarCheckoutSchemasCheckoutMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 204579; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/polarenumspaymentprocessor.md b/docs/models/components/polarenumspaymentprocessor.md deleted file mode 100644 index a89b3ced..00000000 --- a/docs/models/components/polarenumspaymentprocessor.md +++ /dev/null @@ -1,15 +0,0 @@ -# PolarEnumsPaymentProcessor - -## Example Usage - -```typescript -import { PolarEnumsPaymentProcessor } from "@polar-sh/sdk/models/components"; - -let value: PolarEnumsPaymentProcessor = "stripe"; -``` - -## Values - -```typescript -"stripe" -``` \ No newline at end of file diff --git a/docs/models/components/prices.md b/docs/models/components/prices.md index 31f74014..a5d5c8c8 100644 --- a/docs/models/components/prices.md +++ b/docs/models/components/prices.md @@ -7,7 +7,7 @@ ```typescript const value: components.ProductPriceOneTimeFixedCreate = { - priceAmount: 717659, + priceAmount: 179389, }; ``` diff --git a/docs/models/components/product.md b/docs/models/components/product.md index 928dbf30..e6966006 100644 --- a/docs/models/components/product.md +++ b/docs/models/components/product.md @@ -8,41 +8,37 @@ A product. import { Product } from "@polar-sh/sdk/models/components"; let value: Product = { - createdAt: new Date("2022-01-29T05:10:32.874Z"), - modifiedAt: new Date("2023-03-01T23:51:11.548Z"), + createdAt: new Date("2024-10-06T08:46:10.626Z"), + modifiedAt: new Date("2022-08-21T10:30:21.944Z"), id: "", name: "", - description: "adrenalin bonfire catch brr than a", + description: "perky if defiantly reassemble information adrenalin", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 665687, + }, prices: [ { - createdAt: new Date("2024-03-17T01:50:29.399Z"), - modifiedAt: new Date("2022-08-16T22:10:33.984Z"), + createdAt: new Date("2022-10-10T19:36:32.221Z"), + modifiedAt: new Date("2024-07-22T16:47:45.821Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 164765, }, ], benefits: [ { - createdAt: new Date("2024-12-13T21:16:19.781Z"), - modifiedAt: new Date("2023-04-08T14:07:06.599Z"), + createdAt: new Date("2022-10-15T02:28:08.072Z"), + modifiedAt: new Date("2022-08-13T13:39:26.566Z"), id: "", description: - "governance ice-cream uncover where dependency ha gadzooks burdensome pfft", + "phew scholarship what shabby bloom blah along eek override absent", selectable: false, deletable: false, organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "admin", - }, + properties: {}, }, ], medias: [ @@ -50,37 +46,37 @@ let value: Product = { id: "", organizationId: "", name: "", - path: "/boot", + path: "/usr/local/bin", mimeType: "", - size: 398054, + size: 673057, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-08-01T01:47:59.550Z"), + lastModifiedAt: new Date("2023-04-27T08:46:07.096Z"), version: "", isUploaded: false, - createdAt: new Date("2023-05-04T15:45:49.822Z"), + createdAt: new Date("2023-07-08T03:14:38.624Z"), sizeReadable: "", - publicUrl: "https://lawful-reach.biz/", + publicUrl: "https://ultimate-confusion.org", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-10-28T02:42:30.721Z"), - modifiedAt: new Date("2022-07-03T20:54:21.016Z"), + createdAt: new Date("2022-04-27T07:19:35.512Z"), + modifiedAt: new Date("2022-12-08T09:16:03.862Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", properties: {}, }, - order: 93386, + order: 893434, required: false, }, ], @@ -99,6 +95,7 @@ let value: Product = { | `isRecurring` | *boolean* | :heavy_check_mark: | Whether the product is a subscription tier. | | `isArchived` | *boolean* | :heavy_check_mark: | Whether the product is archived and no longer available. | | `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the product. | +| `metadata` | Record | :heavy_check_mark: | N/A | | `prices` | *components.ProductPrice*[] | :heavy_check_mark: | List of prices for this product. | | `benefits` | *components.Benefit*[] | :heavy_check_mark: | List of benefits granted by the product. | | `medias` | [components.ProductMediaFileRead](../../models/components/productmediafileread.md)[] | :heavy_check_mark: | List of medias associated to the product. | diff --git a/docs/models/components/productinput.md b/docs/models/components/productinput.md deleted file mode 100644 index aea35aac..00000000 --- a/docs/models/components/productinput.md +++ /dev/null @@ -1,112 +0,0 @@ -# ProductInput - -A product. - -## Example Usage - -```typescript -import { ProductInput } from "@polar-sh/sdk/models/components"; - -let value: ProductInput = { - createdAt: new Date("2023-03-27T21:41:18.396Z"), - modifiedAt: new Date("2023-07-17T16:35:31.351Z"), - id: "", - name: "", - description: "chunter meh although", - isRecurring: false, - isArchived: false, - organizationId: "", - prices: [ - { - createdAt: new Date("2024-08-19T03:07:08.900Z"), - modifiedAt: new Date("2022-12-10T22:08:06.542Z"), - id: "", - isArchived: false, - productId: "", - priceCurrency: "", - minimumAmount: 701423, - maximumAmount: 940098, - presetAmount: 179367, - recurringInterval: "month", - }, - ], - benefits: [ - { - createdAt: new Date("2022-02-24T19:52:51.740Z"), - modifiedAt: new Date("2022-11-04T23:36:35.403Z"), - id: "", - description: - "tarragon given phew surprise whether swill futon eyeglasses minus", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 700207, - timeframe: "year", - }, - activations: { - limit: 516070, - enableUserAdmin: false, - }, - limitUsage: 387649, - }, - }, - ], - medias: [ - { - id: "", - organizationId: "", - name: "", - path: "/etc", - mimeType: "", - size: 120507, - storageVersion: "", - checksumEtag: "", - checksumSha256Base64: "", - checksumSha256Hex: "", - lastModifiedAt: new Date("2023-03-19T10:26:27.496Z"), - version: "", - isUploaded: false, - createdAt: new Date("2022-01-04T20:41:50.241Z"), - }, - ], - attachedCustomFields: [ - { - customFieldId: "", - customField: { - createdAt: new Date("2022-02-28T09:04:13.801Z"), - modifiedAt: new Date("2024-04-18T21:08:09.093Z"), - id: "", - metadata: { - "key": "", - }, - slug: "", - name: "", - organizationId: "", - properties: {}, - }, - order: 889398, - required: false, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the product. | -| `name` | *string* | :heavy_check_mark: | The name of the product. | -| `description` | *string* | :heavy_check_mark: | The description of the product. | -| `isRecurring` | *boolean* | :heavy_check_mark: | Whether the product is a subscription tier. | -| `isArchived` | *boolean* | :heavy_check_mark: | Whether the product is archived and no longer available. | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization owning the product. | -| `prices` | *components.ProductPrice*[] | :heavy_check_mark: | List of prices for this product. | -| `benefits` | *components.BenefitInput*[] | :heavy_check_mark: | List of benefits granted by the product. | -| `medias` | [components.ProductMediaFileReadInput](../../models/components/productmediafilereadinput.md)[] | :heavy_check_mark: | List of medias associated to the product. | -| `attachedCustomFields` | [components.AttachedCustomField](../../models/components/attachedcustomfield.md)[] | :heavy_check_mark: | List of custom fields attached to the product. | \ No newline at end of file diff --git a/docs/models/components/productmediafilecreate.md b/docs/models/components/productmediafilecreate.md index 1fec5d03..a8166297 100644 --- a/docs/models/components/productmediafilecreate.md +++ b/docs/models/components/productmediafilecreate.md @@ -10,13 +10,13 @@ import { ProductMediaFileCreate } from "@polar-sh/sdk/models/components"; let value: ProductMediaFileCreate = { name: "", mimeType: "", - size: 888924, + size: 16877, upload: { parts: [ { - number: 905059, - chunkStart: 76555, - chunkEnd: 857243, + number: 839715, + chunkStart: 164585, + chunkEnd: 569596, }, ], }, diff --git a/docs/models/components/productmediafilereadinput.md b/docs/models/components/productmediafilereadinput.md deleted file mode 100644 index ade7e4e7..00000000 --- a/docs/models/components/productmediafilereadinput.md +++ /dev/null @@ -1,46 +0,0 @@ -# ProductMediaFileReadInput - -File to be used as a product media file. - -## Example Usage - -```typescript -import { ProductMediaFileReadInput } from "@polar-sh/sdk/models/components"; - -let value: ProductMediaFileReadInput = { - id: "", - organizationId: "", - name: "", - path: "/sys", - mimeType: "", - size: 428114, - storageVersion: "", - checksumEtag: "", - checksumSha256Base64: "", - checksumSha256Hex: "", - lastModifiedAt: new Date("2023-09-14T23:46:17.041Z"), - version: "", - isUploaded: false, - createdAt: new Date("2024-05-15T14:40:00.265Z"), -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `path` | *string* | :heavy_check_mark: | N/A | -| `mimeType` | *string* | :heavy_check_mark: | N/A | -| `size` | *number* | :heavy_check_mark: | N/A | -| `storageVersion` | *string* | :heavy_check_mark: | N/A | -| `checksumEtag` | *string* | :heavy_check_mark: | N/A | -| `checksumSha256Base64` | *string* | :heavy_check_mark: | N/A | -| `checksumSha256Hex` | *string* | :heavy_check_mark: | N/A | -| `lastModifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `version` | *string* | :heavy_check_mark: | N/A | -| `service` | [components.Service](../../models/components/service.md) | :heavy_check_mark: | N/A | -| `isUploaded` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productmetadata.md b/docs/models/components/productmetadata.md new file mode 100644 index 00000000..91ecaf85 --- /dev/null +++ b/docs/models/components/productmetadata.md @@ -0,0 +1,23 @@ +# ProductMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 185321; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/productonetimecreate.md b/docs/models/components/productonetimecreate.md index d1801432..06acef1e 100644 --- a/docs/models/components/productonetimecreate.md +++ b/docs/models/components/productonetimecreate.md @@ -11,7 +11,7 @@ let value: ProductOneTimeCreate = { name: "", prices: [ { - priceAmount: 455389, + priceAmount: 717659, }, ], }; @@ -19,11 +19,12 @@ let value: ProductOneTimeCreate = { ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the product. | -| `description` | *string* | :heavy_minus_sign: | The description of the product. | -| `prices` | *components.Prices*[] | :heavy_check_mark: | List of available prices for this product. | -| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | -| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | List of custom fields to attach. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the product. **Required unless you use an organization token.** | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_check_mark: | The name of the product. | +| `description` | *string* | :heavy_minus_sign: | The description of the product. | +| `prices` | *components.Prices*[] | :heavy_check_mark: | List of available prices for this product. | +| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | +| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | List of custom fields to attach. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the product. **Required unless you use an organization token.** | \ No newline at end of file diff --git a/docs/models/components/productonetimecreatemetadata.md b/docs/models/components/productonetimecreatemetadata.md new file mode 100644 index 00000000..99c8c0b3 --- /dev/null +++ b/docs/models/components/productonetimecreatemetadata.md @@ -0,0 +1,23 @@ +# ProductOneTimeCreateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 225621; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/productprice.md b/docs/models/components/productprice.md index bff3ed27..d1d526e9 100644 --- a/docs/models/components/productprice.md +++ b/docs/models/components/productprice.md @@ -7,13 +7,13 @@ ```typescript const value: components.ProductPriceRecurring = { - createdAt: new Date("2023-04-19T01:15:36.545Z"), - modifiedAt: new Date("2024-05-27T19:49:50.767Z"), + createdAt: new Date("2024-02-28T15:41:38.993Z"), + modifiedAt: new Date("2024-06-24T20:44:45.993Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 100258, + priceAmount: 646439, recurringInterval: "month", }; ``` @@ -22,11 +22,13 @@ const value: components.ProductPriceRecurring = { ```typescript const value: components.ProductPriceOneTime = { - createdAt: new Date("2023-12-11T17:13:09.073Z"), - modifiedAt: new Date("2023-09-10T01:46:44.404Z"), + createdAt: new Date("2023-09-29T02:52:29.724Z"), + modifiedAt: new Date("2023-05-23T02:09:12.082Z"), id: "", isArchived: false, productId: "", + priceCurrency: "", + priceAmount: 199704, }; ``` diff --git a/docs/models/components/productpriceonetime.md b/docs/models/components/productpriceonetime.md index 7ff51978..bdcd8ef6 100644 --- a/docs/models/components/productpriceonetime.md +++ b/docs/models/components/productpriceonetime.md @@ -7,13 +7,13 @@ ```typescript const value: components.ProductPriceOneTimeFixed = { - createdAt: new Date("2022-10-02T02:39:34.529Z"), - modifiedAt: new Date("2024-11-16T17:16:25.681Z"), + createdAt: new Date("2022-05-07T19:51:00.898Z"), + modifiedAt: new Date("2023-09-08T20:31:08.350Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 771303, + priceAmount: 335650, }; ``` @@ -21,15 +21,15 @@ const value: components.ProductPriceOneTimeFixed = { ```typescript const value: components.ProductPriceOneTimeCustom = { - createdAt: new Date("2022-11-26T03:39:31.331Z"), - modifiedAt: new Date("2023-11-08T00:51:46.255Z"), + createdAt: new Date("2023-05-18T21:35:04.801Z"), + modifiedAt: new Date("2023-04-09T08:14:40.781Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 307848, - maximumAmount: 99467, - presetAmount: 824149, + minimumAmount: 104774, + maximumAmount: 158023, + presetAmount: 86808, }; ``` @@ -37,8 +37,8 @@ const value: components.ProductPriceOneTimeCustom = { ```typescript const value: components.ProductPriceOneTimeFree = { - createdAt: new Date("2023-12-31T17:23:17.649Z"), - modifiedAt: new Date("2023-11-04T22:40:23.273Z"), + createdAt: new Date("2022-07-30T22:07:34.485Z"), + modifiedAt: new Date("2024-07-23T06:41:49.713Z"), id: "", isArchived: false, productId: "", diff --git a/docs/models/components/productpriceonetimecustom.md b/docs/models/components/productpriceonetimecustom.md index 3a927471..e14704a1 100644 --- a/docs/models/components/productpriceonetimecustom.md +++ b/docs/models/components/productpriceonetimecustom.md @@ -8,15 +8,15 @@ A pay-what-you-want price for a one-time product. import { ProductPriceOneTimeCustom } from "@polar-sh/sdk/models/components"; let value: ProductPriceOneTimeCustom = { - createdAt: new Date("2022-06-28T23:33:37.930Z"), - modifiedAt: new Date("2022-02-22T12:02:15.142Z"), + createdAt: new Date("2022-04-20T21:11:30.522Z"), + modifiedAt: new Date("2022-09-07T13:46:41.792Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 191151, - maximumAmount: 250180, - presetAmount: 783643, + minimumAmount: 727440, + maximumAmount: 647553, + presetAmount: 563024, }; ``` diff --git a/docs/models/components/productpriceonetimefixed.md b/docs/models/components/productpriceonetimefixed.md index b687f8d4..f30fe360 100644 --- a/docs/models/components/productpriceonetimefixed.md +++ b/docs/models/components/productpriceonetimefixed.md @@ -8,13 +8,13 @@ A one-time price for a product. import { ProductPriceOneTimeFixed } from "@polar-sh/sdk/models/components"; let value: ProductPriceOneTimeFixed = { - createdAt: new Date("2022-06-05T19:42:55.635Z"), - modifiedAt: new Date("2023-02-18T14:31:39.305Z"), + createdAt: new Date("2022-01-27T21:02:37.558Z"), + modifiedAt: new Date("2023-04-19T01:15:36.545Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 876636, + priceAmount: 800937, }; ``` diff --git a/docs/models/components/productpriceonetimefixedcreate.md b/docs/models/components/productpriceonetimefixedcreate.md index 01eb1dfa..71639b7e 100644 --- a/docs/models/components/productpriceonetimefixedcreate.md +++ b/docs/models/components/productpriceonetimefixedcreate.md @@ -8,7 +8,7 @@ Schema to create a one-time product price. import { ProductPriceOneTimeFixedCreate } from "@polar-sh/sdk/models/components"; let value: ProductPriceOneTimeFixedCreate = { - priceAmount: 120388, + priceAmount: 161952, }; ``` diff --git a/docs/models/components/productpriceonetimefree.md b/docs/models/components/productpriceonetimefree.md index 4517b75f..04305eb3 100644 --- a/docs/models/components/productpriceonetimefree.md +++ b/docs/models/components/productpriceonetimefree.md @@ -8,8 +8,8 @@ A free one-time price for a product. import { ProductPriceOneTimeFree } from "@polar-sh/sdk/models/components"; let value: ProductPriceOneTimeFree = { - createdAt: new Date("2023-12-12T08:42:47.730Z"), - modifiedAt: new Date("2022-01-20T00:11:01.003Z"), + createdAt: new Date("2022-07-08T02:50:24.146Z"), + modifiedAt: new Date("2024-05-20T19:20:37.460Z"), id: "", isArchived: false, productId: "", diff --git a/docs/models/components/productpricerecurring.md b/docs/models/components/productpricerecurring.md index 1047a371..0620ab39 100644 --- a/docs/models/components/productpricerecurring.md +++ b/docs/models/components/productpricerecurring.md @@ -7,13 +7,13 @@ ```typescript const value: components.ProductPriceRecurringFixed = { - createdAt: new Date("2022-07-08T02:50:24.146Z"), - modifiedAt: new Date("2024-05-20T19:20:37.460Z"), + createdAt: new Date("2023-02-08T10:04:44.270Z"), + modifiedAt: new Date("2023-08-17T10:43:42.195Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 141414, + priceAmount: 632917, recurringInterval: "month", }; ``` @@ -22,15 +22,15 @@ const value: components.ProductPriceRecurringFixed = { ```typescript const value: components.ProductPriceRecurringCustom = { - createdAt: new Date("2024-05-21T08:36:06.500Z"), - modifiedAt: new Date("2023-02-09T16:03:01.500Z"), + createdAt: new Date("2024-11-30T15:31:00.419Z"), + modifiedAt: new Date("2022-02-20T15:56:21.256Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 312617, - maximumAmount: 278672, - presetAmount: 324972, + minimumAmount: 658208, + maximumAmount: 909558, + presetAmount: 236564, recurringInterval: "month", }; ``` @@ -39,12 +39,12 @@ const value: components.ProductPriceRecurringCustom = { ```typescript const value: components.ProductPriceRecurringFree = { - createdAt: new Date("2024-02-03T05:15:20.926Z"), - modifiedAt: new Date("2022-09-21T07:51:24.980Z"), + createdAt: new Date("2024-04-15T09:46:18.365Z"), + modifiedAt: new Date("2023-06-18T01:34:34.609Z"), id: "", isArchived: false, productId: "", - recurringInterval: "month", + recurringInterval: "year", }; ``` diff --git a/docs/models/components/productpricerecurringcustom.md b/docs/models/components/productpricerecurringcustom.md index 29004e82..34726fe6 100644 --- a/docs/models/components/productpricerecurringcustom.md +++ b/docs/models/components/productpricerecurringcustom.md @@ -8,15 +8,15 @@ A pay-what-you-want recurring price for a product, i.e. a subscription. import { ProductPriceRecurringCustom } from "@polar-sh/sdk/models/components"; let value: ProductPriceRecurringCustom = { - createdAt: new Date("2023-08-17T13:50:34.495Z"), - modifiedAt: new Date("2023-11-20T01:05:43.827Z"), + createdAt: new Date("2024-01-21T02:57:30.792Z"), + modifiedAt: new Date("2023-04-02T10:43:53.018Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 314053, - maximumAmount: 828001, - presetAmount: 782079, + minimumAmount: 835965, + maximumAmount: 428898, + presetAmount: 712997, recurringInterval: "year", }; ``` diff --git a/docs/models/components/productpricerecurringfixed.md b/docs/models/components/productpricerecurringfixed.md index 7b21ac1e..dcea351a 100644 --- a/docs/models/components/productpricerecurringfixed.md +++ b/docs/models/components/productpricerecurringfixed.md @@ -8,13 +8,13 @@ A recurring price for a product, i.e. a subscription. import { ProductPriceRecurringFixed } from "@polar-sh/sdk/models/components"; let value: ProductPriceRecurringFixed = { - createdAt: new Date("2024-04-30T17:28:03.068Z"), - modifiedAt: new Date("2024-09-27T19:30:45.650Z"), + createdAt: new Date("2023-10-08T16:18:27.768Z"), + modifiedAt: new Date("2024-10-09T02:12:59.827Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 612836, + priceAmount: 12210, recurringInterval: "month", }; ``` diff --git a/docs/models/components/productpricerecurringfixedcreate.md b/docs/models/components/productpricerecurringfixedcreate.md index 790ea879..0462e079 100644 --- a/docs/models/components/productpricerecurringfixedcreate.md +++ b/docs/models/components/productpricerecurringfixedcreate.md @@ -8,7 +8,7 @@ Schema to create a recurring product price, i.e. a subscription. import { ProductPriceRecurringFixedCreate } from "@polar-sh/sdk/models/components"; let value: ProductPriceRecurringFixedCreate = { - priceAmount: 225621, + priceAmount: 123286, recurringInterval: "month", }; ``` diff --git a/docs/models/components/productpricerecurringfree.md b/docs/models/components/productpricerecurringfree.md index dbdb7ec0..577a9df3 100644 --- a/docs/models/components/productpricerecurringfree.md +++ b/docs/models/components/productpricerecurringfree.md @@ -8,8 +8,8 @@ A free recurring price for a product, i.e. a subscription. import { ProductPriceRecurringFree } from "@polar-sh/sdk/models/components"; let value: ProductPriceRecurringFree = { - createdAt: new Date("2022-06-08T22:29:24.231Z"), - modifiedAt: new Date("2024-02-04T07:55:19.464Z"), + createdAt: new Date("2022-05-12T09:56:36.366Z"), + modifiedAt: new Date("2024-02-26T20:59:18.749Z"), id: "", isArchived: false, productId: "", diff --git a/docs/models/components/productrecurringcreate.md b/docs/models/components/productrecurringcreate.md index 98bc0722..0184c21a 100644 --- a/docs/models/components/productrecurringcreate.md +++ b/docs/models/components/productrecurringcreate.md @@ -11,8 +11,8 @@ let value: ProductRecurringCreate = { name: "", prices: [ { - priceAmount: 61893, - recurringInterval: "month", + priceAmount: 435439, + recurringInterval: "year", }, ], }; @@ -20,11 +20,12 @@ let value: ProductRecurringCreate = { ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | The name of the product. | -| `description` | *string* | :heavy_minus_sign: | The description of the product. | -| `prices` | *components.ProductRecurringCreatePrices* | :heavy_check_mark: | List of available prices for this product. | -| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | -| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | List of custom fields to attach. | -| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the product. **Required unless you use an organization token.** | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_check_mark: | The name of the product. | +| `description` | *string* | :heavy_minus_sign: | The description of the product. | +| `prices` | *components.ProductRecurringCreatePrices* | :heavy_check_mark: | List of available prices for this product. | +| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | +| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | List of custom fields to attach. | +| `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the product. **Required unless you use an organization token.** | \ No newline at end of file diff --git a/docs/models/components/productrecurringcreatemetadata.md b/docs/models/components/productrecurringcreatemetadata.md new file mode 100644 index 00000000..d5cc3e00 --- /dev/null +++ b/docs/models/components/productrecurringcreatemetadata.md @@ -0,0 +1,23 @@ +# ProductRecurringCreateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 881891; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/productrecurringcreateprices.md b/docs/models/components/productrecurringcreateprices.md index 1aabfee2..ae0f6802 100644 --- a/docs/models/components/productrecurringcreateprices.md +++ b/docs/models/components/productrecurringcreateprices.md @@ -10,8 +10,8 @@ List of available prices for this product. ```typescript const value: components.ProductPriceRecurringFixedCreate[] = [ { - priceAmount: 280418, - recurringInterval: "month", + priceAmount: 306065, + recurringInterval: "year", }, ]; ``` diff --git a/docs/models/components/productsortproperty.md b/docs/models/components/productsortproperty.md index 1bb3b3c4..4723995f 100644 --- a/docs/models/components/productsortproperty.md +++ b/docs/models/components/productsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { ProductSortProperty } from "@polar-sh/sdk/models/components"; -let value: ProductSortProperty = "price_amount"; +let value: ProductSortProperty = "price_type"; ``` ## Values diff --git a/docs/models/components/productupdate.md b/docs/models/components/productupdate.md index a5aeaf7a..ea88bf2e 100644 --- a/docs/models/components/productupdate.md +++ b/docs/models/components/productupdate.md @@ -12,11 +12,12 @@ let value: ProductUpdate = {}; ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | The description of the product. | -| `isArchived` | *boolean* | :heavy_minus_sign: | Whether the product is archived. If `true`, the product won't be available for purchase anymore. Existing customers will still have access to their benefits, and subscriptions will continue normally. | -| `prices` | *components.ProductUpdatePrices*[] | :heavy_minus_sign: | List of available prices for this product. If you want to keep existing prices, include them in the list as an `ExistingProductPrice` object. | -| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | -| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata` | Record | :heavy_minus_sign: | Key-value object allowing you to store additional information.

The key must be a string with a maximum length of **40 characters**.
The value must be either:
* A string with a maximum length of **500 characters**
* An integer
* A boolean

You can store up to **50 key-value pairs**. | +| `name` | *string* | :heavy_minus_sign: | N/A | +| `description` | *string* | :heavy_minus_sign: | The description of the product. | +| `isArchived` | *boolean* | :heavy_minus_sign: | Whether the product is archived. If `true`, the product won't be available for purchase anymore. Existing customers will still have access to their benefits, and subscriptions will continue normally. | +| `prices` | *components.ProductUpdatePrices*[] | :heavy_minus_sign: | List of available prices for this product. If you want to keep existing prices, include them in the list as an `ExistingProductPrice` object. | +| `medias` | *string*[] | :heavy_minus_sign: | List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. | +| `attachedCustomFields` | [components.AttachedCustomFieldCreate](../../models/components/attachedcustomfieldcreate.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/productupdatemetadata.md b/docs/models/components/productupdatemetadata.md new file mode 100644 index 00000000..bb2df482 --- /dev/null +++ b/docs/models/components/productupdatemetadata.md @@ -0,0 +1,23 @@ +# ProductUpdateMetadata + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `number` + +```typescript +const value: number = 455389; +``` + +### `boolean` + +```typescript +const value: boolean = false; +``` + diff --git a/docs/models/components/productupdateprices.md b/docs/models/components/productupdateprices.md index 99c489cb..f385b698 100644 --- a/docs/models/components/productupdateprices.md +++ b/docs/models/components/productupdateprices.md @@ -15,7 +15,7 @@ const value: components.ExistingProductPrice = { ```typescript const value: components.ProductPriceRecurringFixedCreate = { - priceAmount: 365518, + priceAmount: 120388, recurringInterval: "month", }; ``` @@ -24,7 +24,7 @@ const value: components.ProductPriceRecurringFixedCreate = { ```typescript const value: components.ProductPriceRecurringFreeCreate = { - recurringInterval: "year", + recurringInterval: "month", }; ``` @@ -32,7 +32,7 @@ const value: components.ProductPriceRecurringFreeCreate = { ```typescript const value: components.ProductPriceOneTimeFixedCreate = { - priceAmount: 705317, + priceAmount: 912986, }; ``` diff --git a/docs/models/components/reactions.md b/docs/models/components/reactions.md index c4b8216c..c3583088 100644 --- a/docs/models/components/reactions.md +++ b/docs/models/components/reactions.md @@ -6,15 +6,15 @@ import { Reactions } from "@polar-sh/sdk/models/components"; let value: Reactions = { - totalCount: 539732, - plusOne: 860632, - minusOne: 268379, - laugh: 24896, - hooray: 276086, - confused: 940723, - heart: 20512, - rocket: 121552, - eyes: 173724, + totalCount: 172520, + plusOne: 802851, + minusOne: 710093, + laugh: 905799, + hooray: 434707, + confused: 867099, + heart: 698090, + rocket: 273092, + eyes: 389776, }; ``` diff --git a/docs/models/components/repository.md b/docs/models/components/repository.md index bdf08c76..505d6068 100644 --- a/docs/models/components/repository.md +++ b/docs/models/components/repository.md @@ -45,7 +45,6 @@ let value: Repository = { pledgeMinimumAmount: 318878, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 592218, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/s3filecreatemultipart.md b/docs/models/components/s3filecreatemultipart.md index 636ae23a..a1c93965 100644 --- a/docs/models/components/s3filecreatemultipart.md +++ b/docs/models/components/s3filecreatemultipart.md @@ -8,9 +8,9 @@ import { S3FileCreateMultipart } from "@polar-sh/sdk/models/components"; let value: S3FileCreateMultipart = { parts: [ { - number: 839715, - chunkStart: 164585, - chunkEnd: 569596, + number: 57659, + chunkStart: 528552, + chunkEnd: 396772, }, ], }; diff --git a/docs/models/components/s3filecreatepart.md b/docs/models/components/s3filecreatepart.md index ea92b4e6..310ac0f8 100644 --- a/docs/models/components/s3filecreatepart.md +++ b/docs/models/components/s3filecreatepart.md @@ -6,9 +6,9 @@ import { S3FileCreatePart } from "@polar-sh/sdk/models/components"; let value: S3FileCreatePart = { - number: 940497, - chunkStart: 966607, - chunkEnd: 844253, + number: 735432, + chunkStart: 628062, + chunkEnd: 306, }; ``` diff --git a/docs/models/components/s3fileuploadcompletedpart.md b/docs/models/components/s3fileuploadcompletedpart.md index 4c956fdf..59cd0f1b 100644 --- a/docs/models/components/s3fileuploadcompletedpart.md +++ b/docs/models/components/s3fileuploadcompletedpart.md @@ -6,7 +6,7 @@ import { S3FileUploadCompletedPart } from "@polar-sh/sdk/models/components"; let value: S3FileUploadCompletedPart = { - number: 314769, + number: 857243, checksumEtag: "", checksumSha256Base64: "", }; diff --git a/docs/models/components/s3fileuploadmultipart.md b/docs/models/components/s3fileuploadmultipart.md index 2a64ed87..e083968c 100644 --- a/docs/models/components/s3fileuploadmultipart.md +++ b/docs/models/components/s3fileuploadmultipart.md @@ -7,14 +7,14 @@ import { S3FileUploadMultipart } from "@polar-sh/sdk/models/components"; let value: S3FileUploadMultipart = { id: "", - path: "/tmp", + path: "/bin", parts: [ { - number: 649722, - chunkStart: 644678, - chunkEnd: 864630, - url: "https://amazing-lid.info/", - expiresAt: new Date("2024-12-21T15:53:12.734Z"), + number: 11964, + chunkStart: 425984, + chunkEnd: 130565, + url: "https://helpless-brochure.name/", + expiresAt: new Date("2023-12-14T02:17:32.598Z"), }, ], }; diff --git a/docs/models/components/s3fileuploadpart.md b/docs/models/components/s3fileuploadpart.md index ff72f5ef..5f0b8ae5 100644 --- a/docs/models/components/s3fileuploadpart.md +++ b/docs/models/components/s3fileuploadpart.md @@ -6,11 +6,11 @@ import { S3FileUploadPart } from "@polar-sh/sdk/models/components"; let value: S3FileUploadPart = { - number: 357536, - chunkStart: 389104, - chunkEnd: 835707, - url: "https://blaring-backbone.name", - expiresAt: new Date("2023-03-11T20:41:59.793Z"), + number: 644678, + chunkStart: 864630, + chunkEnd: 6773, + url: "https://moist-insolence.org/", + expiresAt: new Date("2023-01-27T20:37:43.594Z"), }; ``` diff --git a/docs/models/components/scope.md b/docs/models/components/scope.md new file mode 100644 index 00000000..e246d62d --- /dev/null +++ b/docs/models/components/scope.md @@ -0,0 +1,15 @@ +# Scope + +## Example Usage + +```typescript +import { Scope } from "@polar-sh/sdk/models/components"; + +let value: Scope = "metrics:read"; +``` + +## Values + +```typescript +"openid" | "profile" | "email" | "user:read" | "admin" | "web_default" | "organizations:read" | "organizations:write" | "custom_fields:read" | "custom_fields:write" | "checkout_links:read" | "checkout_links:write" | "checkouts:read" | "checkouts:write" | "products:read" | "products:write" | "benefits:read" | "benefits:write" | "files:read" | "files:write" | "subscriptions:read" | "subscriptions:write" | "orders:read" | "metrics:read" | "articles:read" | "articles:write" | "webhooks:read" | "webhooks:write" | "external_organizations:read" | "license_keys:read" | "license_keys:write" | "repositories:read" | "repositories:write" | "issues:read" | "issues:write" | "user:benefits:read" | "user:orders:read" | "user:subscriptions:read" | "user:subscriptions:write" | "user:downloadables:read" | "user:license_keys:read" | "user:advertisement_campaigns:read" | "user:advertisement_campaigns:write" +``` \ No newline at end of file diff --git a/docs/models/components/state.md b/docs/models/components/state.md index 02db5f48..68f73169 100644 --- a/docs/models/components/state.md +++ b/docs/models/components/state.md @@ -5,7 +5,7 @@ ```typescript import { State } from "@polar-sh/sdk/models/components"; -let value: State = "open"; +let value: State = "closed"; ``` ## Values diff --git a/docs/models/components/subscription.md b/docs/models/components/subscription.md index 83304448..5f737f26 100644 --- a/docs/models/components/subscription.md +++ b/docs/models/components/subscription.md @@ -26,44 +26,49 @@ let value: Subscription = { "key": "", }, user: { - email: "Logan.Gleichner@gmail.com", + email: "Darion_Deckow44@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://violent-design.net/", + avatarUrl: "https://evil-sauerkraut.com", }, product: { - createdAt: new Date("2022-01-28T01:28:09.985Z"), - modifiedAt: new Date("2022-07-21T02:15:38.786Z"), + createdAt: new Date("2022-07-21T02:15:38.786Z"), + modifiedAt: new Date("2024-06-16T11:27:10.944Z"), id: "", name: "", - description: - "up heating avaricious vainly considering gadzooks viability individual specific", + description: "jaywalk kissingly worriedly hunt retool space informal", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": "", + }, prices: [ { - createdAt: new Date("2024-12-05T19:52:32.444Z"), - modifiedAt: new Date("2024-08-07T07:44:13.681Z"), + createdAt: new Date("2024-12-01T04:15:48.042Z"), + modifiedAt: new Date("2022-11-10T06:10:54.367Z"), id: "", isArchived: false, productId: "", - recurringInterval: "year", + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2024-07-22T20:45:22.257Z"), - modifiedAt: new Date("2024-08-31T14:34:42.904Z"), + createdAt: new Date("2024-11-11T12:00:22.100Z"), + modifiedAt: new Date("2022-09-28T20:54:23.206Z"), id: "", - description: "out experienced sunbathe whose synthesise", + description: + "towards saturate though when plus save dapper untimely spark once", selectable: false, deletable: false, organizationId: "", properties: { - note: "", + repositoryId: "", + repositoryOwner: "polarsource", + repositoryName: "private_repo", + permission: "triage", }, - isTaxApplicable: false, }, ], medias: [ @@ -71,27 +76,27 @@ let value: Subscription = { id: "", organizationId: "", name: "", - path: "/srv", + path: "/opt/sbin", mimeType: "", - size: 163928, + size: 787299, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-11-08T08:55:48.564Z"), + lastModifiedAt: new Date("2022-10-25T07:23:29.621Z"), version: "", isUploaded: false, - createdAt: new Date("2023-08-07T14:30:02.776Z"), + createdAt: new Date("2024-06-10T07:44:52.955Z"), sizeReadable: "", - publicUrl: "https://inborn-pupil.org/", + publicUrl: "https://corny-translation.info/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-06-03T18:10:10.891Z"), - modifiedAt: new Date("2024-08-13T11:33:11.689Z"), + createdAt: new Date("2023-11-01T01:05:57.542Z"), + modifiedAt: new Date("2023-05-15T18:48:33.124Z"), id: "", metadata: { "key": "", @@ -101,22 +106,22 @@ let value: Subscription = { organizationId: "", properties: {}, }, - order: 590167, + order: 347962, required: false, }, ], }, price: { - createdAt: new Date("2023-05-24T22:42:36.749Z"), - modifiedAt: new Date("2024-05-20T21:27:59.894Z"), + createdAt: new Date("2023-11-19T23:14:44.002Z"), + modifiedAt: new Date("2024-08-30T01:05:50.247Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 844775, - maximumAmount: 657897, - presetAmount: 58461, - recurringInterval: "year", + minimumAmount: 492506, + maximumAmount: 104737, + presetAmount: 113553, + recurringInterval: "month", }, }; ``` @@ -141,7 +146,7 @@ let value: Subscription = { | `productId` | *string* | :heavy_check_mark: | N/A | | `priceId` | *string* | :heavy_check_mark: | N/A | | `checkoutId` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record | :heavy_check_mark: | N/A | +| `metadata` | Record | :heavy_check_mark: | N/A | | `customFieldData` | [components.SubscriptionCustomFieldData](../../models/components/subscriptioncustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | | `user` | [components.SubscriptionUser](../../models/components/subscriptionuser.md) | :heavy_check_mark: | N/A | | `product` | [components.Product](../../models/components/product.md) | :heavy_check_mark: | A product. | diff --git a/docs/models/components/subscriptioninput.md b/docs/models/components/subscriptioninput.md deleted file mode 100644 index f3bd33e6..00000000 --- a/docs/models/components/subscriptioninput.md +++ /dev/null @@ -1,150 +0,0 @@ -# SubscriptionInput - -## Example Usage - -```typescript -import { SubscriptionInput } from "@polar-sh/sdk/models/components"; - -let value: SubscriptionInput = { - createdAt: new Date("2023-12-14T18:14:41.004Z"), - modifiedAt: new Date("2024-08-13T17:10:17.807Z"), - id: "", - amount: 815315, - currency: "Surinam Dollar", - recurringInterval: "year", - status: "incomplete", - currentPeriodStart: new Date("2024-01-24T18:32:15.375Z"), - currentPeriodEnd: new Date("2022-11-28T08:15:52.623Z"), - cancelAtPeriodEnd: false, - startedAt: new Date("2024-05-08T14:24:55.853Z"), - endedAt: new Date("2023-02-06T21:19:44.981Z"), - userId: "", - productId: "", - priceId: "", - checkoutId: "", - metadata: { - "key": "", - }, - user: { - email: "Leland26@gmail.com", - publicName: "", - githubUsername: "", - avatarUrl: "https://joyous-giant.net/", - }, - product: { - createdAt: new Date("2023-04-27T14:18:23.756Z"), - modifiedAt: new Date("2022-09-30T19:12:28.413Z"), - id: "", - name: "", - description: "tenement amidst decent", - isRecurring: false, - isArchived: false, - organizationId: "", - prices: [ - { - createdAt: new Date("2022-07-20T04:32:07.356Z"), - modifiedAt: new Date("2024-12-27T12:13:46.111Z"), - id: "", - isArchived: false, - productId: "", - priceCurrency: "", - priceAmount: 778597, - }, - ], - benefits: [ - { - createdAt: new Date("2023-06-01T17:57:52.601Z"), - modifiedAt: new Date("2023-02-20T00:47:22.305Z"), - id: "", - description: "thorn underneath drat typify brood", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, - }, - ], - medias: [ - { - id: "", - organizationId: "", - name: "", - path: "/etc/defaults", - mimeType: "", - size: 364915, - storageVersion: "", - checksumEtag: "", - checksumSha256Base64: "", - checksumSha256Hex: "", - lastModifiedAt: new Date("2024-02-02T20:11:50.129Z"), - version: "", - isUploaded: false, - createdAt: new Date("2024-06-25T06:53:42.834Z"), - }, - ], - attachedCustomFields: [ - { - customFieldId: "", - customField: { - createdAt: new Date("2023-11-17T06:19:22.427Z"), - modifiedAt: new Date("2022-06-24T21:14:12.329Z"), - id: "", - metadata: { - "key": "", - }, - slug: "", - name: "", - organizationId: "", - properties: {}, - }, - order: 112104, - required: false, - }, - ], - }, - price: { - createdAt: new Date("2024-08-01T16:53:54.476Z"), - modifiedAt: new Date("2023-11-19T23:10:11.193Z"), - id: "", - isArchived: false, - productId: "", - priceCurrency: "", - minimumAmount: 681544, - maximumAmount: 393166, - presetAmount: 266880, - recurringInterval: "year", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Creation timestamp of the object. | -| `modifiedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *string* | :heavy_check_mark: | The ID of the object. | -| `amount` | *number* | :heavy_check_mark: | N/A | -| `currency` | *string* | :heavy_check_mark: | N/A | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | -| `status` | [components.SubscriptionStatus](../../models/components/subscriptionstatus.md) | :heavy_check_mark: | N/A | -| `currentPeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `currentPeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `cancelAtPeriodEnd` | *boolean* | :heavy_check_mark: | N/A | -| `startedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `endedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `userId` | *string* | :heavy_check_mark: | N/A | -| `productId` | *string* | :heavy_check_mark: | N/A | -| `priceId` | *string* | :heavy_check_mark: | N/A | -| `checkoutId` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record | :heavy_check_mark: | N/A | -| `customFieldData` | [components.SubscriptionCustomFieldData](../../models/components/subscriptioncustomfielddata.md) | :heavy_minus_sign: | Key-value object storing custom field values. | -| `user` | [components.SubscriptionUser](../../models/components/subscriptionuser.md) | :heavy_check_mark: | N/A | -| `product` | [components.ProductInput](../../models/components/productinput.md) | :heavy_check_mark: | A product. | -| `price` | *components.ProductPriceRecurring* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/subscriptionrecurringinterval.md b/docs/models/components/subscriptionrecurringinterval.md index 5afac4d6..36650f2b 100644 --- a/docs/models/components/subscriptionrecurringinterval.md +++ b/docs/models/components/subscriptionrecurringinterval.md @@ -5,7 +5,7 @@ ```typescript import { SubscriptionRecurringInterval } from "@polar-sh/sdk/models/components"; -let value: SubscriptionRecurringInterval = "year"; +let value: SubscriptionRecurringInterval = "month"; ``` ## Values diff --git a/docs/models/components/subscriptionsortproperty.md b/docs/models/components/subscriptionsortproperty.md index 5f49bef6..dac84703 100644 --- a/docs/models/components/subscriptionsortproperty.md +++ b/docs/models/components/subscriptionsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { SubscriptionSortProperty } from "@polar-sh/sdk/models/components"; -let value: SubscriptionSortProperty = "-amount"; +let value: SubscriptionSortProperty = "started_at"; ``` ## Values diff --git a/docs/models/components/subscriptionuser.md b/docs/models/components/subscriptionuser.md index 2c3dec9b..83d22afa 100644 --- a/docs/models/components/subscriptionuser.md +++ b/docs/models/components/subscriptionuser.md @@ -6,10 +6,10 @@ import { SubscriptionUser } from "@polar-sh/sdk/models/components"; let value: SubscriptionUser = { - email: "Kaleb_Jast19@hotmail.com", + email: "Viva.Pagac72@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://miserable-provision.net/", + avatarUrl: "https://downright-daughter.name", }; ``` diff --git a/docs/models/components/subtype.md b/docs/models/components/subtype.md index bfd1f7a6..632a1f4d 100644 --- a/docs/models/components/subtype.md +++ b/docs/models/components/subtype.md @@ -5,7 +5,7 @@ ```typescript import { SubType } from "@polar-sh/sdk/models/components"; -let value: SubType = "organization"; +let value: SubType = "user"; ``` ## Values diff --git a/docs/models/components/timeframe.md b/docs/models/components/timeframe.md index dde5a552..1563e49b 100644 --- a/docs/models/components/timeframe.md +++ b/docs/models/components/timeframe.md @@ -5,7 +5,7 @@ ```typescript import { Timeframe } from "@polar-sh/sdk/models/components"; -let value: Timeframe = "month"; +let value: Timeframe = "day"; ``` ## Values diff --git a/docs/models/components/tokenendpointauthmethod.md b/docs/models/components/tokenendpointauthmethod.md index 396ac84c..ba92c131 100644 --- a/docs/models/components/tokenendpointauthmethod.md +++ b/docs/models/components/tokenendpointauthmethod.md @@ -5,7 +5,7 @@ ```typescript import { TokenEndpointAuthMethod } from "@polar-sh/sdk/models/components"; -let value: TokenEndpointAuthMethod = "client_secret_basic"; +let value: TokenEndpointAuthMethod = "none"; ``` ## Values diff --git a/docs/models/components/tokenresponse.md b/docs/models/components/tokenresponse.md index b6935103..7454c216 100644 --- a/docs/models/components/tokenresponse.md +++ b/docs/models/components/tokenresponse.md @@ -7,7 +7,7 @@ import { TokenResponse } from "@polar-sh/sdk/models/components"; let value: TokenResponse = { accessToken: "", - expiresIn: 200850, + expiresIn: 747110, refreshToken: "", scope: "", idToken: "", diff --git a/docs/models/components/userbenefit.md b/docs/models/components/userbenefit.md index a2d23520..4268d945 100644 --- a/docs/models/components/userbenefit.md +++ b/docs/models/components/userbenefit.md @@ -7,18 +7,17 @@ ```typescript const value: components.BenefitAdsSubscriber = { - createdAt: new Date("2023-08-18T05:41:08.306Z"), - modifiedAt: new Date("2023-01-26T04:24:53.847Z"), + createdAt: new Date("2022-03-21T10:21:14.772Z"), + modifiedAt: new Date("2022-01-07T00:32:08.475Z"), id: "", - description: - "terrorise categorise putrid solidly wasteful axe accredit zowie hence accept", + description: "silver unless save unlawful vague", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-10-30T18:25:07.122Z"), - modifiedAt: new Date("2023-02-02T12:16:29.844Z"), + createdAt: new Date("2023-06-12T12:17:54.368Z"), + modifiedAt: new Date("2024-01-24T08:06:05.859Z"), id: "", isGranted: false, isRevoked: false, @@ -30,22 +29,21 @@ const value: components.BenefitAdsSubscriber = { }, ], organization: { - createdAt: new Date("2024-05-01T07:37:23.861Z"), - modifiedAt: new Date("2024-11-25T20:06:47.886Z"), + createdAt: new Date("2024-05-27T23:02:54.006Z"), + modifiedAt: new Date("2023-07-23T03:06:36.212Z"), id: "", name: "", slug: "", - avatarUrl: "https://ripe-yarmulke.net/", + avatarUrl: "https://probable-monster.org/", bio: "", - company: "Blick Inc", + company: "Vandervort - Lesch", blog: "", location: "", - email: "Colin.Predovic@hotmail.com", + email: "Evie_Kuhn42@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 714054, + pledgeMinimumAmount: 821672, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 516556, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 547907, profileSettings: {}, featureSettings: {}, }, @@ -57,17 +55,17 @@ const value: components.BenefitAdsSubscriber = { ```typescript const value: components.BenefitArticlesSubscriber = { - createdAt: new Date("2022-05-26T20:25:51.045Z"), - modifiedAt: new Date("2024-04-27T16:57:06.047Z"), + createdAt: new Date("2024-01-18T19:55:06.009Z"), + modifiedAt: new Date("2024-06-02T01:11:39.479Z"), id: "", - description: "deficient long unselfish meh strange vaguely", + description: "in seemingly spattering knickers bracelet gosh geez knotty", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-07-06T20:47:44.778Z"), - modifiedAt: new Date("2023-11-12T10:36:59.251Z"), + createdAt: new Date("2022-09-06T22:23:47.039Z"), + modifiedAt: new Date("2022-11-16T15:59:09.505Z"), id: "", isGranted: false, isRevoked: false, @@ -78,22 +76,21 @@ const value: components.BenefitArticlesSubscriber = { }, ], organization: { - createdAt: new Date("2024-07-01T22:55:43.947Z"), - modifiedAt: new Date("2023-09-11T19:09:44.539Z"), + createdAt: new Date("2024-04-30T20:40:52.185Z"), + modifiedAt: new Date("2022-10-27T14:11:26.569Z"), id: "", name: "", slug: "", - avatarUrl: "https://worldly-developmental.net/", + avatarUrl: "https://livid-minister.org/", bio: "", - company: "Kris Group", + company: "Hermann - Gislason", blog: "", location: "", - email: "Bertram.Sporer-Lesch@hotmail.com", + email: "Barney37@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 879418, + pledgeMinimumAmount: 728379, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 275006, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 516739, profileSettings: {}, featureSettings: {}, }, @@ -107,17 +104,17 @@ const value: components.BenefitArticlesSubscriber = { ```typescript const value: components.BenefitCustomSubscriber = { - createdAt: new Date("2023-07-03T14:08:14.339Z"), - modifiedAt: new Date("2022-09-15T01:36:02.246Z"), + createdAt: new Date("2024-05-01T19:16:39.101Z"), + modifiedAt: new Date("2022-05-16T00:07:02.940Z"), id: "", - description: "swathe amongst dislocate however entire", + description: "divine easily angelic and hence zowie", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-01-23T08:27:25.525Z"), - modifiedAt: new Date("2022-10-16T03:05:22.272Z"), + createdAt: new Date("2022-07-18T10:07:12.459Z"), + modifiedAt: new Date("2024-04-17T01:35:51.341Z"), id: "", isGranted: false, isRevoked: false, @@ -128,22 +125,21 @@ const value: components.BenefitCustomSubscriber = { }, ], organization: { - createdAt: new Date("2023-01-31T18:43:40.215Z"), - modifiedAt: new Date("2022-04-21T11:33:43.244Z"), + createdAt: new Date("2022-03-09T05:37:58.726Z"), + modifiedAt: new Date("2023-05-23T04:28:16.968Z"), id: "", name: "", slug: "", - avatarUrl: "https://unhappy-equal.info/", + avatarUrl: "https://stunning-unit.com/", bio: "", - company: "Rempel, Larson and Sanford", + company: "Ryan, Herzog and Upton", blog: "", location: "", - email: "Jamar.Feest@gmail.com", + email: "Haleigh48@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 947309, + pledgeMinimumAmount: 821238, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 264125, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 149941, profileSettings: {}, featureSettings: {}, }, @@ -157,18 +153,17 @@ const value: components.BenefitCustomSubscriber = { ```typescript const value: components.BenefitDiscordSubscriber = { - createdAt: new Date("2023-06-02T18:46:06.050Z"), - modifiedAt: new Date("2024-06-08T06:31:25.831Z"), + createdAt: new Date("2024-04-06T11:35:34.778Z"), + modifiedAt: new Date("2024-02-28T02:36:07.300Z"), id: "", - description: - "ridge veg save hourly as whenever antagonize obstruct overburden", + description: "overburden mountain wrongly plan psst promptly ha", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-04-13T12:32:02.752Z"), - modifiedAt: new Date("2024-08-18T09:11:38.486Z"), + createdAt: new Date("2024-03-04T20:48:07.480Z"), + modifiedAt: new Date("2022-07-29T23:05:02.179Z"), id: "", isGranted: false, isRevoked: false, @@ -179,22 +174,21 @@ const value: components.BenefitDiscordSubscriber = { }, ], organization: { - createdAt: new Date("2022-10-06T07:01:26.430Z"), - modifiedAt: new Date("2022-03-28T08:49:02.228Z"), + createdAt: new Date("2023-12-27T17:49:51.811Z"), + modifiedAt: new Date("2024-07-22T01:12:42.157Z"), id: "", name: "", slug: "", - avatarUrl: "https://indelible-mountain.com", + avatarUrl: "https://smart-overcoat.org/", bio: "", - company: "Thiel, Muller and Auer", + company: "Cremin - Hahn", blog: "", location: "", - email: "Wilfred.Crooks@yahoo.com", + email: "Nikki86@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 24614, + pledgeMinimumAmount: 531606, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 619772, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 649373, profileSettings: {}, featureSettings: {}, }, @@ -208,17 +202,17 @@ const value: components.BenefitDiscordSubscriber = { ```typescript const value: components.BenefitDownloadablesSubscriber = { - createdAt: new Date("2022-10-25T06:04:46.666Z"), - modifiedAt: new Date("2022-04-19T08:02:38.105Z"), + createdAt: new Date("2023-07-03T18:12:17.901Z"), + modifiedAt: new Date("2022-11-07T18:42:07.697Z"), id: "", - description: "only self-confidence reluctantly conceal toward happily", + description: "twine modulo plugin meaty frizz", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-07-29T04:07:06.634Z"), - modifiedAt: new Date("2024-09-15T12:11:57.238Z"), + createdAt: new Date("2024-04-09T19:32:30.032Z"), + modifiedAt: new Date("2024-12-17T00:23:58.824Z"), id: "", isGranted: false, isRevoked: false, @@ -229,22 +223,21 @@ const value: components.BenefitDownloadablesSubscriber = { }, ], organization: { - createdAt: new Date("2024-07-29T19:18:16.265Z"), - modifiedAt: new Date("2023-05-21T22:57:42.336Z"), + createdAt: new Date("2023-07-31T20:21:49.251Z"), + modifiedAt: new Date("2023-05-31T22:08:18.974Z"), id: "", name: "", slug: "", - avatarUrl: "https://warped-decision.name/", + avatarUrl: "https://rural-strait.biz/", bio: "", - company: "Dicki - Mitchell", + company: "Kutch - Bins", blog: "", location: "", - email: "Krista46@yahoo.com", + email: "Helene97@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 120387, + pledgeMinimumAmount: 139730, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 683271, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 882586, profileSettings: {}, featureSettings: {}, }, @@ -260,18 +253,17 @@ const value: components.BenefitDownloadablesSubscriber = { ```typescript const value: components.BenefitGitHubRepositorySubscriber = { - createdAt: new Date("2023-07-23T02:21:25.780Z"), - modifiedAt: new Date("2022-07-15T03:50:42.259Z"), + createdAt: new Date("2022-03-29T21:45:21.765Z"), + modifiedAt: new Date("2023-07-11T08:50:36.224Z"), id: "", - description: - "by monumental mostly wallaby indeed stingy boyfriend providence until gracious", + description: "mushy or ack roughly", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2024-07-15T09:08:24.889Z"), - modifiedAt: new Date("2023-05-15T03:47:55.638Z"), + createdAt: new Date("2024-02-24T18:17:35.574Z"), + modifiedAt: new Date("2024-08-02T22:25:17.358Z"), id: "", isGranted: false, isRevoked: false, @@ -282,22 +274,21 @@ const value: components.BenefitGitHubRepositorySubscriber = { }, ], organization: { - createdAt: new Date("2022-04-12T13:59:28.660Z"), - modifiedAt: new Date("2023-05-14T13:48:07.162Z"), + createdAt: new Date("2023-07-11T19:35:53.842Z"), + modifiedAt: new Date("2023-05-21T08:36:59.702Z"), id: "", name: "", slug: "", - avatarUrl: "https://key-advancement.name", + avatarUrl: "https://standard-mathematics.biz", bio: "", - company: "Schumm, Morissette and Volkman", + company: "Klocko, Bosco and Klocko", blog: "", location: "", - email: "Jessika5@hotmail.com", + email: "Isidro_Moore@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 447503, + pledgeMinimumAmount: 914399, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 660799, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 813582, profileSettings: {}, featureSettings: {}, }, @@ -312,17 +303,17 @@ const value: components.BenefitGitHubRepositorySubscriber = { ```typescript const value: components.BenefitLicenseKeysSubscriber = { - createdAt: new Date("2024-04-18T00:54:24.193Z"), - modifiedAt: new Date("2023-08-15T07:03:31.089Z"), + createdAt: new Date("2023-07-01T12:12:34.324Z"), + modifiedAt: new Date("2023-10-10T23:27:30.195Z"), id: "", - description: "playfully out viciously dally", + description: "mount gradient oof even except splendid physically where", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2023-12-21T15:20:25.954Z"), - modifiedAt: new Date("2023-02-14T17:30:08.402Z"), + createdAt: new Date("2022-08-11T21:05:33.502Z"), + modifiedAt: new Date("2023-09-17T18:30:47.093Z"), id: "", isGranted: false, isRevoked: false, @@ -334,36 +325,35 @@ const value: components.BenefitLicenseKeysSubscriber = { }, ], organization: { - createdAt: new Date("2024-05-10T10:23:09.731Z"), - modifiedAt: new Date("2023-04-01T06:32:56.264Z"), + createdAt: new Date("2024-03-28T08:34:09.342Z"), + modifiedAt: new Date("2023-01-22T22:16:09.171Z"), id: "", name: "", slug: "", - avatarUrl: "https://splendid-hyena.org", + avatarUrl: "https://optimistic-inspection.net/", bio: "", - company: "Shanahan, Wilkinson and Howell", + company: "Kerluke - Hauck", blog: "", location: "", - email: "Matteo29@yahoo.com", + email: "Oral_Crona@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 799306, + pledgeMinimumAmount: 982804, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 203356, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 499461, profileSettings: {}, featureSettings: {}, }, properties: { prefix: "", expires: { - ttl: 570047, + ttl: 136292, timeframe: "day", }, activations: { - limit: 353036, + limit: 602076, enableUserAdmin: false, }, - limitUsage: 434382, + limitUsage: 590422, }, }; ``` diff --git a/docs/models/components/userbenefitsortproperty.md b/docs/models/components/userbenefitsortproperty.md index fc5f8baa..667e578b 100644 --- a/docs/models/components/userbenefitsortproperty.md +++ b/docs/models/components/userbenefitsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { UserBenefitSortProperty } from "@polar-sh/sdk/models/components"; -let value: UserBenefitSortProperty = "-granted_at"; +let value: UserBenefitSortProperty = "granted_at"; ``` ## Values diff --git a/docs/models/components/userorder.md b/docs/models/components/userorder.md index 40cd8b58..35f23081 100644 --- a/docs/models/components/userorder.md +++ b/docs/models/components/userorder.md @@ -6,51 +6,45 @@ import { UserOrder } from "@polar-sh/sdk/models/components"; let value: UserOrder = { - createdAt: new Date("2024-03-12T16:04:02.474Z"), - modifiedAt: new Date("2022-10-22T16:34:22.700Z"), + createdAt: new Date("2022-09-05T19:16:17.163Z"), + modifiedAt: new Date("2023-09-09T09:25:03.473Z"), id: "", - amount: 305965, - taxAmount: 305473, - currency: "Tanzanian Shilling", + amount: 999932, + taxAmount: 728466, + currency: "Guyana Dollar", userId: "", productId: "", productPriceId: "", subscriptionId: "", product: { - createdAt: new Date("2022-09-05T19:16:17.163Z"), - modifiedAt: new Date("2023-09-09T09:25:03.473Z"), + createdAt: new Date("2024-04-18T22:37:57.921Z"), + modifiedAt: new Date("2024-11-11T11:47:55.562Z"), id: "", name: "", - description: - "blue ugh nautical barring whereas ouch reporter ah offensively obvious", + description: "ew stunning perspire pfft behind", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-08-02T23:14:47.272Z"), - modifiedAt: new Date("2022-07-20T12:59:24.049Z"), + createdAt: new Date("2023-04-25T01:39:48.783Z"), + modifiedAt: new Date("2023-04-04T23:48:44.294Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 315904, - maximumAmount: 773678, - presetAmount: 335672, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2022-11-12T10:13:41.931Z"), - modifiedAt: new Date("2022-07-25T01:35:33.444Z"), + createdAt: new Date("2024-07-31T23:30:59.516Z"), + modifiedAt: new Date("2024-05-30T15:22:56.357Z"), id: "", - description: "astride verbally smug up adult", + type: "downloadables", + description: "midwife unless separate", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -58,65 +52,64 @@ let value: UserOrder = { id: "", organizationId: "", name: "", - path: "/var/tmp", + path: "/opt/bin", mimeType: "", - size: 132531, + size: 862198, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-07-22T03:49:19.507Z"), + lastModifiedAt: new Date("2022-07-20T12:59:24.049Z"), version: "", isUploaded: false, - createdAt: new Date("2024-05-06T18:26:38.655Z"), + createdAt: new Date("2022-12-13T05:33:20.610Z"), sizeReadable: "", - publicUrl: "https://sore-finding.biz", + publicUrl: "https://great-pigsty.biz", }, ], organization: { - createdAt: new Date("2023-02-18T22:46:45.624Z"), - modifiedAt: new Date("2022-08-11T14:00:17.759Z"), + createdAt: new Date("2022-07-25T01:35:33.444Z"), + modifiedAt: new Date("2022-11-26T14:28:09.704Z"), id: "", name: "", slug: "", - avatarUrl: "https://supportive-partridge.biz", + avatarUrl: "https://lazy-decongestant.biz", bio: "", - company: "McClure - Koepp", + company: "Roob - Fahey", blog: "", location: "", - email: "Freeda.Nader97@gmail.com", + email: "Albina30@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 658208, + pledgeMinimumAmount: 262614, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 909558, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 503479, profileSettings: {}, featureSettings: {}, }, }, productPrice: { - createdAt: new Date("2024-04-15T09:46:18.365Z"), - modifiedAt: new Date("2023-06-18T01:34:34.609Z"), + createdAt: new Date("2024-10-13T09:06:30.714Z"), + modifiedAt: new Date("2024-05-14T17:43:19.421Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 992178, + priceAmount: 761914, recurringInterval: "year", }, subscription: { - createdAt: new Date("2024-10-09T02:12:59.827Z"), - modifiedAt: new Date("2022-01-14T09:11:07.833Z"), + createdAt: new Date("2024-06-23T01:09:41.277Z"), + modifiedAt: new Date("2023-05-18T10:30:26.732Z"), id: "", - amount: 154539, - currency: "Zloty", + amount: 465190, + currency: "Lebanese Pound", recurringInterval: "month", - status: "canceled", - currentPeriodStart: new Date("2023-04-16T01:44:07.536Z"), - currentPeriodEnd: new Date("2024-02-21T10:39:54.364Z"), + status: "unpaid", + currentPeriodStart: new Date("2022-10-11T14:10:39.907Z"), + currentPeriodEnd: new Date("2022-08-06T04:23:14.951Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-09-13T12:16:23.117Z"), - endedAt: new Date("2022-05-12T09:56:36.366Z"), + startedAt: new Date("2022-09-25T03:38:49.818Z"), + endedAt: new Date("2024-06-14T19:37:48.267Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/userorderproduct.md b/docs/models/components/userorderproduct.md index d897f5b7..6e02e5be 100644 --- a/docs/models/components/userorderproduct.md +++ b/docs/models/components/userorderproduct.md @@ -6,30 +6,34 @@ import { UserOrderProduct } from "@polar-sh/sdk/models/components"; let value: UserOrderProduct = { - createdAt: new Date("2022-04-15T20:23:47.603Z"), - modifiedAt: new Date("2023-03-20T09:04:49.131Z"), + createdAt: new Date("2023-08-31T01:40:43.170Z"), + modifiedAt: new Date("2024-04-30T16:47:28.347Z"), id: "", name: "", - description: "yowza after captain er jiggle beyond political", + description: + "carelessly memorise considering verbally furthermore yet minority persecute hoick", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-02-09T23:07:56.607Z"), - modifiedAt: new Date("2023-06-05T20:40:09.335Z"), + createdAt: new Date("2022-03-02T07:06:59.765Z"), + modifiedAt: new Date("2022-12-23T18:40:43.978Z"), id: "", isArchived: false, productId: "", + priceCurrency: "", + priceAmount: 390583, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2022-08-18T07:04:21.930Z"), - modifiedAt: new Date("2022-12-19T18:58:02.170Z"), + createdAt: new Date("2022-10-01T11:56:46.049Z"), + modifiedAt: new Date("2022-09-07T07:22:34.884Z"), id: "", - type: "custom", - description: "chasuble defiantly rightfully behind tuxedo", + type: "ads", + description: "defiantly rightfully behind tuxedo", selectable: false, deletable: false, organizationId: "", @@ -71,7 +75,6 @@ let value: UserOrderProduct = { pledgeMinimumAmount: 535055, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 200109, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/userordersubscription.md b/docs/models/components/userordersubscription.md index c1f48169..32f62321 100644 --- a/docs/models/components/userordersubscription.md +++ b/docs/models/components/userordersubscription.md @@ -6,18 +6,18 @@ import { UserOrderSubscription } from "@polar-sh/sdk/models/components"; let value: UserOrderSubscription = { - createdAt: new Date("2024-02-26T20:59:18.749Z"), - modifiedAt: new Date("2024-02-14T04:24:13.906Z"), + createdAt: new Date("2024-04-22T07:49:28.033Z"), + modifiedAt: new Date("2023-04-14T02:37:02.963Z"), id: "", - amount: 115718, - currency: "Pataca", + amount: 13781, + currency: "Lesotho Loti", recurringInterval: "month", - status: "active", - currentPeriodStart: new Date("2023-04-09T08:14:40.781Z"), - currentPeriodEnd: new Date("2022-04-25T19:59:09.345Z"), + status: "canceled", + currentPeriodStart: new Date("2024-05-06T18:26:38.655Z"), + currentPeriodEnd: new Date("2024-10-25T03:08:43.304Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-06-23T04:38:11.873Z"), - endedAt: new Date("2022-04-06T03:24:49.820Z"), + startedAt: new Date("2024-04-27T15:28:30.620Z"), + endedAt: new Date("2022-12-30T04:23:53.970Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/usersubscription.md b/docs/models/components/usersubscription.md index f9cfc60d..3134b880 100644 --- a/docs/models/components/usersubscription.md +++ b/docs/models/components/usersubscription.md @@ -89,7 +89,6 @@ let value: UserSubscription = { pledgeMinimumAmount: 713741, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 514441, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/usersubscriptionproduct.md b/docs/models/components/usersubscriptionproduct.md index faaa9ce6..215ce71f 100644 --- a/docs/models/components/usersubscriptionproduct.md +++ b/docs/models/components/usersubscriptionproduct.md @@ -75,7 +75,6 @@ let value: UserSubscriptionProduct = { pledgeMinimumAmount: 661787, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 283619, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/validationerror.md b/docs/models/components/validationerror.md index 8bf6d15d..92da9948 100644 --- a/docs/models/components/validationerror.md +++ b/docs/models/components/validationerror.md @@ -7,7 +7,7 @@ import { ValidationError } from "@polar-sh/sdk/models/components"; let value: ValidationError = { loc: [ - 579690, + 813544, ], msg: "", type: "", diff --git a/docs/models/components/webhookbenefitcreatedpayload.md b/docs/models/components/webhookbenefitcreatedpayload.md index 61f9138a..0766e00b 100644 --- a/docs/models/components/webhookbenefitcreatedpayload.md +++ b/docs/models/components/webhookbenefitcreatedpayload.md @@ -11,21 +11,17 @@ import { WebhookBenefitCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookBenefitCreatedPayload = { data: { - createdAt: new Date("2023-05-01T03:38:37.774Z"), - modifiedAt: new Date("2023-10-08T23:37:13.021Z"), + createdAt: new Date("2023-01-03T04:14:52.159Z"), + modifiedAt: new Date("2023-04-20T19:40:49.785Z"), id: "", - description: "apricot ack trivial card hmph how uselessly portray", + description: "runway schlep atomize wilted for nucleotidase", selectable: false, deletable: false, organizationId: "", properties: { - archived: { - "key": false, - }, - files: [ - "", - ], + note: "", }, + isTaxApplicable: false, }, }; ``` @@ -35,4 +31,4 @@ let value: WebhookBenefitCreatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookBenefitCreatedPayloadType](../../models/components/webhookbenefitcreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | *components.BenefitInput* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *components.Benefit* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhookbenefitgrantcreatedpayload.md b/docs/models/components/webhookbenefitgrantcreatedpayload.md index 6bfe294c..0082d914 100644 --- a/docs/models/components/webhookbenefitgrantcreatedpayload.md +++ b/docs/models/components/webhookbenefitgrantcreatedpayload.md @@ -11,8 +11,8 @@ import { WebhookBenefitGrantCreatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookBenefitGrantCreatedPayload = { data: { - createdAt: new Date("2023-03-27T12:43:43.871Z"), - modifiedAt: new Date("2024-07-16T06:38:50.927Z"), + createdAt: new Date("2024-02-04T12:58:34.917Z"), + modifiedAt: new Date("2024-12-24T14:46:09.468Z"), id: "", isGranted: false, isRevoked: false, @@ -22,24 +22,20 @@ let value: WebhookBenefitGrantCreatedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2022-01-19T15:42:01.485Z"), - modifiedAt: new Date("2022-01-30T17:42:43.078Z"), + createdAt: new Date("2023-12-19T01:08:14.559Z"), + modifiedAt: new Date("2023-04-07T08:58:17.552Z"), id: "", - description: "broadly cruelly monocle embalm pace", + description: "minus why worth", selectable: false, deletable: false, organizationId: "", properties: { - prefix: "", - expires: { - ttl: 252144, - timeframe: "month", + archived: { + "key": false, }, - activations: { - limit: 337514, - enableUserAdmin: false, - }, - limitUsage: 926674, + files: [ + "", + ], }, }, }, diff --git a/docs/models/components/webhookbenefitgrantrevokedpayload.md b/docs/models/components/webhookbenefitgrantrevokedpayload.md index 0bad9f11..de0f954a 100644 --- a/docs/models/components/webhookbenefitgrantrevokedpayload.md +++ b/docs/models/components/webhookbenefitgrantrevokedpayload.md @@ -11,8 +11,8 @@ import { WebhookBenefitGrantRevokedPayload } from "@polar-sh/sdk/models/componen let value: WebhookBenefitGrantRevokedPayload = { data: { - createdAt: new Date("2022-10-15T14:10:02.904Z"), - modifiedAt: new Date("2023-09-05T13:28:38.697Z"), + createdAt: new Date("2023-07-05T01:46:55.006Z"), + modifiedAt: new Date("2022-03-17T06:50:06.523Z"), id: "", isGranted: false, isRevoked: false, @@ -22,17 +22,19 @@ let value: WebhookBenefitGrantRevokedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2022-11-04T01:43:26.070Z"), - modifiedAt: new Date("2024-10-21T04:47:53.381Z"), + createdAt: new Date("2022-11-30T19:27:06.717Z"), + modifiedAt: new Date("2024-10-30T16:04:35.456Z"), id: "", - description: "remark gaseous reach across phooey proofread schlep", + description: + "anti ouch microchip gadzooks someplace pneumonia if wealthy", selectable: false, deletable: false, organizationId: "", properties: { - note: "", + guildId: "", + roleId: "", + guildToken: "", }, - isTaxApplicable: false, }, }, }; diff --git a/docs/models/components/webhookbenefitgrantupdatedpayload.md b/docs/models/components/webhookbenefitgrantupdatedpayload.md index 6da4ddee..4adcf0b5 100644 --- a/docs/models/components/webhookbenefitgrantupdatedpayload.md +++ b/docs/models/components/webhookbenefitgrantupdatedpayload.md @@ -11,8 +11,8 @@ import { WebhookBenefitGrantUpdatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookBenefitGrantUpdatedPayload = { data: { - createdAt: new Date("2022-08-13T04:05:41.912Z"), - modifiedAt: new Date("2022-08-15T19:08:33.127Z"), + createdAt: new Date("2024-03-16T09:04:21.592Z"), + modifiedAt: new Date("2024-07-14T10:46:58.301Z"), id: "", isGranted: false, isRevoked: false, @@ -22,15 +22,17 @@ let value: WebhookBenefitGrantUpdatedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2022-05-01T12:37:32.096Z"), - modifiedAt: new Date("2023-07-09T00:24:34.770Z"), + createdAt: new Date("2024-02-17T00:18:19.556Z"), + modifiedAt: new Date("2024-03-11T06:09:41.890Z"), id: "", - description: "collaborate pfft nor", + description: "beside stage sermon", selectable: false, deletable: false, organizationId: "", properties: { - paidArticles: false, + guildId: "", + roleId: "", + guildToken: "", }, }, }, diff --git a/docs/models/components/webhookbenefitupdatedpayload.md b/docs/models/components/webhookbenefitupdatedpayload.md index 078f0f0a..b6995a0e 100644 --- a/docs/models/components/webhookbenefitupdatedpayload.md +++ b/docs/models/components/webhookbenefitupdatedpayload.md @@ -11,21 +11,17 @@ import { WebhookBenefitUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookBenefitUpdatedPayload = { data: { - createdAt: new Date("2024-09-26T16:56:57.899Z"), - modifiedAt: new Date("2023-10-02T21:44:40.357Z"), + createdAt: new Date("2022-12-04T11:10:25.256Z"), + modifiedAt: new Date("2022-04-02T15:04:46.624Z"), id: "", - description: - "babyish collaboration cap neck crowded westernize huge down cantaloupe yet", + description: "below accompany coaxingly", selectable: false, deletable: false, organizationId: "", properties: { - archived: { - "key": false, - }, - files: [ - "", - ], + guildId: "", + roleId: "", + guildToken: "", }, }, }; @@ -36,4 +32,4 @@ let value: WebhookBenefitUpdatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookBenefitUpdatedPayloadType](../../models/components/webhookbenefitupdatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | *components.BenefitInput* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *components.Benefit* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhookcheckoutcreatedpayload.md b/docs/models/components/webhookcheckoutcreatedpayload.md index b540f3fa..8764d3f3 100644 --- a/docs/models/components/webhookcheckoutcreatedpayload.md +++ b/docs/models/components/webhookcheckoutcreatedpayload.md @@ -11,63 +11,63 @@ import { WebhookCheckoutCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookCheckoutCreatedPayload = { data: { - createdAt: new Date("2024-10-30T06:10:40.764Z"), - modifiedAt: new Date("2023-08-02T02:04:13.457Z"), + createdAt: new Date("2022-09-25T11:24:04.477Z"), + modifiedAt: new Date("2023-05-12T07:16:04.376Z"), id: "", - status: "confirmed", + status: "failed", clientSecret: "", - url: "https://oily-distinction.biz/", - expiresAt: new Date("2023-04-21T12:43:04.324Z"), - successUrl: "https://pointless-executor.com", + url: "https://ultimate-mythology.info", + expiresAt: new Date("2022-12-27T03:00:57.232Z"), + successUrl: "https://livid-fort.org", embedOrigin: "", - amount: 244046, - taxAmount: 452831, - currency: "Venezuelan bolívar", - totalAmount: 610363, + amount: 811865, + taxAmount: 588740, + currency: "Ouguiya", + totalAmount: 497351, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Laurence_Harber@hotmail.com", + customerEmail: "Marshall12@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Tunisia", + country: "Ecuador", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { - "key": "", + "key": 569764, }, product: { - createdAt: new Date("2024-06-08T19:16:48.368Z"), - modifiedAt: new Date("2023-10-08T06:12:11.011Z"), + createdAt: new Date("2022-07-13T20:23:35.445Z"), + modifiedAt: new Date("2023-04-27T04:26:18.428Z"), id: "", name: "", - description: "but sizzle yippee honestly unsung drat silver", + description: + "yippee honestly unsung drat silver apt indeed indeed beyond", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-05-31T08:15:17.595Z"), - modifiedAt: new Date("2024-08-02T18:33:58.243Z"), + createdAt: new Date("2022-05-02T21:04:54.220Z"), + modifiedAt: new Date("2023-06-05T19:11:08.158Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 363615, - maximumAmount: 885282, - presetAmount: 40916, - recurringInterval: "month", + minimumAmount: 360131, + maximumAmount: 34104, + presetAmount: 349710, }, ], benefits: [ { - createdAt: new Date("2024-10-19T07:36:29.018Z"), - modifiedAt: new Date("2022-08-16T14:40:51.811Z"), + createdAt: new Date("2022-10-12T13:49:00.865Z"), + modifiedAt: new Date("2024-03-04T12:10:07.981Z"), id: "", - description: "iterate drat intently huzzah", + description: "gadzooks sleepily ostrich at", selectable: false, deletable: false, organizationId: "", @@ -81,45 +81,47 @@ let value: WebhookCheckoutCreatedPayload = { id: "", organizationId: "", name: "", - path: "/media", + path: "/sbin", mimeType: "", - size: 14614, + size: 781342, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-06-15T01:48:27.572Z"), + lastModifiedAt: new Date("2022-01-29T06:29:52.901Z"), version: "", isUploaded: false, - createdAt: new Date("2024-11-28T22:17:24.181Z"), + createdAt: new Date("2023-07-06T20:26:06.152Z"), + sizeReadable: "", + publicUrl: "https://bleak-skyline.info/", }, ], }, productPrice: { - createdAt: new Date("2024-07-14T07:58:13.561Z"), - modifiedAt: new Date("2024-10-26T15:27:03.943Z"), + createdAt: new Date("2023-05-02T01:12:09.041Z"), + modifiedAt: new Date("2023-02-12T19:18:02.060Z"), id: "", isArchived: false, productId: "", - recurringInterval: "month", + recurringInterval: "year", }, subscriptionId: "", attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-03-31T05:08:04.982Z"), - modifiedAt: new Date("2022-12-10T11:19:22.816Z"), + createdAt: new Date("2024-04-05T23:39:43.166Z"), + modifiedAt: new Date("2024-04-11T01:56:01.447Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", properties: {}, }, - order: 742652, + order: 790346, required: false, }, ], @@ -132,4 +134,4 @@ let value: WebhookCheckoutCreatedPayload = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [components.WebhookCheckoutCreatedPayloadType](../../models/components/webhookcheckoutcreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.PolarCheckoutSchemasCheckoutInput](../../models/components/polarcheckoutschemascheckoutinput.md) | :heavy_check_mark: | Checkout session data retrieved using an access token. | \ No newline at end of file +| `data` | [components.PolarCheckoutSchemasCheckout](../../models/components/polarcheckoutschemascheckout.md) | :heavy_check_mark: | Checkout session data retrieved using an access token. | \ No newline at end of file diff --git a/docs/models/components/webhookcheckoutupdatedpayload.md b/docs/models/components/webhookcheckoutupdatedpayload.md index 4efb77dc..68eff3d2 100644 --- a/docs/models/components/webhookcheckoutupdatedpayload.md +++ b/docs/models/components/webhookcheckoutupdatedpayload.md @@ -11,68 +11,68 @@ import { WebhookCheckoutUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookCheckoutUpdatedPayload = { data: { - createdAt: new Date("2022-08-07T22:36:11.072Z"), - modifiedAt: new Date("2024-08-17T23:34:09.972Z"), + createdAt: new Date("2023-08-19T15:30:07.630Z"), + modifiedAt: new Date("2024-06-17T19:03:37.149Z"), id: "", status: "expired", clientSecret: "", - url: "https://prickly-lieu.biz/", - expiresAt: new Date("2023-11-20T11:24:09.591Z"), - successUrl: "https://first-caption.name", + url: "https://impossible-lobster.com", + expiresAt: new Date("2022-02-08T09:47:50.312Z"), + successUrl: "https://acceptable-rust.net/", embedOrigin: "", - amount: 282979, - taxAmount: 325225, - currency: "Lebanese Pound", - totalAmount: 731201, + amount: 416757, + taxAmount: 608634, + currency: "Belize Dollar", + totalAmount: 844550, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Javier.Stehr40@gmail.com", + customerEmail: "Felix.Rath36@yahoo.com", customerIpAddress: "", customerBillingAddress: { - country: "Cambodia", + country: "Chad", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { - "key": "", + "key": 369976, }, product: { - createdAt: new Date("2022-01-02T23:04:43.120Z"), - modifiedAt: new Date("2023-01-30T14:22:07.592Z"), + createdAt: new Date("2022-03-09T06:44:50.644Z"), + modifiedAt: new Date("2022-12-06T22:09:36.543Z"), id: "", name: "", - description: - "closely republican yahoo digestive crazy plus eyeliner rewarding mmm", + description: "psst wonderfully after meh", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-05-16T08:11:45.795Z"), - modifiedAt: new Date("2023-05-22T14:57:08.680Z"), + createdAt: new Date("2023-08-11T20:04:48.452Z"), + modifiedAt: new Date("2022-10-23T05:03:16.724Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 654833, - maximumAmount: 371870, - presetAmount: 517246, - recurringInterval: "year", + minimumAmount: 694927, + maximumAmount: 709929, + presetAmount: 520841, }, ], benefits: [ { - createdAt: new Date("2022-07-11T19:27:37.850Z"), - modifiedAt: new Date("2024-09-21T16:35:34.104Z"), + createdAt: new Date("2023-12-26T05:35:55.283Z"), + modifiedAt: new Date("2023-06-25T20:54:21.122Z"), id: "", - type: "discord", - description: "considering although foretell upbeat gift wherever", + description: "yet quixotic bah why hmph whoever recent aha crossly", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -80,45 +80,58 @@ let value: WebhookCheckoutUpdatedPayload = { id: "", organizationId: "", name: "", - path: "/lib", + path: "/root", mimeType: "", - size: 333131, + size: 603216, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-09-13T07:17:27.740Z"), + lastModifiedAt: new Date("2024-12-20T09:19:45.561Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-09T01:53:56.642Z"), + createdAt: new Date("2024-11-25T14:46:21.238Z"), + sizeReadable: "", + publicUrl: "https://odd-synergy.info", }, ], }, productPrice: { - createdAt: new Date("2023-11-03T19:31:40.966Z"), - modifiedAt: new Date("2024-08-03T13:01:33.319Z"), + createdAt: new Date("2023-08-06T04:55:45.780Z"), + modifiedAt: new Date("2024-09-24T10:31:27.817Z"), id: "", isArchived: false, productId: "", - recurringInterval: "month", + priceCurrency: "", + minimumAmount: 5736, + maximumAmount: 855552, + presetAmount: 608236, + recurringInterval: "year", }, subscriptionId: "", attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-07-02T16:51:39.984Z"), - modifiedAt: new Date("2023-11-01T05:10:14.364Z"), + createdAt: new Date("2023-02-06T10:05:18.965Z"), + modifiedAt: new Date("2023-11-27T17:45:25.271Z"), id: "", metadata: { - "key": "", + "key": 921566, }, slug: "", name: "", organizationId: "", - properties: {}, + properties: { + options: [ + { + value: "", + label: "", + }, + ], + }, }, - order: 12254, + order: 19684, required: false, }, ], @@ -131,4 +144,4 @@ let value: WebhookCheckoutUpdatedPayload = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `type` | [components.WebhookCheckoutUpdatedPayloadType](../../models/components/webhookcheckoutupdatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.PolarCheckoutSchemasCheckoutInput](../../models/components/polarcheckoutschemascheckoutinput.md) | :heavy_check_mark: | Checkout session data retrieved using an access token. | \ No newline at end of file +| `data` | [components.PolarCheckoutSchemasCheckout](../../models/components/polarcheckoutschemascheckout.md) | :heavy_check_mark: | Checkout session data retrieved using an access token. | \ No newline at end of file diff --git a/docs/models/components/webhookdonationcreatedpayload.md b/docs/models/components/webhookdonationcreatedpayload.md deleted file mode 100644 index 8608ae4c..00000000 --- a/docs/models/components/webhookdonationcreatedpayload.md +++ /dev/null @@ -1,89 +0,0 @@ -# WebhookDonationCreatedPayload - -Sent when a new donation is created. - -**Discord & Slack support:** Full - -## Example Usage - -```typescript -import { WebhookDonationCreatedPayload } from "@polar-sh/sdk/models/components"; - -let value: WebhookDonationCreatedPayload = { - data: { - createdAt: new Date("2024-06-01T03:35:11.920Z"), - modifiedAt: new Date("2022-06-16T15:19:22.874Z"), - id: "", - amount: 988523, - currency: "Dalasi", - message: "", - donor: { - id: "", - publicName: "", - avatarUrl: "https://smoggy-place.net/", - }, - email: "Marjory_Price46@hotmail.com", - issue: { - id: "30c5c2a0-90bc-4653-ad7c-9224d5eab407", - number: 335230, - title: "", - state: "closed", - issueCreatedAt: new Date("2023-12-02T02:54:47.752Z"), - needsConfirmationSolved: false, - funding: {}, - repository: { - id: "fc82a267-7308-4718-b1fb-5d1ea1699baa", - isPrivate: false, - name: "MyOrg", - description: "subtle zowie gallivant", - stars: 1337, - license: "", - homepage: "", - profileSettings: {}, - organization: { - id: "12ac07c8-6215-4451-a38f-6648daffd0c9", - name: "", - avatarUrl: "https://electric-fraudster.name", - isPersonal: false, - bio: "", - prettyName: "", - company: "Stracke LLC", - blog: "", - location: "", - email: "Tamara61@gmail.com", - twitterUsername: "", - organizationId: "", - }, - internalOrganization: { - createdAt: new Date("2023-04-30T05:00:39.346Z"), - modifiedAt: new Date("2024-02-04T23:21:36.977Z"), - id: "", - name: "", - slug: "", - avatarUrl: "https://caring-mom.info", - bio: "", - company: "Wehner, Dibbert and Boyle", - blog: "", - location: "", - email: "Aileen96@yahoo.com", - twitterUsername: "", - pledgeMinimumAmount: 913945, - pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 334873, - donationsEnabled: false, - profileSettings: {}, - featureSettings: {}, - }, - }, - pledgeBadgeCurrentlyEmbedded: false, - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [components.WebhookDonationCreatedPayloadType](../../models/components/webhookdonationcreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.Donation](../../models/components/donation.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhookdonationcreatedpayloadtype.md b/docs/models/components/webhookdonationcreatedpayloadtype.md deleted file mode 100644 index 09650428..00000000 --- a/docs/models/components/webhookdonationcreatedpayloadtype.md +++ /dev/null @@ -1,15 +0,0 @@ -# WebhookDonationCreatedPayloadType - -## Example Usage - -```typescript -import { WebhookDonationCreatedPayloadType } from "@polar-sh/sdk/models/components"; - -let value: WebhookDonationCreatedPayloadType = "donation.created"; -``` - -## Values - -```typescript -"donation.created" -``` \ No newline at end of file diff --git a/docs/models/components/webhookordercreatedpayload.md b/docs/models/components/webhookordercreatedpayload.md index 3e3b9108..3097854e 100644 --- a/docs/models/components/webhookordercreatedpayload.md +++ b/docs/models/components/webhookordercreatedpayload.md @@ -11,15 +11,15 @@ import { WebhookOrderCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookOrderCreatedPayload = { data: { - createdAt: new Date("2022-10-05T21:44:59.619Z"), - modifiedAt: new Date("2024-01-21T01:04:50.326Z"), + createdAt: new Date("2023-09-01T01:11:59.221Z"), + modifiedAt: new Date("2023-07-11T00:50:41.686Z"), id: "", metadata: { "key": "", }, - amount: 611589, - taxAmount: 896483, - currency: "Vatu", + amount: 428147, + taxAmount: 296892, + currency: "Philippine Peso", billingReason: "subscription_update", userId: "", productId: "", @@ -28,49 +28,49 @@ let value: WebhookOrderCreatedPayload = { checkoutId: "", user: { id: "", - email: "Gabrielle69@gmail.com", + email: "Godfrey61@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://bulky-whale.com/", + avatarUrl: "https://defenseless-reorganisation.com", }, product: { - createdAt: new Date("2023-12-31T21:38:37.650Z"), - modifiedAt: new Date("2022-02-26T00:22:42.503Z"), + createdAt: new Date("2024-10-02T20:36:49.150Z"), + modifiedAt: new Date("2024-01-26T23:42:41.917Z"), id: "", name: "", - description: "nervously zowie amid", + description: "since or emphasise", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2024-02-02T12:36:51.052Z"), - modifiedAt: new Date("2024-10-26T12:43:46.379Z"), + createdAt: new Date("2024-03-12T09:29:49.374Z"), + modifiedAt: new Date("2022-01-17T09:30:26.346Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 901228, - maximumAmount: 597835, - presetAmount: 571214, + minimumAmount: 478217, + maximumAmount: 123490, + presetAmount: 853228, recurringInterval: "month", }, subscription: { metadata: { - "key": "", + "key": 47423, }, - createdAt: new Date("2024-04-25T05:56:55.870Z"), - modifiedAt: new Date("2022-10-19T11:47:06.902Z"), + createdAt: new Date("2022-06-13T11:03:06.616Z"), + modifiedAt: new Date("2022-01-02T23:04:43.120Z"), id: "", - amount: 917917, - currency: "Djibouti Franc", + amount: 360035, + currency: "Syrian Pound", recurringInterval: "year", - status: "incomplete", - currentPeriodStart: new Date("2023-06-26T07:05:03.761Z"), - currentPeriodEnd: new Date("2022-06-13T06:47:36.631Z"), + status: "canceled", + currentPeriodStart: new Date("2022-07-12T07:15:18.514Z"), + currentPeriodEnd: new Date("2024-01-13T08:47:31.957Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-07-12T13:59:51.236Z"), - endedAt: new Date("2023-11-04T22:50:34.224Z"), + startedAt: new Date("2024-03-28T11:02:14.499Z"), + endedAt: new Date("2023-01-13T00:35:57.498Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/webhookorganizationupdatedpayload.md b/docs/models/components/webhookorganizationupdatedpayload.md index 04b02beb..a8331753 100644 --- a/docs/models/components/webhookorganizationupdatedpayload.md +++ b/docs/models/components/webhookorganizationupdatedpayload.md @@ -11,22 +11,21 @@ import { WebhookOrganizationUpdatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookOrganizationUpdatedPayload = { data: { - createdAt: new Date("2024-06-25T10:13:45.773Z"), - modifiedAt: new Date("2024-05-28T00:02:44.533Z"), + createdAt: new Date("2024-01-19T04:11:11.964Z"), + modifiedAt: new Date("2023-03-26T17:02:56.524Z"), id: "", name: "", slug: "", - avatarUrl: "https://golden-orchid.com/", + avatarUrl: "https://fixed-patroller.net/", bio: "", - company: "Bergstrom - Crona", + company: "Prosacco, Jones and Franecki", blog: "", location: "", - email: "Lolita47@yahoo.com", + email: "Molly41@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 677492, + pledgeMinimumAmount: 9143, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 319975, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 538556, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/webhookpledgecreatedpayload.md b/docs/models/components/webhookpledgecreatedpayload.md index 17de9ace..b0196a43 100644 --- a/docs/models/components/webhookpledgecreatedpayload.md +++ b/docs/models/components/webhookpledgecreatedpayload.md @@ -11,62 +11,61 @@ import { WebhookPledgeCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookPledgeCreatedPayload = { data: { - createdAt: new Date("2024-05-30T10:39:49.151Z"), - modifiedAt: new Date("2022-05-16T21:37:36.664Z"), + createdAt: new Date("2022-11-02T18:35:31.377Z"), + modifiedAt: new Date("2023-07-19T07:37:54.459Z"), id: "", - amount: 871469, - currency: "Liberian Dollar", - state: "refunded", - type: "pay_directly", + amount: 613676, + currency: "Rufiyaa", + state: "charge_disputed", + type: "pay_on_completion", issue: { - id: "a14b144b-0561-478f-8de4-2a39317a1864", - number: 234326, + id: "346ce0f7-2970-49e7-83a4-e7c0b23d145e", + number: 616935, title: "", - state: "closed", - issueCreatedAt: new Date("2022-02-04T22:19:13.160Z"), + state: "open", + issueCreatedAt: new Date("2022-11-13T12:49:49.908Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "28a634ab-fb63-48b1-b036-a08456761276", + id: "78299635-1b05-4e38-82fd-5c9323afce3e", isPrivate: false, name: "MyOrg", description: - "schlep atomize wilted for nucleotidase nor gullible cake aha", + "outflank caring since celsius partially marksman patroller lovely fooey youthful", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "ca6060f6-9f92-4f32-b56f-8cc611fd5dee", + id: "2e0aae32-8f4c-454a-9c09-86c586772c48", name: "", - avatarUrl: "https://staid-awareness.net/", + avatarUrl: "https://swift-unit.info", isPersonal: false, bio: "", prettyName: "", - company: "Rice LLC", + company: "Stokes, Marvin and Corkery", blog: "", location: "", - email: "Ali80@yahoo.com", + email: "Tyrell46@hotmail.com", twitterUsername: "", organizationId: "", }, internalOrganization: { - createdAt: new Date("2023-09-12T04:23:00.142Z"), - modifiedAt: new Date("2022-04-26T00:53:32.713Z"), + createdAt: new Date("2024-03-02T17:01:51.399Z"), + modifiedAt: new Date("2024-12-31T07:50:18.161Z"), id: "", name: "", slug: "", - avatarUrl: "https://ideal-translation.biz/", + avatarUrl: "https://understated-signature.name", bio: "", - company: "Nitzsche Inc", + company: "Christiansen - Schultz", blog: "", location: "", - email: "Maureen83@gmail.com", + email: "Leatha95@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 186756, + pledgeMinimumAmount: 564017, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 422299, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 601880, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/webhookpledgeupdatedpayload.md b/docs/models/components/webhookpledgeupdatedpayload.md index b2e2400c..cdb035b1 100644 --- a/docs/models/components/webhookpledgeupdatedpayload.md +++ b/docs/models/components/webhookpledgeupdatedpayload.md @@ -11,61 +11,61 @@ import { WebhookPledgeUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookPledgeUpdatedPayload = { data: { - createdAt: new Date("2023-12-17T23:08:04.134Z"), - modifiedAt: new Date("2024-07-07T00:56:00.393Z"), + createdAt: new Date("2023-08-31T03:43:53.251Z"), + modifiedAt: new Date("2022-07-04T01:30:00.013Z"), id: "", - amount: 527628, - currency: "Rial Omani", - state: "cancelled", - type: "pay_directly", + amount: 168922, + currency: "Jamaican Dollar", + state: "disputed", + type: "pay_upfront", issue: { - id: "1bf60b4e-2607-439b-8421-4d6345389cb3", - number: 903880, + id: "7f077b4c-61a0-4b09-9db9-655682ea5fd9", + number: 369094, title: "", - state: "closed", - issueCreatedAt: new Date("2022-01-09T03:41:50.109Z"), + state: "open", + issueCreatedAt: new Date("2023-01-11T09:40:17.816Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "07de3c6a-52b4-40f6-b1cd-4a1633f08a53", + id: "39b48cab-3a43-4457-835e-230b870fddec", isPrivate: false, name: "MyOrg", - description: "qualified cone emotional lest", + description: + "um underneath completion before monthly daintily synergy yearn too fervently", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "9f98ee7a-a429-40dc-9bef-7afda7b00c2c", + id: "1b9c64d9-7e56-4429-aeaa-db6c1d88ea14", name: "", - avatarUrl: "https://best-knitting.biz", + avatarUrl: "https://fat-dividend.net/", isPersonal: false, bio: "", prettyName: "", - company: "Lindgren - Abshire", + company: "Hegmann - Kautzer", blog: "", location: "", - email: "Ivy32@gmail.com", + email: "Jaden_Witting93@gmail.com", twitterUsername: "", organizationId: "", }, internalOrganization: { - createdAt: new Date("2022-07-07T22:13:16.221Z"), - modifiedAt: new Date("2023-11-16T12:57:07.514Z"), + createdAt: new Date("2022-06-14T13:59:56.674Z"), + modifiedAt: new Date("2023-12-01T18:54:11.315Z"), id: "", name: "", slug: "", - avatarUrl: "https://big-secrecy.org/", + avatarUrl: "https://outrageous-cosset.com/", bio: "", - company: "Metz and Sons", + company: "Nienow Group", blog: "", location: "", - email: "Joany_Fritsch@hotmail.com", + email: "Hulda.DAmore89@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 489133, + pledgeMinimumAmount: 147484, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 491716, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 518170, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/components/webhookproductcreatedpayload.md b/docs/models/components/webhookproductcreatedpayload.md index dc283de1..ad71795c 100644 --- a/docs/models/components/webhookproductcreatedpayload.md +++ b/docs/models/components/webhookproductcreatedpayload.md @@ -11,40 +11,46 @@ import { WebhookProductCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookProductCreatedPayload = { data: { - createdAt: new Date("2024-02-05T02:33:57.609Z"), - modifiedAt: new Date("2022-10-27T07:25:37.639Z"), + createdAt: new Date("2024-04-12T17:44:59.979Z"), + modifiedAt: new Date("2024-01-31T13:31:33.214Z"), id: "", name: "", - description: "husky avalanche squid noxious connect amused", + description: + "fearless caring hmph woot embed stir-fry mmm infatuated until", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 35662, + }, prices: [ { - createdAt: new Date("2024-01-29T05:16:30.896Z"), - modifiedAt: new Date("2022-10-19T23:23:19.077Z"), + createdAt: new Date("2024-03-30T19:29:14.034Z"), + modifiedAt: new Date("2022-07-08T06:05:15.080Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 799934, - maximumAmount: 400993, - presetAmount: 95162, - recurringInterval: "year", + priceAmount: 845105, }, ], benefits: [ { - createdAt: new Date("2024-02-25T14:45:53.645Z"), - modifiedAt: new Date("2022-01-14T07:20:18.212Z"), + createdAt: new Date("2023-02-17T17:56:53.516Z"), + modifiedAt: new Date("2022-07-08T18:50:43.868Z"), id: "", description: - "instead under notwithstanding elastic furthermore moisten save", + "mostly substantiate bravely anesthetize unto agile crest put phooey", selectable: false, deletable: false, organizationId: "", properties: { - paidArticles: false, + archived: { + "key": false, + }, + files: [ + "", + ], }, }, ], @@ -53,25 +59,27 @@ let value: WebhookProductCreatedPayload = { id: "", organizationId: "", name: "", - path: "/etc/namedb", + path: "/private", mimeType: "", - size: 971493, + size: 513819, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-10-20T08:31:50.564Z"), + lastModifiedAt: new Date("2023-06-21T03:59:41.372Z"), version: "", isUploaded: false, - createdAt: new Date("2024-02-02T21:36:44.416Z"), + createdAt: new Date("2022-06-05T14:44:57.569Z"), + sizeReadable: "", + publicUrl: "https://smoggy-republican.biz/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-01-02T05:13:35.742Z"), - modifiedAt: new Date("2023-06-17T12:06:28.738Z"), + createdAt: new Date("2024-10-28T21:36:36.709Z"), + modifiedAt: new Date("2024-07-08T13:41:05.027Z"), id: "", metadata: { "key": "", @@ -79,9 +87,16 @@ let value: WebhookProductCreatedPayload = { slug: "", name: "", organizationId: "", - properties: {}, + properties: { + options: [ + { + value: "", + label: "", + }, + ], + }, }, - order: 594804, + order: 133230, required: false, }, ], @@ -94,4 +109,4 @@ let value: WebhookProductCreatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookProductCreatedPayloadType](../../models/components/webhookproductcreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.ProductInput](../../models/components/productinput.md) | :heavy_check_mark: | A product. | \ No newline at end of file +| `data` | [components.Product](../../models/components/product.md) | :heavy_check_mark: | A product. | \ No newline at end of file diff --git a/docs/models/components/webhookproductupdatedpayload.md b/docs/models/components/webhookproductupdatedpayload.md index f3ad18f8..b684133a 100644 --- a/docs/models/components/webhookproductupdatedpayload.md +++ b/docs/models/components/webhookproductupdatedpayload.md @@ -11,39 +11,37 @@ import { WebhookProductUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookProductUpdatedPayload = { data: { - createdAt: new Date("2024-12-25T09:41:05.009Z"), - modifiedAt: new Date("2022-05-26T16:11:49.684Z"), + createdAt: new Date("2022-02-26T03:29:51.928Z"), + modifiedAt: new Date("2023-07-07T02:04:12.238Z"), id: "", name: "", - description: "candid than indeed", + description: "perfectly extremely encode gadzooks browse atomize", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 193506, + }, prices: [ { - createdAt: new Date("2024-03-14T12:56:53.269Z"), - modifiedAt: new Date("2024-07-23T05:17:11.148Z"), + createdAt: new Date("2022-01-16T20:56:53.226Z"), + modifiedAt: new Date("2023-03-31T19:03:13.780Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - minimumAmount: 525439, - maximumAmount: 402139, - presetAmount: 394633, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2022-01-17T05:42:45.439Z"), - modifiedAt: new Date("2024-03-25T22:52:07.722Z"), + createdAt: new Date("2024-09-12T19:18:28.211Z"), + modifiedAt: new Date("2023-03-24T21:56:02.071Z"), id: "", - description: "indeed throughout joyfully annual doodle dish", + description: "consequently improbable quarterly testify", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, + properties: {}, }, ], medias: [ @@ -51,42 +49,37 @@ let value: WebhookProductUpdatedPayload = { id: "", organizationId: "", name: "", - path: "/etc/mail", + path: "/usr/local/src", mimeType: "", - size: 570896, + size: 846160, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-10-06T18:59:00.388Z"), + lastModifiedAt: new Date("2023-03-20T09:47:46.111Z"), version: "", isUploaded: false, - createdAt: new Date("2023-12-13T02:05:45.362Z"), + createdAt: new Date("2022-10-08T23:40:51.269Z"), + sizeReadable: "", + publicUrl: "https://honored-equal.biz", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-07-29T19:58:52.381Z"), - modifiedAt: new Date("2024-02-07T07:59:02.677Z"), + createdAt: new Date("2022-07-13T21:58:05.271Z"), + modifiedAt: new Date("2024-07-01T22:06:35.493Z"), id: "", metadata: { - "key": "", + "key": 261144, }, slug: "", name: "", organizationId: "", - properties: { - options: [ - { - value: "", - label: "", - }, - ], - }, + properties: {}, }, - order: 375940, + order: 584231, required: false, }, ], @@ -99,4 +92,4 @@ let value: WebhookProductUpdatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookProductUpdatedPayloadType](../../models/components/webhookproductupdatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.ProductInput](../../models/components/productinput.md) | :heavy_check_mark: | A product. | \ No newline at end of file +| `data` | [components.Product](../../models/components/product.md) | :heavy_check_mark: | A product. | \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptionactivepayload.md b/docs/models/components/webhooksubscriptionactivepayload.md index 97e5fbe4..de705976 100644 --- a/docs/models/components/webhooksubscriptionactivepayload.md +++ b/docs/models/components/webhooksubscriptionactivepayload.md @@ -12,70 +12,74 @@ import { WebhookSubscriptionActivePayload } from "@polar-sh/sdk/models/component let value: WebhookSubscriptionActivePayload = { data: { - createdAt: new Date("2022-05-03T03:10:03.746Z"), - modifiedAt: new Date("2024-10-13T07:18:44.318Z"), + createdAt: new Date("2024-11-01T16:04:46.969Z"), + modifiedAt: new Date("2024-12-20T11:54:29.031Z"), id: "", - amount: 218555, - currency: "Euro", - recurringInterval: "year", - status: "active", - currentPeriodStart: new Date("2023-09-02T01:59:47.325Z"), - currentPeriodEnd: new Date("2023-02-05T12:14:52.685Z"), + amount: 69919, + currency: "Aruban Guilder", + recurringInterval: "month", + status: "unpaid", + currentPeriodStart: new Date("2023-02-21T10:40:08.403Z"), + currentPeriodEnd: new Date("2022-09-08T18:41:35.233Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-03-21T02:46:56.469Z"), - endedAt: new Date("2022-07-05T00:05:08.045Z"), + startedAt: new Date("2024-12-05T22:27:48.611Z"), + endedAt: new Date("2022-09-13T23:26:45.333Z"), userId: "", productId: "", priceId: "", checkoutId: "", metadata: { - "key": "", + "key": false, }, user: { - email: "Henderson_Christiansen96@yahoo.com", + email: "Lonzo.Gottlieb@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://triangular-finer.name", + avatarUrl: "https://slimy-pacemaker.com/", }, product: { - createdAt: new Date("2022-04-09T05:37:51.811Z"), - modifiedAt: new Date("2023-01-05T09:56:17.090Z"), + createdAt: new Date("2022-03-13T21:30:50.627Z"), + modifiedAt: new Date("2022-04-11T23:02:43.476Z"), id: "", name: "", - description: "a er affectionate unlike", + description: "oval supposing drat fervently", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": false, + }, prices: [ { - createdAt: new Date("2024-04-09T16:23:40.595Z"), - modifiedAt: new Date("2024-12-26T22:45:57.487Z"), + createdAt: new Date("2023-11-29T16:19:41.020Z"), + modifiedAt: new Date("2024-09-14T03:25:38.296Z"), id: "", isArchived: false, productId: "", + priceCurrency: "", + minimumAmount: 905385, + maximumAmount: 668499, + presetAmount: 213426, recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2022-03-04T10:48:40.423Z"), - modifiedAt: new Date("2024-01-08T16:17:32.860Z"), + createdAt: new Date("2023-01-30T12:54:28.356Z"), + modifiedAt: new Date("2022-05-13T06:17:57.337Z"), id: "", - description: "than mooch meh gosh past mmm but well-off", + description: + "veto considering even upliftingly lest outside gosh optimal despite", selectable: false, deletable: false, organizationId: "", properties: { - prefix: "", - expires: { - ttl: 928637, - timeframe: "month", + archived: { + "key": false, }, - activations: { - limit: 601880, - enableUserAdmin: false, - }, - limitUsage: 962248, + files: [ + "", + ], }, }, ], @@ -84,25 +88,27 @@ let value: WebhookSubscriptionActivePayload = { id: "", organizationId: "", name: "", - path: "/opt/bin", + path: "/lost+found", mimeType: "", - size: 630837, + size: 932097, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-27T22:20:58.886Z"), + lastModifiedAt: new Date("2023-03-27T21:41:18.396Z"), version: "", isUploaded: false, - createdAt: new Date("2023-01-13T19:33:41.074Z"), + createdAt: new Date("2023-07-17T16:35:31.351Z"), + sizeReadable: "", + publicUrl: "https://black-and-white-reward.org/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2023-09-17T07:55:12.504Z"), - modifiedAt: new Date("2023-05-25T18:09:04.297Z"), + createdAt: new Date("2024-09-13T10:47:55.235Z"), + modifiedAt: new Date("2024-04-28T06:03:10.412Z"), id: "", metadata: { "key": "", @@ -110,22 +116,27 @@ let value: WebhookSubscriptionActivePayload = { slug: "", name: "", organizationId: "", - properties: {}, + properties: { + options: [ + { + value: "", + label: "", + }, + ], + }, }, - order: 54128, + order: 66657, required: false, }, ], }, price: { - createdAt: new Date("2023-08-16T15:42:57.192Z"), - modifiedAt: new Date("2024-12-26T02:26:25.100Z"), + createdAt: new Date("2022-06-27T02:50:03.421Z"), + modifiedAt: new Date("2023-11-21T13:19:25.571Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 459436, - recurringInterval: "year", + recurringInterval: "month", }, }, }; @@ -136,4 +147,4 @@ let value: WebhookSubscriptionActivePayload = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `type` | [components.WebhookSubscriptionActivePayloadType](../../models/components/webhooksubscriptionactivepayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.SubscriptionInput](../../models/components/subscriptioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.Subscription](../../models/components/subscription.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptioncanceledpayload.md b/docs/models/components/webhooksubscriptioncanceledpayload.md index 5665d8fe..8c8cd8d4 100644 --- a/docs/models/components/webhooksubscriptioncanceledpayload.md +++ b/docs/models/components/webhooksubscriptioncanceledpayload.md @@ -12,75 +12,64 @@ import { WebhookSubscriptionCanceledPayload } from "@polar-sh/sdk/models/compone let value: WebhookSubscriptionCanceledPayload = { data: { - createdAt: new Date("2024-07-22T10:55:03.530Z"), - modifiedAt: new Date("2024-10-03T13:31:02.987Z"), + createdAt: new Date("2023-07-20T00:58:40.878Z"), + modifiedAt: new Date("2023-06-19T07:49:43.108Z"), id: "", - amount: 366130, - currency: "Congolese Franc", + amount: 718730, + currency: "Baht", recurringInterval: "year", - status: "active", - currentPeriodStart: new Date("2024-08-28T19:32:15.730Z"), - currentPeriodEnd: new Date("2022-11-24T03:54:23.518Z"), + status: "incomplete_expired", + currentPeriodStart: new Date("2023-04-24T13:59:45.564Z"), + currentPeriodEnd: new Date("2023-02-17T02:31:29.573Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-04-08T04:12:08.099Z"), - endedAt: new Date("2024-08-20T17:29:24.705Z"), + startedAt: new Date("2022-02-07T00:55:32.603Z"), + endedAt: new Date("2022-09-17T13:29:52.910Z"), userId: "", productId: "", priceId: "", checkoutId: "", metadata: { - "key": "", + "key": 876944, }, user: { - email: "Ignatius_Jast-Marvin22@yahoo.com", + email: "Maybell.Daugherty98@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://strident-countess.biz", + avatarUrl: "https://troubled-duffel.biz/", }, product: { - createdAt: new Date("2022-01-10T13:24:18.025Z"), - modifiedAt: new Date("2023-02-26T18:38:22.806Z"), + createdAt: new Date("2024-05-06T21:17:14.746Z"), + modifiedAt: new Date("2024-03-06T08:55:14.766Z"), id: "", name: "", - description: - "modulo boyfriend miserable actually truthfully spear yuck ultimately whether misspend", + description: "vaguely vibraphone perky", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": "", + }, prices: [ { - createdAt: new Date("2022-03-14T06:04:36.588Z"), - modifiedAt: new Date("2023-04-06T00:36:00.465Z"), + createdAt: new Date("2023-07-08T21:08:29.769Z"), + modifiedAt: new Date("2022-12-15T21:39:10.857Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 660201, - maximumAmount: 988035, - presetAmount: 384084, + priceAmount: 288523, }, ], benefits: [ { - createdAt: new Date("2023-08-25T13:14:09.111Z"), - modifiedAt: new Date("2023-05-24T06:35:11.657Z"), + createdAt: new Date("2023-08-24T09:07:04.039Z"), + modifiedAt: new Date("2024-07-14T14:46:19.316Z"), id: "", - description: "meaty outdo palatable qua inventory expensive", + description: "transparency bump headline ha academics reassuringly", selectable: false, deletable: false, organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 517327, - timeframe: "month", - }, - activations: { - limit: 552292, - enableUserAdmin: false, - }, - limitUsage: 405679, - }, + properties: {}, }, ], medias: [ @@ -88,25 +77,27 @@ let value: WebhookSubscriptionCanceledPayload = { id: "", organizationId: "", name: "", - path: "/etc/namedb", + path: "/media", mimeType: "", - size: 868057, + size: 69879, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-05-04T02:40:37.506Z"), + lastModifiedAt: new Date("2022-04-24T17:12:35.341Z"), version: "", isUploaded: false, - createdAt: new Date("2022-06-02T20:34:13.519Z"), + createdAt: new Date("2022-03-15T03:20:48.152Z"), + sizeReadable: "", + publicUrl: "https://functional-collectivization.com", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2022-02-13T04:39:14.167Z"), - modifiedAt: new Date("2024-07-29T01:46:42.865Z"), + createdAt: new Date("2022-01-25T17:10:29.427Z"), + modifiedAt: new Date("2023-06-27T19:14:57.655Z"), id: "", metadata: { "key": "", @@ -116,19 +107,21 @@ let value: WebhookSubscriptionCanceledPayload = { organizationId: "", properties: {}, }, - order: 891709, + order: 145952, required: false, }, ], }, price: { - createdAt: new Date("2023-05-21T21:06:16.049Z"), - modifiedAt: new Date("2023-03-07T22:19:42.398Z"), + createdAt: new Date("2022-08-15T18:14:34.029Z"), + modifiedAt: new Date("2023-11-29T19:36:58.004Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 126154, + minimumAmount: 378983, + maximumAmount: 784480, + presetAmount: 657895, recurringInterval: "year", }, }, @@ -140,4 +133,4 @@ let value: WebhookSubscriptionCanceledPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookSubscriptionCanceledPayloadType](../../models/components/webhooksubscriptioncanceledpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.SubscriptionInput](../../models/components/subscriptioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.Subscription](../../models/components/subscription.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptioncreatedpayload.md b/docs/models/components/webhooksubscriptioncreatedpayload.md index 005db0ca..21e239f1 100644 --- a/docs/models/components/webhooksubscriptioncreatedpayload.md +++ b/docs/models/components/webhooksubscriptioncreatedpayload.md @@ -11,18 +11,18 @@ import { WebhookSubscriptionCreatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookSubscriptionCreatedPayload = { data: { - createdAt: new Date("2024-12-07T01:19:47.170Z"), - modifiedAt: new Date("2022-06-04T13:30:33.023Z"), + createdAt: new Date("2022-05-06T06:29:10.335Z"), + modifiedAt: new Date("2024-03-24T10:54:04.717Z"), id: "", - amount: 856101, - currency: "Solomon Islands Dollar", - recurringInterval: "month", - status: "incomplete", - currentPeriodStart: new Date("2024-03-17T14:54:52.778Z"), - currentPeriodEnd: new Date("2022-04-18T13:40:59.739Z"), + amount: 521471, + currency: "Kuwaiti Dinar", + recurringInterval: "year", + status: "active", + currentPeriodStart: new Date("2022-11-20T07:02:04.141Z"), + currentPeriodEnd: new Date("2024-03-31T06:44:53.428Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-06-05T14:26:47.431Z"), - endedAt: new Date("2024-05-25T03:35:13.442Z"), + startedAt: new Date("2022-10-23T18:03:37.523Z"), + endedAt: new Date("2022-10-30T19:24:48.529Z"), userId: "", productId: "", priceId: "", @@ -31,49 +31,57 @@ let value: WebhookSubscriptionCreatedPayload = { "key": "", }, user: { - email: "Virginia_Mitchell46@gmail.com", + email: "Price_Hoppe@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://infatuated-wasabi.com", + avatarUrl: "https://muddy-doorpost.biz/", }, product: { - createdAt: new Date("2022-06-25T22:06:25.582Z"), - modifiedAt: new Date("2024-09-13T18:47:53.991Z"), + createdAt: new Date("2023-06-20T06:28:18.243Z"), + modifiedAt: new Date("2023-07-03T19:12:50.569Z"), id: "", name: "", - description: "pants shoot ew yahoo lest under", + description: "lest lovable wriggler upward whoa", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 654833, + }, prices: [ { - createdAt: new Date("2024-05-17T05:06:11.950Z"), - modifiedAt: new Date("2022-07-03T14:59:21.254Z"), + createdAt: new Date("2024-11-03T20:41:32.976Z"), + modifiedAt: new Date("2022-12-07T04:29:21.475Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 646317, - maximumAmount: 730622, - presetAmount: 707192, + minimumAmount: 175010, + maximumAmount: 907566, + presetAmount: 483254, recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2022-06-22T04:46:57.872Z"), - modifiedAt: new Date("2022-11-27T22:55:13.459Z"), + createdAt: new Date("2022-10-21T12:24:46.268Z"), + modifiedAt: new Date("2024-05-22T22:32:55.689Z"), id: "", - description: - "gah sparse fencing parsnip playfully convection unbearably supposing bleakly plumber", + description: "drat until converse than a unnecessarily sneak", selectable: false, deletable: false, organizationId: "", properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "pull", + prefix: "", + expires: { + ttl: 610598, + timeframe: "year", + }, + activations: { + limit: 253564, + enableUserAdmin: false, + }, + limitUsage: 684348, }, }, ], @@ -82,57 +90,50 @@ let value: WebhookSubscriptionCreatedPayload = { id: "", organizationId: "", name: "", - path: "/System", + path: "/sys", mimeType: "", - size: 144952, + size: 896483, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-11-02T11:04:53.043Z"), + lastModifiedAt: new Date("2024-10-11T08:49:36.926Z"), version: "", isUploaded: false, - createdAt: new Date("2023-04-24T09:40:38.592Z"), + createdAt: new Date("2024-05-27T03:30:02.459Z"), + sizeReadable: "", + publicUrl: "https://honorable-viability.info/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2023-09-01T10:53:14.069Z"), - modifiedAt: new Date("2022-07-17T08:42:37.234Z"), + createdAt: new Date("2024-11-20T08:22:50.535Z"), + modifiedAt: new Date("2024-02-06T16:09:13.076Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", - properties: { - options: [ - { - value: "", - label: "", - }, - ], - }, + properties: {}, }, - order: 754898, + order: 412364, required: false, }, ], }, price: { - createdAt: new Date("2022-01-22T01:43:38.808Z"), - modifiedAt: new Date("2022-03-13T21:30:50.627Z"), + createdAt: new Date("2024-12-13T21:51:57.448Z"), + modifiedAt: new Date("2022-04-03T22:36:08.417Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 92117, - maximumAmount: 249506, - presetAmount: 276720, - recurringInterval: "year", + priceAmount: 665969, + recurringInterval: "month", }, }, }; @@ -143,4 +144,4 @@ let value: WebhookSubscriptionCreatedPayload = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookSubscriptionCreatedPayloadType](../../models/components/webhooksubscriptioncreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.SubscriptionInput](../../models/components/subscriptioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.Subscription](../../models/components/subscription.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptionrevokedpayload.md b/docs/models/components/webhooksubscriptionrevokedpayload.md index 0d2118df..3d1d8e87 100644 --- a/docs/models/components/webhooksubscriptionrevokedpayload.md +++ b/docs/models/components/webhooksubscriptionrevokedpayload.md @@ -12,73 +12,70 @@ import { WebhookSubscriptionRevokedPayload } from "@polar-sh/sdk/models/componen let value: WebhookSubscriptionRevokedPayload = { data: { - createdAt: new Date("2024-08-05T00:25:50.473Z"), - modifiedAt: new Date("2024-03-22T22:29:10.462Z"), + createdAt: new Date("2023-01-27T07:29:07.482Z"), + modifiedAt: new Date("2023-05-04T23:37:31.406Z"), id: "", - amount: 166565, - currency: "Ethiopian Birr", + amount: 668199, + currency: "Yen", recurringInterval: "month", - status: "canceled", - currentPeriodStart: new Date("2023-05-28T12:14:22.735Z"), - currentPeriodEnd: new Date("2022-06-14T21:20:15.821Z"), + status: "incomplete", + currentPeriodStart: new Date("2022-10-30T01:32:14.646Z"), + currentPeriodEnd: new Date("2024-08-05T03:49:40.522Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-01-12T01:32:36.517Z"), - endedAt: new Date("2022-11-02T05:56:35.308Z"), + startedAt: new Date("2023-10-09T03:14:12.239Z"), + endedAt: new Date("2022-01-06T02:19:06.964Z"), userId: "", productId: "", priceId: "", checkoutId: "", metadata: { - "key": "", + "key": false, }, user: { - email: "Alexandria_Beer@hotmail.com", + email: "Velda_Upton@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://grimy-expansion.net/", + avatarUrl: "https://hairy-chainstay.org/", }, product: { - createdAt: new Date("2024-08-12T21:27:15.147Z"), - modifiedAt: new Date("2023-03-25T14:39:48.268Z"), + createdAt: new Date("2023-09-16T04:12:01.967Z"), + modifiedAt: new Date("2022-09-30T10:42:40.243Z"), id: "", name: "", description: - "scarcely idolized closely uh-huh now whoa mid failing beside", + "for furthermore whopping dramatic glum but far abnormally manner", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": "", + }, prices: [ { - createdAt: new Date("2022-11-03T19:09:54.192Z"), - modifiedAt: new Date("2024-06-08T16:42:11.724Z"), + createdAt: new Date("2022-10-05T01:05:42.886Z"), + modifiedAt: new Date("2022-05-27T00:07:13.026Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 853221, }, ], benefits: [ { - createdAt: new Date("2022-11-29T02:24:30.639Z"), - modifiedAt: new Date("2024-05-05T03:19:00.639Z"), + createdAt: new Date("2024-03-11T02:46:48.262Z"), + modifiedAt: new Date("2024-05-19T04:21:15.142Z"), id: "", description: - "beside healthily athletic frenetically congregate around elementary unbearably rebel blah", + "accredit um pro hence happy outside into unless video upwardly", selectable: false, deletable: false, organizationId: "", properties: { - prefix: "", - expires: { - ttl: 67982, - timeframe: "year", + archived: { + "key": false, }, - activations: { - limit: 394192, - enableUserAdmin: false, - }, - limitUsage: 196814, + files: [ + "", + ], }, }, ], @@ -87,46 +84,55 @@ let value: WebhookSubscriptionRevokedPayload = { id: "", organizationId: "", name: "", - path: "/lib", + path: "/var", mimeType: "", - size: 183975, + size: 121889, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-11-24T09:56:09.198Z"), + lastModifiedAt: new Date("2022-06-07T01:46:11.385Z"), version: "", isUploaded: false, - createdAt: new Date("2023-07-08T07:48:14.392Z"), + createdAt: new Date("2022-02-18T10:31:07.486Z"), + sizeReadable: "", + publicUrl: "https://grubby-pilot.com/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-05-18T00:30:59.700Z"), - modifiedAt: new Date("2022-07-09T01:59:04.501Z"), + createdAt: new Date("2023-09-28T20:12:42.622Z"), + modifiedAt: new Date("2022-05-02T15:57:51.261Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", - properties: {}, + properties: { + options: [ + { + value: "", + label: "", + }, + ], + }, }, - order: 802851, + order: 849427, required: false, }, ], }, price: { - createdAt: new Date("2024-09-19T18:07:16.947Z"), - modifiedAt: new Date("2023-04-22T10:31:33.307Z"), + createdAt: new Date("2023-06-10T19:07:01.719Z"), + modifiedAt: new Date("2023-10-31T23:25:04.764Z"), id: "", isArchived: false, productId: "", - recurringInterval: "year", + recurringInterval: "month", }, }, }; @@ -137,4 +143,4 @@ let value: WebhookSubscriptionRevokedPayload = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookSubscriptionRevokedPayloadType](../../models/components/webhooksubscriptionrevokedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.SubscriptionInput](../../models/components/subscriptioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.Subscription](../../models/components/subscription.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptionupdatedpayload.md b/docs/models/components/webhooksubscriptionupdatedpayload.md index 3f28c0e5..08a60565 100644 --- a/docs/models/components/webhooksubscriptionupdatedpayload.md +++ b/docs/models/components/webhooksubscriptionupdatedpayload.md @@ -15,72 +15,67 @@ import { WebhookSubscriptionUpdatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookSubscriptionUpdatedPayload = { data: { - createdAt: new Date("2023-11-02T13:50:07.480Z"), - modifiedAt: new Date("2023-03-22T05:45:09.123Z"), + createdAt: new Date("2022-01-16T16:45:02.911Z"), + modifiedAt: new Date("2022-01-11T21:25:09.426Z"), id: "", - amount: 887523, - currency: "Ouguiya", + amount: 942435, + currency: "Won", recurringInterval: "year", - status: "unpaid", - currentPeriodStart: new Date("2024-04-11T09:26:40.257Z"), - currentPeriodEnd: new Date("2023-08-24T15:56:27.872Z"), + status: "incomplete", + currentPeriodStart: new Date("2023-06-19T13:19:31.456Z"), + currentPeriodEnd: new Date("2023-07-23T14:36:15.153Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-12-19T00:35:32.011Z"), - endedAt: new Date("2022-09-01T09:43:12.235Z"), + startedAt: new Date("2022-06-17T07:07:59.245Z"), + endedAt: new Date("2023-05-17T23:56:02.767Z"), userId: "", productId: "", priceId: "", checkoutId: "", metadata: { - "key": "", + "key": false, }, user: { - email: "Ryleigh91@hotmail.com", + email: "Christopher56@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://impressionable-discourse.org", + avatarUrl: "https://accurate-caption.com", }, product: { - createdAt: new Date("2023-02-13T18:13:00.610Z"), - modifiedAt: new Date("2022-11-24T13:29:30.071Z"), + createdAt: new Date("2023-08-31T00:49:01.651Z"), + modifiedAt: new Date("2024-02-02T12:36:51.052Z"), id: "", name: "", - description: "however emergent coolly faithfully mmm", + description: + "vastly than mmm next baritone print athletic factorize geez careless", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 71414, + }, prices: [ { - createdAt: new Date("2024-08-01T23:51:21.213Z"), - modifiedAt: new Date("2022-05-16T19:43:37.122Z"), + createdAt: new Date("2022-07-31T09:26:01.957Z"), + modifiedAt: new Date("2023-05-16T04:38:46.151Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 294711, + priceAmount: 618082, recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2022-06-06T14:34:08.591Z"), - modifiedAt: new Date("2023-11-08T03:51:26.863Z"), + createdAt: new Date("2024-08-15T14:20:54.247Z"), + modifiedAt: new Date("2022-04-02T11:10:58.103Z"), id: "", - description: "aha tousle sashay screw", + description: "proliferate oh upright as huzzah availability across", selectable: false, deletable: false, organizationId: "", properties: { - prefix: "", - expires: { - ttl: 903461, - timeframe: "year", - }, - activations: { - limit: 914590, - enableUserAdmin: false, - }, - limitUsage: 84682, + paidArticles: false, }, }, ], @@ -89,49 +84,51 @@ let value: WebhookSubscriptionUpdatedPayload = { id: "", organizationId: "", name: "", - path: "/var/mail", + path: "/usr/obj", mimeType: "", - size: 141215, + size: 888529, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-02-01T05:40:56.566Z"), + lastModifiedAt: new Date("2022-07-23T17:17:02.467Z"), version: "", isUploaded: false, - createdAt: new Date("2023-01-14T17:29:23.813Z"), + createdAt: new Date("2024-10-27T17:26:52.816Z"), + sizeReadable: "", + publicUrl: "https://unknown-scratch.com", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-03-18T07:55:59.360Z"), - modifiedAt: new Date("2024-07-09T01:28:15.858Z"), + createdAt: new Date("2024-07-21T13:43:15.502Z"), + modifiedAt: new Date("2022-02-22T16:51:45.673Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", properties: {}, }, - order: 570473, + order: 681346, required: false, }, ], }, price: { - createdAt: new Date("2022-10-14T09:26:39.208Z"), - modifiedAt: new Date("2024-09-17T01:03:46.046Z"), + createdAt: new Date("2023-09-23T00:12:30.613Z"), + modifiedAt: new Date("2022-10-13T13:05:15.971Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 564777, - maximumAmount: 411312, - presetAmount: 559499, + minimumAmount: 590659, + maximumAmount: 688082, + presetAmount: 385620, recurringInterval: "month", }, }, @@ -143,4 +140,4 @@ let value: WebhookSubscriptionUpdatedPayload = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookSubscriptionUpdatedPayloadType](../../models/components/webhooksubscriptionupdatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | [components.SubscriptionInput](../../models/components/subscriptioninput.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [components.Subscription](../../models/components/subscription.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/advertisementslistresponse.md b/docs/models/operations/advertisementslistresponse.md index 9f6d90d5..938547bd 100644 --- a/docs/models/operations/advertisementslistresponse.md +++ b/docs/models/operations/advertisementslistresponse.md @@ -9,21 +9,21 @@ let value: AdvertisementsListResponse = { result: { items: [ { - createdAt: new Date("2024-10-01T07:24:57.730Z"), - modifiedAt: new Date("2022-10-12T06:39:45.765Z"), + createdAt: new Date("2022-11-26T12:19:41.082Z"), + modifiedAt: new Date("2024-05-27T16:12:22.860Z"), id: "", - imageUrl: "https://lawful-millet.org", - imageUrlDark: "https://total-fort.org", + imageUrl: "https://lined-place.com", + imageUrlDark: "https://frail-whack.com/", text: "", - linkUrl: "https://internal-amnesty.net", + linkUrl: "https://average-finding.biz/", }, ], pagination: { - totalCount: 502106, - maxPage: 786189, + totalCount: 946808, + maxPage: 845154, }, dimensions: [ - 748023, + 382764, ], }, }; diff --git a/docs/models/operations/articlesexportrequest.md b/docs/models/operations/articlesexportrequest.md index 88bd8ac1..7a37aa65 100644 --- a/docs/models/operations/articlesexportrequest.md +++ b/docs/models/operations/articlesexportrequest.md @@ -6,7 +6,7 @@ import { ArticlesExportRequest } from "@polar-sh/sdk/models/operations"; let value: ArticlesExportRequest = { - organizationId: "fff1f37c-3921-4150-b6a6-1142f2c998f5", + organizationId: "142f2c99-8f5c-486f-a916-cbe4c79ffd5e", }; ``` diff --git a/docs/models/operations/articleslistresponse.md b/docs/models/operations/articleslistresponse.md index 5665076e..24aaded6 100644 --- a/docs/models/operations/articleslistresponse.md +++ b/docs/models/operations/articleslistresponse.md @@ -15,46 +15,45 @@ let value: ArticlesListResponse = { body: "", byline: { name: "", - avatarUrl: "https://vast-substitution.net", + avatarUrl: "https://negligible-singing.com/", }, visibility: "private", userId: "", organizationId: "", organization: { - createdAt: new Date("2022-10-30T20:46:20.876Z"), - modifiedAt: new Date("2023-02-09T23:56:49.919Z"), + createdAt: new Date("2022-02-15T03:11:35.631Z"), + modifiedAt: new Date("2024-06-13T19:08:19.699Z"), id: "", name: "", slug: "", - avatarUrl: "https://noteworthy-pigsty.biz/", + avatarUrl: "https://average-order.name", bio: "", - company: "Jacobi - Hackett", + company: "Cormier - Rutherford", blog: "", location: "", - email: "Shyanne54@hotmail.com", + email: "Willy_Zemlak-Carter@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 98610, + pledgeMinimumAmount: 757407, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 801075, - donationsEnabled: false, + defaultUpfrontSplitToContributors: 203621, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2022-02-15T03:11:35.631Z"), + publishedAt: new Date("2023-09-13T16:15:37.701Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2024-06-13T19:08:19.699Z"), + paidSubscribersOnlyEndsAt: new Date("2022-07-23T15:43:25.483Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2024-06-04T02:09:29.897Z"), - emailSentToCount: 51007, - ogImageUrl: "https://meager-comestible.com", + notificationsSentAt: new Date("2022-04-25T18:58:42.780Z"), + emailSentToCount: 116558, + ogImageUrl: "https://accomplished-hippodrome.name/", ogDescription: "", }, ], pagination: { - totalCount: 773259, - maxPage: 567693, + totalCount: 401688, + maxPage: 85794, }, }, }; diff --git a/docs/models/operations/articlespreviewrequest.md b/docs/models/operations/articlespreviewrequest.md index 806d62b1..d0f98c83 100644 --- a/docs/models/operations/articlespreviewrequest.md +++ b/docs/models/operations/articlespreviewrequest.md @@ -8,7 +8,7 @@ import { ArticlesPreviewRequest } from "@polar-sh/sdk/models/operations"; let value: ArticlesPreviewRequest = { id: "", articlePreview: { - email: "Gonzalo78@yahoo.com", + email: "Alford74@yahoo.com", }, }; ``` diff --git a/docs/models/operations/articlevisibilityfilter.md b/docs/models/operations/articlevisibilityfilter.md index 7d048fb4..161f769b 100644 --- a/docs/models/operations/articlevisibilityfilter.md +++ b/docs/models/operations/articlevisibilityfilter.md @@ -8,14 +8,14 @@ Filter by visibility. ### `components.ArticleVisibility` ```typescript -const value: components.ArticleVisibility = "hidden"; +const value: components.ArticleVisibility = "private"; ``` ### `components.ArticleVisibility[]` ```typescript const value: components.ArticleVisibility[] = [ - "private", + "hidden", ]; ``` diff --git a/docs/models/operations/benefitscreatebenefitcreate.md b/docs/models/operations/benefitscreatebenefitcreate.md index 325b945a..ad3dcb3c 100644 --- a/docs/models/operations/benefitscreatebenefitcreate.md +++ b/docs/models/operations/benefitscreatebenefitcreate.md @@ -7,8 +7,7 @@ ```typescript const value: components.BenefitCustomCreate = { - description: - "beneath irritably provided sorrowful furthermore lest besides sniveling close whoa", + description: "aboard barring alongside mortar gadzooks", isTaxApplicable: false, properties: {}, }; @@ -18,7 +17,7 @@ const value: components.BenefitCustomCreate = { ```typescript const value: components.BenefitAdsCreate = { - description: "alongside mortar gadzooks headline service", + description: "presume times mysterious soggy onto until", properties: {}, }; ``` @@ -28,7 +27,7 @@ const value: components.BenefitAdsCreate = { ```typescript const value: components.BenefitDiscordCreate = { description: - "mysterious soggy onto until oof hateful faithfully steel promptly", + "longboat synthesise lively nervous save uncommon likewise separately content", properties: { guildToken: "", roleId: "", @@ -40,12 +39,11 @@ const value: components.BenefitDiscordCreate = { ```typescript const value: components.BenefitGitHubRepositoryCreate = { - description: - "uncommon likewise separately content to as needily near relative", + description: "straight innocently management plus", properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "triage", }, }; ``` @@ -54,8 +52,7 @@ const value: components.BenefitGitHubRepositoryCreate = { ```typescript const value: components.BenefitDownloadablesCreate = { - description: - "oval enormously vastly capsize supposing immediately terrible joint nervously", + description: "sans annual before hotfoot pulp", properties: { files: [ "", @@ -68,7 +65,7 @@ const value: components.BenefitDownloadablesCreate = { ```typescript const value: components.BenefitLicenseKeysCreate = { - description: "far exalted marten save above hourly", + description: "vengeful gee funny brief where daintily role infatuated ew", properties: {}, }; ``` diff --git a/docs/models/operations/benefitsgrantsresponse.md b/docs/models/operations/benefitsgrantsresponse.md index 831e022d..57fa6972 100644 --- a/docs/models/operations/benefitsgrantsresponse.md +++ b/docs/models/operations/benefitsgrantsresponse.md @@ -9,8 +9,8 @@ let value: BenefitsGrantsResponse = { result: { items: [ { - createdAt: new Date("2024-04-21T03:25:09.956Z"), - modifiedAt: new Date("2023-07-21T10:46:34.659Z"), + createdAt: new Date("2024-06-15T14:42:11.992Z"), + modifiedAt: new Date("2023-11-05T07:45:54.269Z"), id: "", isGranted: false, isRevoked: false, @@ -22,8 +22,8 @@ let value: BenefitsGrantsResponse = { }, ], pagination: { - totalCount: 144058, - maxPage: 899652, + totalCount: 44252, + maxPage: 431258, }, }, }; diff --git a/docs/models/operations/benefitslistresponse.md b/docs/models/operations/benefitslistresponse.md index f5d826be..de7cc5a7 100644 --- a/docs/models/operations/benefitslistresponse.md +++ b/docs/models/operations/benefitslistresponse.md @@ -9,30 +9,21 @@ let value: BenefitsListResponse = { result: { items: [ { - createdAt: new Date("2022-04-20T20:32:25.216Z"), - modifiedAt: new Date("2024-08-08T08:34:51.248Z"), + createdAt: new Date("2022-06-11T13:12:44.267Z"), + modifiedAt: new Date("2024-04-08T21:22:45.615Z"), id: "", - description: "while unless after vainly scoop", + description: "intermarry colonialism worthy", selectable: false, deletable: false, organizationId: "", properties: { - prefix: "", - expires: { - ttl: 527715, - timeframe: "year", - }, - activations: { - limit: 271306, - enableUserAdmin: false, - }, - limitUsage: 258059, + paidArticles: false, }, }, ], pagination: { - totalCount: 532320, - maxPage: 703189, + totalCount: 887284, + maxPage: 765070, }, }, }; diff --git a/docs/models/operations/benefitsupdatebenefitupdate.md b/docs/models/operations/benefitsupdatebenefitupdate.md index d8e1aa1c..598a0431 100644 --- a/docs/models/operations/benefitsupdatebenefitupdate.md +++ b/docs/models/operations/benefitsupdatebenefitupdate.md @@ -34,7 +34,7 @@ const value: components.BenefitGitHubRepositoryUpdate = { properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "pull", + permission: "triage", }, }; ``` diff --git a/docs/models/operations/checkoutlinkslistresponse.md b/docs/models/operations/checkoutlinkslistresponse.md index 67d7a028..2bef147c 100644 --- a/docs/models/operations/checkoutlinkslistresponse.md +++ b/docs/models/operations/checkoutlinkslistresponse.md @@ -9,29 +9,32 @@ let value: CheckoutLinksListResponse = { result: { items: [ { - createdAt: new Date("2023-09-20T09:43:49.938Z"), - modifiedAt: new Date("2022-09-04T08:32:34.245Z"), + createdAt: new Date("2023-08-02T18:40:01.314Z"), + modifiedAt: new Date("2024-05-28T04:41:45.730Z"), id: "", metadata: { "key": "", }, clientSecret: "", - successUrl: "https://noxious-pronoun.org", + successUrl: "https://fantastic-doorpost.net/", productPriceId: "", productPrice: { - createdAt: new Date("2022-01-08T23:31:11.246Z"), - modifiedAt: new Date("2022-02-06T14:44:43.529Z"), + createdAt: new Date("2022-01-12T14:26:50.258Z"), + modifiedAt: new Date("2024-11-23T13:27:52.601Z"), id: "", isArchived: false, productId: "", - recurringInterval: "year", + priceCurrency: "", + minimumAmount: 962024, + maximumAmount: 217552, + presetAmount: 41346, }, - url: "https://expert-dusk.biz/", + url: "https://well-documented-thread.name", }, ], pagination: { - totalCount: 728948, - maxPage: 569196, + totalCount: 303549, + maxPage: 329961, }, }, }; diff --git a/docs/models/operations/checkoutscustomlistresponse.md b/docs/models/operations/checkoutscustomlistresponse.md index 21c3f9ae..63da3a81 100644 --- a/docs/models/operations/checkoutscustomlistresponse.md +++ b/docs/models/operations/checkoutscustomlistresponse.md @@ -9,67 +9,63 @@ let value: CheckoutsCustomListResponse = { result: { items: [ { - createdAt: new Date("2024-02-27T21:23:27.554Z"), - modifiedAt: new Date("2024-06-23T22:42:29.938Z"), + createdAt: new Date("2022-05-18T04:15:08.103Z"), + modifiedAt: new Date("2024-11-22T18:34:24.377Z"), id: "", status: "succeeded", clientSecret: "", - url: "https://lavish-marathon.net", - expiresAt: new Date("2024-10-08T12:20:15.003Z"), - successUrl: "https://unhappy-premise.com", + url: "https://next-haversack.com/", + expiresAt: new Date("2022-06-27T15:10:04.073Z"), + successUrl: "https://frugal-tuxedo.com", embedOrigin: "", - amount: 500828, - taxAmount: 286486, - currency: "Falkland Islands Pound", - totalAmount: 355927, + amount: 460803, + taxAmount: 129619, + currency: "UAE Dirham", + totalAmount: 553766, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Kolby.Glover@gmail.com", + customerEmail: "Mireya_Dare72@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Christmas Island", + country: "Pitcairn Islands", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { - "key": "", + "key": false, }, product: { - createdAt: new Date("2022-01-11T03:15:33.264Z"), - modifiedAt: new Date("2024-10-13T19:37:01.195Z"), + createdAt: new Date("2023-01-11T01:55:17.102Z"), + modifiedAt: new Date("2023-02-16T15:28:53.569Z"), id: "", name: "", - description: "yahoo phooey yuck playfully commonly huzzah after", + description: "likewise live even dredger hourly", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-03-02T08:07:59.742Z"), - modifiedAt: new Date("2024-02-05T03:15:11.328Z"), + createdAt: new Date("2023-01-19T19:42:43.719Z"), + modifiedAt: new Date("2022-10-21T17:10:27.496Z"), id: "", isArchived: false, productId: "", - priceCurrency: "", - priceAmount: 176333, }, ], benefits: [ { - createdAt: new Date("2024-03-01T06:19:32.936Z"), - modifiedAt: new Date("2022-11-23T13:48:35.382Z"), + createdAt: new Date("2024-06-19T03:34:00.039Z"), + modifiedAt: new Date("2023-02-21T02:44:46.039Z"), id: "", + type: "github_repository", description: - "deep from supposing drowse intent foodstuffs a impartial", + "within versus upon amid jubilantly dark machine entice ah excepting", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -79,36 +75,37 @@ let value: CheckoutsCustomListResponse = { name: "", path: "/sys", mimeType: "", - size: 63369, + size: 545629, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-03-26T04:53:25.304Z"), + lastModifiedAt: new Date("2024-12-04T07:07:12.134Z"), version: "", isUploaded: false, - createdAt: new Date("2024-03-02T20:38:32.287Z"), + createdAt: new Date("2024-01-16T16:27:33.018Z"), sizeReadable: "", - publicUrl: "https://wavy-pocket-watch.biz/", + publicUrl: "https://wide-hawk.info", }, ], }, productPrice: { - createdAt: new Date("2024-12-04T08:27:59.075Z"), - modifiedAt: new Date("2022-02-24T00:23:58.036Z"), + createdAt: new Date("2022-09-17T23:02:09.893Z"), + modifiedAt: new Date("2022-07-21T02:54:05.406Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 933456, + priceAmount: 754784, + recurringInterval: "year", }, subscriptionId: "", attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2024-04-10T13:48:19.184Z"), - modifiedAt: new Date("2022-01-01T01:56:18.923Z"), + createdAt: new Date("2024-06-18T05:26:12.044Z"), + modifiedAt: new Date("2022-09-10T22:16:39.905Z"), id: "", metadata: { "key": "", @@ -116,17 +113,24 @@ let value: CheckoutsCustomListResponse = { slug: "", name: "", organizationId: "", - properties: {}, + properties: { + options: [ + { + value: "", + label: "", + }, + ], + }, }, - order: 254240, + order: 708360, required: false, }, ], }, ], pagination: { - totalCount: 749101, - maxPage: 532336, + totalCount: 392759, + maxPage: 29270, }, }, }; diff --git a/docs/models/operations/customfieldslistresponse.md b/docs/models/operations/customfieldslistresponse.md index 98ce22ea..0d8febf5 100644 --- a/docs/models/operations/customfieldslistresponse.md +++ b/docs/models/operations/customfieldslistresponse.md @@ -9,8 +9,8 @@ let value: CustomFieldsListResponse = { result: { items: [ { - createdAt: new Date("2023-03-31T10:47:58.920Z"), - modifiedAt: new Date("2023-04-07T17:10:31.500Z"), + createdAt: new Date("2022-09-30T06:35:01.392Z"), + modifiedAt: new Date("2022-10-31T08:48:47.117Z"), id: "", metadata: { "key": "", @@ -22,8 +22,8 @@ let value: CustomFieldsListResponse = { }, ], pagination: { - totalCount: 926266, - maxPage: 661764, + totalCount: 463044, + maxPage: 916051, }, }, }; diff --git a/docs/models/operations/customfieldtypefilter.md b/docs/models/operations/customfieldtypefilter.md index 61ffe336..4f605cfb 100644 --- a/docs/models/operations/customfieldtypefilter.md +++ b/docs/models/operations/customfieldtypefilter.md @@ -8,14 +8,14 @@ Filter by custom field type. ### `components.CustomFieldType` ```typescript -const value: components.CustomFieldType = "checkbox"; +const value: components.CustomFieldType = "select"; ``` ### `components.CustomFieldType[]` ```typescript const value: components.CustomFieldType[] = [ - "select", + "date", ]; ``` diff --git a/docs/models/operations/filescreatefilecreate.md b/docs/models/operations/filescreatefilecreate.md index 3b6fc925..ff8cdb07 100644 --- a/docs/models/operations/filescreatefilecreate.md +++ b/docs/models/operations/filescreatefilecreate.md @@ -9,13 +9,13 @@ const value: components.DownloadableFileCreate = { name: "", mimeType: "", - size: 392022, + size: 217275, upload: { parts: [ { - number: 143976, - chunkStart: 804823, - chunkEnd: 713371, + number: 114924, + chunkStart: 724073, + chunkEnd: 203396, }, ], }, @@ -28,13 +28,13 @@ const value: components.DownloadableFileCreate = { const value: components.ProductMediaFileCreate = { name: "", mimeType: "", - size: 408677, + size: 176104, upload: { parts: [ { - number: 518432, - chunkStart: 665183, - chunkEnd: 164805, + number: 319807, + chunkStart: 816825, + chunkEnd: 539537, }, ], }, @@ -47,13 +47,13 @@ const value: components.ProductMediaFileCreate = { const value: components.OrganizationAvatarFileCreate = { name: "", mimeType: "", - size: 27197, + size: 45850, upload: { parts: [ { - number: 317504, - chunkStart: 595585, - chunkEnd: 486606, + number: 463895, + chunkStart: 683980, + chunkEnd: 538368, }, ], }, diff --git a/docs/models/operations/fileslistresponse.md b/docs/models/operations/fileslistresponse.md index b07a5416..b43f2649 100644 --- a/docs/models/operations/fileslistresponse.md +++ b/docs/models/operations/fileslistresponse.md @@ -12,23 +12,24 @@ let value: FilesListResponse = { id: "", organizationId: "", name: "", - path: "/opt/include", + path: "/var", mimeType: "", - size: 375549, + size: 409021, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-09-15T16:56:22.815Z"), + lastModifiedAt: new Date("2022-12-31T03:28:31.793Z"), version: "", isUploaded: false, - createdAt: new Date("2024-01-03T02:28:08.091Z"), + createdAt: new Date("2024-12-20T12:28:04.015Z"), sizeReadable: "", + publicUrl: "https://helpful-brochure.net", }, ], pagination: { - totalCount: 840831, - maxPage: 497231, + totalCount: 708075, + maxPage: 921916, }, }, }; diff --git a/docs/models/operations/filesupdateresponsefilesupdate.md b/docs/models/operations/filesupdateresponsefilesupdate.md index e4fecd96..a45d2897 100644 --- a/docs/models/operations/filesupdateresponsefilesupdate.md +++ b/docs/models/operations/filesupdateresponsefilesupdate.md @@ -12,17 +12,17 @@ const value: components.DownloadableFileRead = { id: "", organizationId: "", name: "", - path: "/home/user/dir", + path: "/var/log", mimeType: "", - size: 426691, + size: 661764, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-11-01T02:19:19.164Z"), + lastModifiedAt: new Date("2022-03-30T04:36:31.706Z"), version: "", isUploaded: false, - createdAt: new Date("2023-08-22T00:13:23.635Z"), + createdAt: new Date("2023-08-18T05:41:08.306Z"), sizeReadable: "", }; ``` @@ -34,19 +34,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/var/tmp", + path: "/opt", mimeType: "", - size: 680370, + size: 987435, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-03-21T23:32:45.423Z"), + lastModifiedAt: new Date("2022-01-15T23:11:30.521Z"), version: "", isUploaded: false, - createdAt: new Date("2024-11-25T18:48:33.320Z"), + createdAt: new Date("2023-11-02T22:48:20.467Z"), sizeReadable: "", - publicUrl: "https://happy-go-lucky-approach.biz/", + publicUrl: "https://formal-volleyball.org", }; ``` @@ -57,19 +57,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/lib", + path: "/var", mimeType: "", - size: 183504, + size: 19232, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-04-07T05:50:07.896Z"), + lastModifiedAt: new Date("2023-09-17T13:55:01.446Z"), version: "", isUploaded: false, - createdAt: new Date("2023-08-11T07:51:57.382Z"), + createdAt: new Date("2022-11-19T22:28:47.872Z"), sizeReadable: "", - publicUrl: "https://sugary-defendant.biz", + publicUrl: "https://pretty-lyre.com", }; ``` diff --git a/docs/models/operations/filesuploadedrequest.md b/docs/models/operations/filesuploadedrequest.md index a69400f1..7b1de746 100644 --- a/docs/models/operations/filesuploadedrequest.md +++ b/docs/models/operations/filesuploadedrequest.md @@ -9,10 +9,10 @@ let value: FilesUploadedRequest = { id: "", fileUploadCompleted: { id: "", - path: "/usr/X11R6", + path: "/selinux", parts: [ { - number: 819690, + number: 224777, checksumEtag: "", checksumSha256Base64: "", }, diff --git a/docs/models/operations/filesuploadedresponsefilesuploaded.md b/docs/models/operations/filesuploadedresponsefilesuploaded.md index 90a98072..89fdd897 100644 --- a/docs/models/operations/filesuploadedresponsefilesuploaded.md +++ b/docs/models/operations/filesuploadedresponsefilesuploaded.md @@ -12,17 +12,17 @@ const value: components.DownloadableFileRead = { id: "", organizationId: "", name: "", - path: "/private/var", + path: "/usr/ports", mimeType: "", - size: 134267, + size: 561399, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-07-21T06:55:08.065Z"), + lastModifiedAt: new Date("2024-02-21T17:13:23.257Z"), version: "", isUploaded: false, - createdAt: new Date("2023-09-23T04:32:44.047Z"), + createdAt: new Date("2024-12-12T02:57:22.912Z"), sizeReadable: "", }; ``` @@ -34,19 +34,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/usr/lib", + path: "/opt/sbin", mimeType: "", - size: 704665, + size: 881067, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-11-27T03:50:32.760Z"), + lastModifiedAt: new Date("2022-01-08T23:31:11.246Z"), version: "", isUploaded: false, - createdAt: new Date("2022-11-20T15:45:49.704Z"), + createdAt: new Date("2022-02-06T14:44:43.529Z"), sizeReadable: "", - publicUrl: "https://helpful-gray.biz", + publicUrl: "https://general-digestive.biz", }; ``` @@ -57,19 +57,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/Network", + path: "/net", mimeType: "", - size: 948297, + size: 728948, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-11-17T15:47:00.809Z"), + lastModifiedAt: new Date("2023-09-16T20:07:51.073Z"), version: "", isUploaded: false, - createdAt: new Date("2022-09-27T14:32:12.836Z"), + createdAt: new Date("2024-05-14T18:48:08.000Z"), sizeReadable: "", - publicUrl: "https://far-flung-intellect.org", + publicUrl: "https://tender-hawk.info", }; ``` diff --git a/docs/models/operations/licensekeyslistqueryparambenefitidfilter.md b/docs/models/operations/licensekeyslistqueryparambenefitidfilter.md new file mode 100644 index 00000000..24cf9977 --- /dev/null +++ b/docs/models/operations/licensekeyslistqueryparambenefitidfilter.md @@ -0,0 +1,21 @@ +# LicenseKeysListQueryParamBenefitIDFilter + +Filter by benefit ID. + + +## Supported Types + +### `string` + +```typescript +const value: string = ""; +``` + +### `string[]` + +```typescript +const value: string[] = [ + "", +]; +``` + diff --git a/docs/models/operations/licensekeyslistrequest.md b/docs/models/operations/licensekeyslistrequest.md index 19ddf014..b041d60b 100644 --- a/docs/models/operations/licensekeyslistrequest.md +++ b/docs/models/operations/licensekeyslistrequest.md @@ -13,5 +13,6 @@ let value: LicenseKeysListRequest = {}; | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `organizationId` | *operations.LicenseKeysListQueryParamOrganizationIDFilter* | :heavy_minus_sign: | Filter by organization ID. | +| `benefitId` | *operations.LicenseKeysListQueryParamBenefitIDFilter* | :heavy_minus_sign: | Filter by benefit ID. | | `page` | *number* | :heavy_minus_sign: | Page number, defaults to 1. | | `limit` | *number* | :heavy_minus_sign: | Size of a page, defaults to 10. Maximum is 100. | \ No newline at end of file diff --git a/docs/models/operations/licensekeyslistresponse.md b/docs/models/operations/licensekeyslistresponse.md index bf19ac4a..a21e1266 100644 --- a/docs/models/operations/licensekeyslistresponse.md +++ b/docs/models/operations/licensekeyslistresponse.md @@ -15,24 +15,24 @@ let value: LicenseKeysListResponse = { user: { id: "", publicName: "", - email: "Esta78@yahoo.com", - avatarUrl: "https://educated-cappelletti.net", + email: "Mabelle_Konopelski2@hotmail.com", + avatarUrl: "https://slushy-flat.name/", }, benefitId: "", key: "", displayKey: "", - status: "granted", - limitActivations: 176104, - usage: 319807, - limitUsage: 816825, - validations: 539537, - lastValidatedAt: new Date("2022-02-20T06:02:51.866Z"), - expiresAt: new Date("2023-05-24T10:17:07.880Z"), + status: "revoked", + limitActivations: 385828, + usage: 531568, + limitUsage: 645139, + validations: 940951, + lastValidatedAt: new Date("2023-09-23T21:28:43.149Z"), + expiresAt: new Date("2023-11-05T08:19:22.907Z"), }, ], pagination: { - totalCount: 683980, - maxPage: 538368, + totalCount: 67855, + maxPage: 952216, }, }, }; diff --git a/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md b/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md index 4287e57d..26bd428f 100644 --- a/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md +++ b/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md @@ -15,7 +15,7 @@ const value: components.ProductPriceType = "recurring"; ```typescript const value: components.ProductPriceType[] = [ - "one_time", + "recurring", ]; ``` diff --git a/docs/models/operations/metricsgetrequest.md b/docs/models/operations/metricsgetrequest.md index fc562eb0..a309ade3 100644 --- a/docs/models/operations/metricsgetrequest.md +++ b/docs/models/operations/metricsgetrequest.md @@ -7,8 +7,8 @@ import { MetricsGetRequest } from "@polar-sh/sdk/models/operations"; import { RFCDate } from "@polar-sh/sdk/types"; let value: MetricsGetRequest = { - startDate: new RFCDate("2022-02-02"), - endDate: new RFCDate("2023-04-22"), + startDate: new RFCDate("2024-11-13"), + endDate: new RFCDate("2023-10-04"), interval: "hour", }; ``` diff --git a/docs/models/operations/oauth2authorizeresponseoauth2authorize.md b/docs/models/operations/oauth2authorizeresponseoauth2authorize.md new file mode 100644 index 00000000..e04cc49f --- /dev/null +++ b/docs/models/operations/oauth2authorizeresponseoauth2authorize.md @@ -0,0 +1,64 @@ +# Oauth2AuthorizeResponseOauth2Authorize + +Successful Response + + +## Supported Types + +### `components.AuthorizeResponseUser` + +```typescript +const value: components.AuthorizeResponseUser = { + client: { + createdAt: new Date("2022-01-28T03:31:31.089Z"), + modifiedAt: new Date("2024-06-29T19:26:32.721Z"), + clientId: "", + clientName: "", + clientUri: "https://crooked-yin.com", + logoUri: "https://free-hubris.net", + tosUri: "https://warm-omelet.com", + policyUri: "https://soggy-prohibition.com", + }, + sub: { + id: "", + email: "Catharine96@yahoo.com", + avatarUrl: "https://pleasing-angle.com", + }, + scopes: [ + "products:read", + ], +}; +``` + +### `components.AuthorizeResponseOrganization` + +```typescript +const value: components.AuthorizeResponseOrganization = { + client: { + createdAt: new Date("2024-06-21T12:36:00.354Z"), + modifiedAt: new Date("2024-08-07T06:48:26.335Z"), + clientId: "", + clientName: "", + clientUri: "https://big-apricot.org", + logoUri: "https://nocturnal-whack.info/", + tosUri: "https://impolite-rule.name", + policyUri: "https://firm-disk.name/", + }, + sub: { + id: "", + slug: "", + avatarUrl: "https://weighty-populist.net", + }, + scopes: [ + "organizations:write", + ], + organizations: [ + { + id: "", + slug: "", + avatarUrl: "https://indolent-pocket-watch.biz/", + }, + ], +}; +``` + diff --git a/docs/models/operations/oauth2clientslistresponse.md b/docs/models/operations/oauth2clientslistresponse.md index 48c65f59..bb602768 100644 --- a/docs/models/operations/oauth2clientslistresponse.md +++ b/docs/models/operations/oauth2clientslistresponse.md @@ -10,20 +10,20 @@ let value: Oauth2ClientsListResponse = { items: [ { redirectUris: [ - "https://carefree-embarrassment.org/", + "https://snoopy-polarisation.net/", ], clientName: "", - createdAt: new Date("2022-06-03T03:52:22.682Z"), - modifiedAt: new Date("2022-12-29T08:00:18.342Z"), + createdAt: new Date("2024-04-20T20:41:36.879Z"), + modifiedAt: new Date("2022-11-11T17:15:53.855Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 51053, - clientSecretExpiresAt: 331269, + clientIdIssuedAt: 548256, + clientSecretExpiresAt: 543353, }, ], pagination: { - totalCount: 320326, - maxPage: 946808, + totalCount: 739633, + maxPage: 956871, }, }, }; diff --git a/docs/models/operations/oauth2clientsoauth2updateclientrequest.md b/docs/models/operations/oauth2clientsoauth2updateclientrequest.md index 351d28c4..7624aeb4 100644 --- a/docs/models/operations/oauth2clientsoauth2updateclientrequest.md +++ b/docs/models/operations/oauth2clientsoauth2updateclientrequest.md @@ -9,7 +9,7 @@ let value: Oauth2ClientsOauth2UpdateClientRequest = { clientId: "", oAuth2ClientConfigurationUpdate: { redirectUris: [ - "https://icy-airmail.net", + "https://staid-permafrost.name/", ], clientName: "", clientId: "", diff --git a/docs/models/operations/oauth2introspecttokentokentypehint.md b/docs/models/operations/oauth2introspecttokentokentypehint.md index fce2a6ac..f6bfc5f0 100644 --- a/docs/models/operations/oauth2introspecttokentokentypehint.md +++ b/docs/models/operations/oauth2introspecttokentokentypehint.md @@ -5,7 +5,7 @@ ```typescript import { Oauth2IntrospectTokenTokenTypeHint } from "@polar-sh/sdk/models/operations"; -let value: Oauth2IntrospectTokenTokenTypeHint = "refresh_token"; +let value: Oauth2IntrospectTokenTokenTypeHint = "access_token"; ``` ## Values diff --git a/docs/models/operations/oauth2requesttokenrequestbody.md b/docs/models/operations/oauth2requesttokenrequestbody.md index 74390fdc..e2ab9990 100644 --- a/docs/models/operations/oauth2requesttokenrequestbody.md +++ b/docs/models/operations/oauth2requesttokenrequestbody.md @@ -11,7 +11,7 @@ const value: clientId: "", clientSecret: "", code: "", - redirectUri: "https://frivolous-self-confidence.name", + redirectUri: "https://happy-go-lucky-siege.name/", }; ``` diff --git a/docs/models/operations/orderslistresponse.md b/docs/models/operations/orderslistresponse.md index 435877c0..792239ef 100644 --- a/docs/models/operations/orderslistresponse.md +++ b/docs/models/operations/orderslistresponse.md @@ -9,16 +9,16 @@ let value: OrdersListResponse = { result: { items: [ { - createdAt: new Date("2023-11-14T18:33:31.564Z"), - modifiedAt: new Date("2024-11-13T17:37:04.407Z"), + createdAt: new Date("2022-08-22T02:23:53.093Z"), + modifiedAt: new Date("2023-06-07T08:51:38.406Z"), id: "", metadata: { "key": "", }, - amount: 958280, - taxAmount: 824267, - currency: "Metical", - billingReason: "subscription_create", + amount: 321422, + taxAmount: 284779, + currency: "Riel", + billingReason: "subscription_update", userId: "", productId: "", productPriceId: "", @@ -26,47 +26,50 @@ let value: OrdersListResponse = { checkoutId: "", user: { id: "", - email: "Lemuel78@gmail.com", + email: "Gretchen.West91@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://turbulent-marten.com", + avatarUrl: "https://lanky-cruelty.info/", }, product: { - createdAt: new Date("2023-06-14T22:00:04.745Z"), - modifiedAt: new Date("2022-12-10T19:26:04.923Z"), + createdAt: new Date("2023-05-13T18:21:47.587Z"), + modifiedAt: new Date("2024-08-06T06:31:20.354Z"), id: "", name: "", - description: "task whenever below certification drat corral snowplow", + description: + "license cheerfully repeatedly replicate jell black till transcend before rarely", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2022-04-02T13:11:18.964Z"), - modifiedAt: new Date("2024-10-24T02:05:02.156Z"), + createdAt: new Date("2024-11-01T01:36:21.641Z"), + modifiedAt: new Date("2022-06-25T15:28:36.981Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 118020, + minimumAmount: 729612, + maximumAmount: 609094, + presetAmount: 185116, recurringInterval: "month", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2024-08-03T11:34:04.757Z"), - modifiedAt: new Date("2022-10-06T16:47:41.923Z"), + createdAt: new Date("2023-08-07T04:09:31.431Z"), + modifiedAt: new Date("2024-10-30T06:52:10.521Z"), id: "", - amount: 665952, - currency: "Lilangeni", - recurringInterval: "year", - status: "unpaid", - currentPeriodStart: new Date("2024-02-16T22:27:20.816Z"), - currentPeriodEnd: new Date("2022-05-04T13:48:56.579Z"), + amount: 644299, + currency: "Russian Ruble", + recurringInterval: "month", + status: "past_due", + currentPeriodStart: new Date("2022-05-19T11:58:16.990Z"), + currentPeriodEnd: new Date("2024-08-18T23:53:22.557Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-09-05T00:25:02.418Z"), - endedAt: new Date("2024-02-27T03:10:42.176Z"), + startedAt: new Date("2024-04-13T19:53:21.496Z"), + endedAt: new Date("2024-12-30T00:37:30.921Z"), userId: "", productId: "", priceId: "", @@ -75,8 +78,8 @@ let value: OrdersListResponse = { }, ], pagination: { - totalCount: 801958, - maxPage: 26321, + totalCount: 297723, + maxPage: 227017, }, }, }; diff --git a/docs/models/operations/organizationslistresponse.md b/docs/models/operations/organizationslistresponse.md index 94e73516..988931b0 100644 --- a/docs/models/operations/organizationslistresponse.md +++ b/docs/models/operations/organizationslistresponse.md @@ -24,7 +24,6 @@ let value: OrganizationsListResponse = { pledgeMinimumAmount: 254382, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 265303, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/operations/productscreateproductcreate.md b/docs/models/operations/productscreateproductcreate.md index 97432ebe..c4dd2acf 100644 --- a/docs/models/operations/productscreateproductcreate.md +++ b/docs/models/operations/productscreateproductcreate.md @@ -10,8 +10,8 @@ const value: components.ProductRecurringCreate = { name: "", prices: [ { - priceAmount: 502509, - recurringInterval: "month", + priceAmount: 201966, + recurringInterval: "year", }, ], }; diff --git a/docs/models/operations/productslistresponse.md b/docs/models/operations/productslistresponse.md index fe1ca04d..9bb24561 100644 --- a/docs/models/operations/productslistresponse.md +++ b/docs/models/operations/productslistresponse.md @@ -9,44 +9,44 @@ let value: ProductsListResponse = { result: { items: [ { - createdAt: new Date("2022-05-08T15:26:57.975Z"), - modifiedAt: new Date("2022-06-28T20:19:53.694Z"), + createdAt: new Date("2024-01-08T04:47:03.376Z"), + modifiedAt: new Date("2024-06-27T00:21:02.962Z"), id: "", name: "", - description: "spew ick fondly aside cake uh-huh while instead", + description: + "psst before anguished emergent upward rival inasmuch uh-huh the", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": "", + }, prices: [ { - createdAt: new Date("2022-06-19T06:00:22.932Z"), - modifiedAt: new Date("2022-12-09T16:59:37.115Z"), + createdAt: new Date("2022-10-24T10:38:09.514Z"), + modifiedAt: new Date("2023-11-07T08:04:38.587Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 884325, - maximumAmount: 958533, - presetAmount: 207512, + priceAmount: 384273, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2022-10-27T14:09:54.597Z"), - modifiedAt: new Date("2024-08-30T07:06:29.227Z"), + createdAt: new Date("2022-06-19T06:00:22.932Z"), + modifiedAt: new Date("2022-12-09T16:59:37.115Z"), id: "", - description: "forenenst lazily afore spring", + description: + "pick than heavily speedily out snow fencing vice yet sushi", selectable: false, deletable: false, organizationId: "", properties: { - archived: { - "key": false, - }, - files: [ - "", - ], + note: "", }, + isTaxApplicable: false, }, ], medias: [ @@ -54,45 +54,45 @@ let value: ProductsListResponse = { id: "", organizationId: "", name: "", - path: "/Users", + path: "/sbin", mimeType: "", - size: 59023, + size: 101284, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-06-07T20:03:48.485Z"), + lastModifiedAt: new Date("2023-06-14T22:00:04.745Z"), version: "", isUploaded: false, - createdAt: new Date("2023-11-20T00:29:10.889Z"), + createdAt: new Date("2022-12-10T19:26:04.923Z"), sizeReadable: "", - publicUrl: "https://simplistic-meander.org", + publicUrl: "https://frizzy-straw.org", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2023-08-23T10:58:27.936Z"), - modifiedAt: new Date("2022-11-18T19:17:48.581Z"), + createdAt: new Date("2023-10-20T03:23:15.846Z"), + modifiedAt: new Date("2023-04-17T11:28:38.206Z"), id: "", metadata: { - "key": "", + "key": false, }, slug: "", name: "", organizationId: "", properties: {}, }, - order: 968205, + order: 187361, required: false, }, ], }, ], pagination: { - totalCount: 226196, - maxPage: 15738, + totalCount: 697729, + maxPage: 970376, }, }, }; diff --git a/docs/models/operations/queryparambenefittypefilter.md b/docs/models/operations/queryparambenefittypefilter.md index 0c0621da..b511c9f8 100644 --- a/docs/models/operations/queryparambenefittypefilter.md +++ b/docs/models/operations/queryparambenefittypefilter.md @@ -8,14 +8,14 @@ Filter by benefit type. ### `components.BenefitType` ```typescript -const value: components.BenefitType = "github_repository"; +const value: components.BenefitType = "downloadables"; ``` ### `components.BenefitType[]` ```typescript const value: components.BenefitType[] = [ - "articles", + "license_keys", ]; ``` diff --git a/docs/models/operations/queryparamproductpricetypefilter.md b/docs/models/operations/queryparamproductpricetypefilter.md index f525d7c3..686a6ac7 100644 --- a/docs/models/operations/queryparamproductpricetypefilter.md +++ b/docs/models/operations/queryparamproductpricetypefilter.md @@ -8,7 +8,7 @@ Filter by product price type. `recurring` will return orders corresponding to su ### `components.ProductPriceType` ```typescript -const value: components.ProductPriceType = "recurring"; +const value: components.ProductPriceType = "one_time"; ``` ### `components.ProductPriceType[]` diff --git a/docs/models/operations/repositorieslistresponse.md b/docs/models/operations/repositorieslistresponse.md index 594353ca..dbd1849d 100644 --- a/docs/models/operations/repositorieslistresponse.md +++ b/docs/models/operations/repositorieslistresponse.md @@ -47,7 +47,6 @@ let value: RepositoriesListResponse = { pledgeMinimumAmount: 411615, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 489459, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/operations/subscriptionslistresponse.md b/docs/models/operations/subscriptionslistresponse.md index 066b7993..0369c843 100644 --- a/docs/models/operations/subscriptionslistresponse.md +++ b/docs/models/operations/subscriptionslistresponse.md @@ -29,45 +29,51 @@ let value: SubscriptionsListResponse = { "key": "", }, user: { - email: "Adrain_Gerhold23@gmail.com", + email: "Jayson31@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://second-mathematics.net", + avatarUrl: "https://normal-presume.info", }, product: { - createdAt: new Date("2023-04-04T19:49:26.614Z"), - modifiedAt: new Date("2022-01-06T19:40:31.772Z"), + createdAt: new Date("2022-01-06T19:40:31.772Z"), + modifiedAt: new Date("2022-01-13T10:41:07.081Z"), id: "", name: "", - description: "abnormally within whether", + description: "warmly that ocelot ouch marketplace minty coin", isRecurring: false, isArchived: false, organizationId: "", + metadata: { + "key": 262800, + }, prices: [ { - createdAt: new Date("2024-02-08T03:18:25.211Z"), - modifiedAt: new Date("2024-09-27T23:01:52.690Z"), + createdAt: new Date("2024-09-20T05:30:40.558Z"), + modifiedAt: new Date("2024-06-13T17:38:48.093Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - priceAmount: 524577, + priceAmount: 552581, }, ], benefits: [ { - createdAt: new Date("2022-05-12T19:46:31.016Z"), - modifiedAt: new Date("2024-04-07T08:55:07.116Z"), + createdAt: new Date("2024-11-20T18:50:24.078Z"), + modifiedAt: new Date("2022-05-02T03:10:42.322Z"), id: "", - description: - "beneath biodegradable failing step-mother amidst however astride until fabricate usefully", + description: "for graceful grouper at bah poorly so mmm", selectable: false, deletable: false, organizationId: "", properties: { - note: "", + archived: { + "key": false, + }, + files: [ + "", + ], }, - isTaxApplicable: false, }, ], medias: [ @@ -75,27 +81,27 @@ let value: SubscriptionsListResponse = { id: "", organizationId: "", name: "", - path: "/etc/defaults", + path: "/var/log", mimeType: "", - size: 18096, + size: 664666, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-10-10T06:45:28.118Z"), + lastModifiedAt: new Date("2023-04-09T16:01:26.379Z"), version: "", isUploaded: false, - createdAt: new Date("2023-04-23T08:13:17.912Z"), + createdAt: new Date("2022-08-07T02:15:27.661Z"), sizeReadable: "", - publicUrl: "https://vague-essence.info", + publicUrl: "https://sarcastic-patroller.org/", }, ], attachedCustomFields: [ { customFieldId: "", customField: { - createdAt: new Date("2023-10-07T14:44:09.655Z"), - modifiedAt: new Date("2024-12-14T07:17:28.090Z"), + createdAt: new Date("2024-06-13T12:01:45.796Z"), + modifiedAt: new Date("2024-09-25T22:48:13.771Z"), id: "", metadata: { "key": "", @@ -105,28 +111,28 @@ let value: SubscriptionsListResponse = { organizationId: "", properties: {}, }, - order: 697330, + order: 369523, required: false, }, ], }, price: { - createdAt: new Date("2022-10-17T02:08:42.808Z"), - modifiedAt: new Date("2024-11-01T07:26:05.631Z"), + createdAt: new Date("2023-09-07T06:05:32.228Z"), + modifiedAt: new Date("2024-01-03T08:48:44.316Z"), id: "", isArchived: false, productId: "", priceCurrency: "", - minimumAmount: 135548, - maximumAmount: 720266, - presetAmount: 925395, - recurringInterval: "year", + minimumAmount: 286716, + maximumAmount: 19462, + presetAmount: 399222, + recurringInterval: "month", }, }, ], pagination: { - totalCount: 423054, - maxPage: 198991, + totalCount: 942185, + maxPage: 888265, }, }, }; diff --git a/docs/models/operations/usersbenefitsgetresponseusersbenefitsget.md b/docs/models/operations/usersbenefitsgetresponseusersbenefitsget.md index 69e3e886..b24c229f 100644 --- a/docs/models/operations/usersbenefitsgetresponseusersbenefitsget.md +++ b/docs/models/operations/usersbenefitsgetresponseusersbenefitsget.md @@ -45,7 +45,6 @@ const value: components.BenefitArticlesSubscriber = { pledgeMinimumAmount: 660174, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 290077, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -96,7 +95,6 @@ const value: components.BenefitAdsSubscriber = { pledgeMinimumAmount: 31838, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 164694, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -144,7 +142,6 @@ const value: components.BenefitDiscordSubscriber = { pledgeMinimumAmount: 213312, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 518201, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -194,7 +191,6 @@ const value: components.BenefitCustomSubscriber = { pledgeMinimumAmount: 862192, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 972920, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -245,7 +241,6 @@ const value: components.BenefitGitHubRepositorySubscriber = { pledgeMinimumAmount: 575751, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 820767, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -296,7 +291,6 @@ const value: components.BenefitDownloadablesSubscriber = { pledgeMinimumAmount: 517309, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 424089, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, @@ -350,7 +344,6 @@ const value: components.BenefitLicenseKeysSubscriber = { pledgeMinimumAmount: 622385, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 710529, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/operations/usersbenefitslistresponse.md b/docs/models/operations/usersbenefitslistresponse.md index a369c1e3..be32a351 100644 --- a/docs/models/operations/usersbenefitslistresponse.md +++ b/docs/models/operations/usersbenefitslistresponse.md @@ -46,7 +46,6 @@ let value: UsersBenefitsListResponse = { pledgeMinimumAmount: 414263, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 64147, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/operations/usersorderslistresponse.md b/docs/models/operations/usersorderslistresponse.md index 89d265f7..3b4496ba 100644 --- a/docs/models/operations/usersorderslistresponse.md +++ b/docs/models/operations/usersorderslistresponse.md @@ -90,7 +90,6 @@ let value: UsersOrdersListResponse = { pledgeMinimumAmount: 399812, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 671384, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/models/operations/userssubscriptionslistresponse.md b/docs/models/operations/userssubscriptionslistresponse.md index c9cd9512..016ed447 100644 --- a/docs/models/operations/userssubscriptionslistresponse.md +++ b/docs/models/operations/userssubscriptionslistresponse.md @@ -91,7 +91,6 @@ let value: UsersSubscriptionsListResponse = { pledgeMinimumAmount: 975884, pledgeBadgeShowAmount: false, defaultUpfrontSplitToContributors: 932562, - donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, diff --git a/docs/sdks/oauth2/README.md b/docs/sdks/oauth2/README.md index 7d5b7148..e9826563 100644 --- a/docs/sdks/oauth2/README.md +++ b/docs/sdks/oauth2/README.md @@ -5,11 +5,83 @@ ### Available Operations +* [authorize](#authorize) - Authorize * [token](#token) - Request Token * [revoke](#revoke) - Revoke Token * [introspect](#introspect) - Introspect Token * [userinfo](#userinfo) - Get User Info +## authorize + +Authorize + +### Example Usage + +```typescript +import { Polar } from "@polar-sh/sdk"; + +const polar = new Polar({ + accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", +}); + +async function run() { + const result = await polar.oauth2.authorize(); + + // Handle the result + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { PolarCore } from "@polar-sh/sdk/core.js"; +import { oauth2Authorize } from "@polar-sh/sdk/funcs/oauth2Authorize.js"; + +// Use `PolarCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const polar = new PolarCore({ + accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", +}); + +async function run() { + const res = await oauth2Authorize(polar); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result); +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.Oauth2AuthorizeResponseOauth2Authorize](../../models/operations/oauth2authorizeresponseoauth2authorize.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------- | --------------- | --------------- | +| errors.SDKError | 4XX, 5XX | \*/\* | + ## token Request an access token using a valid grant. diff --git a/jsr.json b/jsr.json index b096bb12..3ab25a69 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@polar-sh/sdk", - "version": "0.15.1", + "version": "0.16.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 5a398763..aec51e3e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@polar-sh/sdk", - "version": "0.15.1", + "version": "0.16.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@polar-sh/sdk", - "version": "0.15.1", + "version": "0.16.0", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index e49613e9..d725340d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@polar-sh/sdk", - "version": "0.15.1", + "version": "0.16.0", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/advertisementsGet.ts b/src/funcs/advertisementsGet.ts index 22abe907..d2f2fc97 100644 --- a/src/funcs/advertisementsGet.ts +++ b/src/funcs/advertisementsGet.ts @@ -78,6 +78,9 @@ export async function advertisementsGet( const context = { operationID: "advertisements:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/advertisementsList.ts b/src/funcs/advertisementsList.ts index 918760d5..384c6bb9 100644 --- a/src/funcs/advertisementsList.ts +++ b/src/funcs/advertisementsList.ts @@ -85,6 +85,9 @@ export async function advertisementsList( const context = { operationID: "advertisements:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesCreate.ts b/src/funcs/articlesCreate.ts index 95c10d15..faccdaa8 100644 --- a/src/funcs/articlesCreate.ts +++ b/src/funcs/articlesCreate.ts @@ -70,6 +70,9 @@ export async function articlesCreate( const context = { operationID: "articles:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesDelete.ts b/src/funcs/articlesDelete.ts index 67681e7c..f7c95493 100644 --- a/src/funcs/articlesDelete.ts +++ b/src/funcs/articlesDelete.ts @@ -79,6 +79,9 @@ export async function articlesDelete( const context = { operationID: "articles:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesExport.ts b/src/funcs/articlesExport.ts index 4638931d..095018d4 100644 --- a/src/funcs/articlesExport.ts +++ b/src/funcs/articlesExport.ts @@ -74,6 +74,9 @@ export async function articlesExport( const context = { operationID: "articles:export", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesGet.ts b/src/funcs/articlesGet.ts index d6e79fa1..5ac0bf96 100644 --- a/src/funcs/articlesGet.ts +++ b/src/funcs/articlesGet.ts @@ -78,6 +78,9 @@ export async function articlesGet( const context = { operationID: "articles:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesList.ts b/src/funcs/articlesList.ts index e42e65e5..8bd2bf23 100644 --- a/src/funcs/articlesList.ts +++ b/src/funcs/articlesList.ts @@ -89,6 +89,9 @@ export async function articlesList( const context = { operationID: "articles:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesPreview.ts b/src/funcs/articlesPreview.ts index 00351424..24f8f7fa 100644 --- a/src/funcs/articlesPreview.ts +++ b/src/funcs/articlesPreview.ts @@ -80,6 +80,9 @@ export async function articlesPreview( const context = { operationID: "articles:preview", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesReceivers.ts b/src/funcs/articlesReceivers.ts index c0162ec1..8d0bbfd0 100644 --- a/src/funcs/articlesReceivers.ts +++ b/src/funcs/articlesReceivers.ts @@ -77,6 +77,9 @@ export async function articlesReceivers( const context = { operationID: "articles:receivers", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesSend.ts b/src/funcs/articlesSend.ts index 3564f154..b38d49ca 100644 --- a/src/funcs/articlesSend.ts +++ b/src/funcs/articlesSend.ts @@ -79,6 +79,9 @@ export async function articlesSend( const context = { operationID: "articles:send", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/articlesUpdate.ts b/src/funcs/articlesUpdate.ts index ba68444c..f0469e03 100644 --- a/src/funcs/articlesUpdate.ts +++ b/src/funcs/articlesUpdate.ts @@ -80,6 +80,9 @@ export async function articlesUpdate( const context = { operationID: "articles:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsCreate.ts b/src/funcs/benefitsCreate.ts index baa1d75d..e66c06c4 100644 --- a/src/funcs/benefitsCreate.ts +++ b/src/funcs/benefitsCreate.ts @@ -72,6 +72,9 @@ export async function benefitsCreate( const context = { operationID: "benefits:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsDelete.ts b/src/funcs/benefitsDelete.ts index 6fba957e..abbf04f5 100644 --- a/src/funcs/benefitsDelete.ts +++ b/src/funcs/benefitsDelete.ts @@ -83,6 +83,9 @@ export async function benefitsDelete( const context = { operationID: "benefits:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsGet.ts b/src/funcs/benefitsGet.ts index a5d25a92..cc617ecd 100644 --- a/src/funcs/benefitsGet.ts +++ b/src/funcs/benefitsGet.ts @@ -78,6 +78,9 @@ export async function benefitsGet( const context = { operationID: "benefits:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsGrants.ts b/src/funcs/benefitsGrants.ts index 14b3795c..f2796561 100644 --- a/src/funcs/benefitsGrants.ts +++ b/src/funcs/benefitsGrants.ts @@ -96,6 +96,9 @@ export async function benefitsGrants( const context = { operationID: "benefits:grants", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsList.ts b/src/funcs/benefitsList.ts index e2eb1772..a87f7a4c 100644 --- a/src/funcs/benefitsList.ts +++ b/src/funcs/benefitsList.ts @@ -85,6 +85,9 @@ export async function benefitsList( const context = { operationID: "benefits:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/benefitsUpdate.ts b/src/funcs/benefitsUpdate.ts index 0a0a89ac..fb0ba490 100644 --- a/src/funcs/benefitsUpdate.ts +++ b/src/funcs/benefitsUpdate.ts @@ -80,6 +80,9 @@ export async function benefitsUpdate( const context = { operationID: "benefits:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutLinksCreate.ts b/src/funcs/checkoutLinksCreate.ts index 76912f9d..95f9c6cd 100644 --- a/src/funcs/checkoutLinksCreate.ts +++ b/src/funcs/checkoutLinksCreate.ts @@ -70,6 +70,9 @@ export async function checkoutLinksCreate( const context = { operationID: "checkout-links:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutLinksDelete.ts b/src/funcs/checkoutLinksDelete.ts index 05fd635d..bc7e3a91 100644 --- a/src/funcs/checkoutLinksDelete.ts +++ b/src/funcs/checkoutLinksDelete.ts @@ -79,6 +79,9 @@ export async function checkoutLinksDelete( const context = { operationID: "checkout-links:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutLinksGet.ts b/src/funcs/checkoutLinksGet.ts index 65d3b56c..f259edd5 100644 --- a/src/funcs/checkoutLinksGet.ts +++ b/src/funcs/checkoutLinksGet.ts @@ -78,6 +78,9 @@ export async function checkoutLinksGet( const context = { operationID: "checkout-links:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutLinksList.ts b/src/funcs/checkoutLinksList.ts index 42852e79..43ca36a4 100644 --- a/src/funcs/checkoutLinksList.ts +++ b/src/funcs/checkoutLinksList.ts @@ -86,6 +86,9 @@ export async function checkoutLinksList( const context = { operationID: "checkout-links:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutLinksUpdate.ts b/src/funcs/checkoutLinksUpdate.ts index b07c2407..8d6ab093 100644 --- a/src/funcs/checkoutLinksUpdate.ts +++ b/src/funcs/checkoutLinksUpdate.ts @@ -82,6 +82,9 @@ export async function checkoutLinksUpdate( const context = { operationID: "checkout-links:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCreate.ts b/src/funcs/checkoutsCreate.ts index a5f490d0..f693c14e 100644 --- a/src/funcs/checkoutsCreate.ts +++ b/src/funcs/checkoutsCreate.ts @@ -75,6 +75,9 @@ export async function checkoutsCreate( const context = { operationID: "checkouts:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomClientConfirm.ts b/src/funcs/checkoutsCustomClientConfirm.ts index a04c050d..40540ee9 100644 --- a/src/funcs/checkoutsCustomClientConfirm.ts +++ b/src/funcs/checkoutsCustomClientConfirm.ts @@ -88,6 +88,9 @@ export async function checkoutsCustomClientConfirm( const context = { operationID: "checkouts:custom:client_confirm", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomClientGet.ts b/src/funcs/checkoutsCustomClientGet.ts index 835f5d80..9d487062 100644 --- a/src/funcs/checkoutsCustomClientGet.ts +++ b/src/funcs/checkoutsCustomClientGet.ts @@ -81,6 +81,9 @@ export async function checkoutsCustomClientGet( const context = { operationID: "checkouts:custom:client_get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomClientUpdate.ts b/src/funcs/checkoutsCustomClientUpdate.ts index 92a8b5a1..d306f556 100644 --- a/src/funcs/checkoutsCustomClientUpdate.ts +++ b/src/funcs/checkoutsCustomClientUpdate.ts @@ -84,6 +84,9 @@ export async function checkoutsCustomClientUpdate( const context = { operationID: "checkouts:custom:client_update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomCreate.ts b/src/funcs/checkoutsCustomCreate.ts index 92feeb18..645b213b 100644 --- a/src/funcs/checkoutsCustomCreate.ts +++ b/src/funcs/checkoutsCustomCreate.ts @@ -71,6 +71,9 @@ export async function checkoutsCustomCreate( const context = { operationID: "checkouts:custom:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomGet.ts b/src/funcs/checkoutsCustomGet.ts index f3b2c912..e2e8c494 100644 --- a/src/funcs/checkoutsCustomGet.ts +++ b/src/funcs/checkoutsCustomGet.ts @@ -78,6 +78,9 @@ export async function checkoutsCustomGet( const context = { operationID: "checkouts:custom:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomList.ts b/src/funcs/checkoutsCustomList.ts index e741359e..23f4c056 100644 --- a/src/funcs/checkoutsCustomList.ts +++ b/src/funcs/checkoutsCustomList.ts @@ -87,6 +87,9 @@ export async function checkoutsCustomList( const context = { operationID: "checkouts:custom:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsCustomUpdate.ts b/src/funcs/checkoutsCustomUpdate.ts index 46fee19b..472a07ef 100644 --- a/src/funcs/checkoutsCustomUpdate.ts +++ b/src/funcs/checkoutsCustomUpdate.ts @@ -80,6 +80,9 @@ export async function checkoutsCustomUpdate( const context = { operationID: "checkouts:custom:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/checkoutsGet.ts b/src/funcs/checkoutsGet.ts index 72390afb..72dc7da2 100644 --- a/src/funcs/checkoutsGet.ts +++ b/src/funcs/checkoutsGet.ts @@ -79,6 +79,9 @@ export async function checkoutsGet( const context = { operationID: "checkouts:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/customFieldsCreate.ts b/src/funcs/customFieldsCreate.ts index a14826ee..3ffb86ca 100644 --- a/src/funcs/customFieldsCreate.ts +++ b/src/funcs/customFieldsCreate.ts @@ -70,6 +70,9 @@ export async function customFieldsCreate( const context = { operationID: "custom-fields:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/customFieldsDelete.ts b/src/funcs/customFieldsDelete.ts index 490fefbf..575a40ad 100644 --- a/src/funcs/customFieldsDelete.ts +++ b/src/funcs/customFieldsDelete.ts @@ -78,6 +78,9 @@ export async function customFieldsDelete( const context = { operationID: "custom-fields:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/customFieldsGet.ts b/src/funcs/customFieldsGet.ts index 08fbcdb8..a3169563 100644 --- a/src/funcs/customFieldsGet.ts +++ b/src/funcs/customFieldsGet.ts @@ -78,6 +78,9 @@ export async function customFieldsGet( const context = { operationID: "custom-fields:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/customFieldsList.ts b/src/funcs/customFieldsList.ts index 6caaaa78..eacbe5d1 100644 --- a/src/funcs/customFieldsList.ts +++ b/src/funcs/customFieldsList.ts @@ -87,6 +87,9 @@ export async function customFieldsList( const context = { operationID: "custom-fields:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/customFieldsUpdate.ts b/src/funcs/customFieldsUpdate.ts index d8d3ec43..cb3d723e 100644 --- a/src/funcs/customFieldsUpdate.ts +++ b/src/funcs/customFieldsUpdate.ts @@ -79,6 +79,9 @@ export async function customFieldsUpdate( const context = { operationID: "custom-fields:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/externalOrganizationsList.ts b/src/funcs/externalOrganizationsList.ts index 536b621e..bdae1170 100644 --- a/src/funcs/externalOrganizationsList.ts +++ b/src/funcs/externalOrganizationsList.ts @@ -88,6 +88,9 @@ export async function externalOrganizationsList( const context = { operationID: "external_organizations:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/filesCreate.ts b/src/funcs/filesCreate.ts index 62e6e9d5..8f3dff8f 100644 --- a/src/funcs/filesCreate.ts +++ b/src/funcs/filesCreate.ts @@ -71,6 +71,9 @@ export async function filesCreate( const context = { operationID: "files:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/filesDelete.ts b/src/funcs/filesDelete.ts index 4d6cf22c..ed066331 100644 --- a/src/funcs/filesDelete.ts +++ b/src/funcs/filesDelete.ts @@ -79,6 +79,9 @@ export async function filesDelete( const context = { operationID: "files:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/filesList.ts b/src/funcs/filesList.ts index 36a36bc6..98dc5749 100644 --- a/src/funcs/filesList.ts +++ b/src/funcs/filesList.ts @@ -85,6 +85,9 @@ export async function filesList( const context = { operationID: "files:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/filesUpdate.ts b/src/funcs/filesUpdate.ts index cceac979..f4c383ae 100644 --- a/src/funcs/filesUpdate.ts +++ b/src/funcs/filesUpdate.ts @@ -77,6 +77,9 @@ export async function filesUpdate( const context = { operationID: "files:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/filesUploaded.ts b/src/funcs/filesUploaded.ts index 40ca57f7..fc994819 100644 --- a/src/funcs/filesUploaded.ts +++ b/src/funcs/filesUploaded.ts @@ -79,6 +79,9 @@ export async function filesUploaded( const context = { operationID: "files:uploaded", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/licenseKeysGet.ts b/src/funcs/licenseKeysGet.ts index 6f63b728..a85d26bf 100644 --- a/src/funcs/licenseKeysGet.ts +++ b/src/funcs/licenseKeysGet.ts @@ -79,6 +79,9 @@ export async function licenseKeysGet( const context = { operationID: "license_keys:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/licenseKeysGetActivation.ts b/src/funcs/licenseKeysGetActivation.ts index 0e3c3d28..7d40417b 100644 --- a/src/funcs/licenseKeysGetActivation.ts +++ b/src/funcs/licenseKeysGetActivation.ts @@ -86,6 +86,9 @@ export async function licenseKeysGetActivation( const context = { operationID: "license_keys:get_activation", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/licenseKeysList.ts b/src/funcs/licenseKeysList.ts index c5c72e69..b169e435 100644 --- a/src/funcs/licenseKeysList.ts +++ b/src/funcs/licenseKeysList.ts @@ -70,6 +70,7 @@ export async function licenseKeysList( const path = pathToFunc("/v1/license-keys")(); const query = encodeFormQuery({ + "benefit_id": payload.benefit_id, "limit": payload.limit, "organization_id": payload.organization_id, "page": payload.page, @@ -86,6 +87,9 @@ export async function licenseKeysList( const context = { operationID: "license_keys:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/licenseKeysUpdate.ts b/src/funcs/licenseKeysUpdate.ts index adfc9241..ff309707 100644 --- a/src/funcs/licenseKeysUpdate.ts +++ b/src/funcs/licenseKeysUpdate.ts @@ -80,6 +80,9 @@ export async function licenseKeysUpdate( const context = { operationID: "license_keys:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/metricsGet.ts b/src/funcs/metricsGet.ts index 4b216aa6..37b63479 100644 --- a/src/funcs/metricsGet.ts +++ b/src/funcs/metricsGet.ts @@ -79,6 +79,9 @@ export async function metricsGet( const context = { operationID: "metrics:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/metricsLimits.ts b/src/funcs/metricsLimits.ts index add465de..36efaae8 100644 --- a/src/funcs/metricsLimits.ts +++ b/src/funcs/metricsLimits.ts @@ -53,6 +53,9 @@ export async function metricsLimits( const context = { operationID: "metrics:limits", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2Authorize.ts b/src/funcs/oauth2Authorize.ts new file mode 100644 index 00000000..0d107f04 --- /dev/null +++ b/src/funcs/oauth2Authorize.ts @@ -0,0 +1,107 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { PolarCore } from "../core.js"; +import * as M from "../lib/matchers.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../models/errors/httpclienterrors.js"; +import { SDKError } from "../models/errors/sdkerror.js"; +import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; +import * as operations from "../models/operations/index.js"; +import { Result } from "../types/fp.js"; + +/** + * Authorize + */ +export async function oauth2Authorize( + client: PolarCore, + options?: RequestOptions, +): Promise< + Result< + operations.Oauth2AuthorizeResponseOauth2Authorize, + | SDKError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + > +> { + const path = pathToFunc("/v1/oauth2/authorize")(); + + const headers = new Headers({ + Accept: "application/json", + }); + + const secConfig = await extractSecurity(client._options.accessToken); + const securityInput = secConfig == null ? {} : { accessToken: secConfig }; + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + operationID: "oauth2:authorize", + oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.accessToken, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + path: path, + headers: headers, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return requestRes; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["4XX", "5XX"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return doResult; + } + const response = doResult.value; + + const [result] = await M.match< + operations.Oauth2AuthorizeResponseOauth2Authorize, + | SDKError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >( + M.json( + 200, + operations.Oauth2AuthorizeResponseOauth2Authorize$inboundSchema, + ), + M.fail(["4XX", "5XX"]), + )(response); + if (!result.ok) { + return result; + } + + return result; +} diff --git a/src/funcs/oauth2ClientsCreate.ts b/src/funcs/oauth2ClientsCreate.ts index 2531ac01..ed4f7ad6 100644 --- a/src/funcs/oauth2ClientsCreate.ts +++ b/src/funcs/oauth2ClientsCreate.ts @@ -71,6 +71,9 @@ export async function oauth2ClientsCreate( const context = { operationID: "oauth2:clients:oauth2:create_client", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2ClientsDelete.ts b/src/funcs/oauth2ClientsDelete.ts index d3215270..c5ba35f8 100644 --- a/src/funcs/oauth2ClientsDelete.ts +++ b/src/funcs/oauth2ClientsDelete.ts @@ -80,6 +80,9 @@ export async function oauth2ClientsDelete( const context = { operationID: "oauth2:clients:oauth2:delete_client", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2ClientsGet.ts b/src/funcs/oauth2ClientsGet.ts index 92118c9d..7d3b318e 100644 --- a/src/funcs/oauth2ClientsGet.ts +++ b/src/funcs/oauth2ClientsGet.ts @@ -80,6 +80,9 @@ export async function oauth2ClientsGet( const context = { operationID: "oauth2:clients:oauth2:get_client", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2ClientsList.ts b/src/funcs/oauth2ClientsList.ts index 11984166..a668745b 100644 --- a/src/funcs/oauth2ClientsList.ts +++ b/src/funcs/oauth2ClientsList.ts @@ -83,6 +83,9 @@ export async function oauth2ClientsList( const context = { operationID: "oauth2:clients:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2ClientsUpdate.ts b/src/funcs/oauth2ClientsUpdate.ts index 564dc2ef..848f160c 100644 --- a/src/funcs/oauth2ClientsUpdate.ts +++ b/src/funcs/oauth2ClientsUpdate.ts @@ -83,6 +83,9 @@ export async function oauth2ClientsUpdate( const context = { operationID: "oauth2:clients:oauth2:update_client", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2Introspect.ts b/src/funcs/oauth2Introspect.ts index d37eebef..279be690 100644 --- a/src/funcs/oauth2Introspect.ts +++ b/src/funcs/oauth2Introspect.ts @@ -74,6 +74,9 @@ export async function oauth2Introspect( const context = { operationID: "oauth2:introspect_token", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2Revoke.ts b/src/funcs/oauth2Revoke.ts index 24b83a55..a2028752 100644 --- a/src/funcs/oauth2Revoke.ts +++ b/src/funcs/oauth2Revoke.ts @@ -75,6 +75,9 @@ export async function oauth2Revoke( const context = { operationID: "oauth2:revoke_token", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2Token.ts b/src/funcs/oauth2Token.ts index a17dcd48..97709b96 100644 --- a/src/funcs/oauth2Token.ts +++ b/src/funcs/oauth2Token.ts @@ -73,6 +73,9 @@ export async function oauth2Token( const context = { operationID: "oauth2:request_token", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/oauth2Userinfo.ts b/src/funcs/oauth2Userinfo.ts index 3e0bea9d..60cba945 100644 --- a/src/funcs/oauth2Userinfo.ts +++ b/src/funcs/oauth2Userinfo.ts @@ -53,6 +53,9 @@ export async function oauth2Userinfo( const context = { operationID: "oauth2:userinfo", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/ordersGet.ts b/src/funcs/ordersGet.ts index 9cedeb35..4449c513 100644 --- a/src/funcs/ordersGet.ts +++ b/src/funcs/ordersGet.ts @@ -78,6 +78,9 @@ export async function ordersGet( const context = { operationID: "orders:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/ordersInvoice.ts b/src/funcs/ordersInvoice.ts index 2555d800..d8b355e3 100644 --- a/src/funcs/ordersInvoice.ts +++ b/src/funcs/ordersInvoice.ts @@ -78,6 +78,9 @@ export async function ordersInvoice( const context = { operationID: "orders:invoice", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/ordersList.ts b/src/funcs/ordersList.ts index 7fb8c09c..a21426f1 100644 --- a/src/funcs/ordersList.ts +++ b/src/funcs/ordersList.ts @@ -88,6 +88,9 @@ export async function ordersList( const context = { operationID: "orders:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/organizationsCreate.ts b/src/funcs/organizationsCreate.ts index cc0086bc..56ab9cb7 100644 --- a/src/funcs/organizationsCreate.ts +++ b/src/funcs/organizationsCreate.ts @@ -70,6 +70,9 @@ export async function organizationsCreate( const context = { operationID: "organizations:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/organizationsGet.ts b/src/funcs/organizationsGet.ts index dd2e78cc..7029ca1d 100644 --- a/src/funcs/organizationsGet.ts +++ b/src/funcs/organizationsGet.ts @@ -78,6 +78,9 @@ export async function organizationsGet( const context = { operationID: "organizations:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/organizationsList.ts b/src/funcs/organizationsList.ts index 342bd2dd..f5339fbd 100644 --- a/src/funcs/organizationsList.ts +++ b/src/funcs/organizationsList.ts @@ -85,6 +85,9 @@ export async function organizationsList( const context = { operationID: "organizations:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/organizationsUpdate.ts b/src/funcs/organizationsUpdate.ts index 1ed51de5..3d3d108a 100644 --- a/src/funcs/organizationsUpdate.ts +++ b/src/funcs/organizationsUpdate.ts @@ -83,6 +83,9 @@ export async function organizationsUpdate( const context = { operationID: "organizations:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/productsCreate.ts b/src/funcs/productsCreate.ts index 15891c9d..c2caadb4 100644 --- a/src/funcs/productsCreate.ts +++ b/src/funcs/productsCreate.ts @@ -72,6 +72,9 @@ export async function productsCreate( const context = { operationID: "products:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/productsGet.ts b/src/funcs/productsGet.ts index 8a2121b4..0d53993c 100644 --- a/src/funcs/productsGet.ts +++ b/src/funcs/productsGet.ts @@ -78,6 +78,9 @@ export async function productsGet( const context = { operationID: "products:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/productsList.ts b/src/funcs/productsList.ts index 7de3de0b..ce5d2b61 100644 --- a/src/funcs/productsList.ts +++ b/src/funcs/productsList.ts @@ -89,6 +89,9 @@ export async function productsList( const context = { operationID: "products:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/productsUpdate.ts b/src/funcs/productsUpdate.ts index 34c06e21..5059a3ec 100644 --- a/src/funcs/productsUpdate.ts +++ b/src/funcs/productsUpdate.ts @@ -80,6 +80,9 @@ export async function productsUpdate( const context = { operationID: "products:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/productsUpdateBenefits.ts b/src/funcs/productsUpdateBenefits.ts index a8c72e19..0882aa85 100644 --- a/src/funcs/productsUpdateBenefits.ts +++ b/src/funcs/productsUpdateBenefits.ts @@ -83,6 +83,9 @@ export async function productsUpdateBenefits( const context = { operationID: "products:update_benefits", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/repositoriesGet.ts b/src/funcs/repositoriesGet.ts index 458df46a..881cb1c6 100644 --- a/src/funcs/repositoriesGet.ts +++ b/src/funcs/repositoriesGet.ts @@ -78,6 +78,9 @@ export async function repositoriesGet( const context = { operationID: "repositories:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/repositoriesList.ts b/src/funcs/repositoriesList.ts index 66f140c8..366d3ea2 100644 --- a/src/funcs/repositoriesList.ts +++ b/src/funcs/repositoriesList.ts @@ -89,6 +89,9 @@ export async function repositoriesList( const context = { operationID: "repositories:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/repositoriesUpdate.ts b/src/funcs/repositoriesUpdate.ts index adacf0f0..859841c8 100644 --- a/src/funcs/repositoriesUpdate.ts +++ b/src/funcs/repositoriesUpdate.ts @@ -80,6 +80,9 @@ export async function repositoriesUpdate( const context = { operationID: "repositories:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/subscriptionsExport.ts b/src/funcs/subscriptionsExport.ts index 075941a7..66759fef 100644 --- a/src/funcs/subscriptionsExport.ts +++ b/src/funcs/subscriptionsExport.ts @@ -75,6 +75,9 @@ export async function subscriptionsExport( const context = { operationID: "subscriptions:export", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/subscriptionsList.ts b/src/funcs/subscriptionsList.ts index 08b70028..426bb608 100644 --- a/src/funcs/subscriptionsList.ts +++ b/src/funcs/subscriptionsList.ts @@ -87,6 +87,9 @@ export async function subscriptionsList( const context = { operationID: "subscriptions:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsCreate.ts b/src/funcs/usersAdvertisementsCreate.ts index ae1b3b39..a33d6003 100644 --- a/src/funcs/usersAdvertisementsCreate.ts +++ b/src/funcs/usersAdvertisementsCreate.ts @@ -71,6 +71,9 @@ export async function usersAdvertisementsCreate( const context = { operationID: "users:advertisements:create", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsDelete.ts b/src/funcs/usersAdvertisementsDelete.ts index 2b0cab22..5bcc2d37 100644 --- a/src/funcs/usersAdvertisementsDelete.ts +++ b/src/funcs/usersAdvertisementsDelete.ts @@ -81,6 +81,9 @@ export async function usersAdvertisementsDelete( const context = { operationID: "users:advertisements:delete", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsEnable.ts b/src/funcs/usersAdvertisementsEnable.ts index 981d2c4d..77ccc8fc 100644 --- a/src/funcs/usersAdvertisementsEnable.ts +++ b/src/funcs/usersAdvertisementsEnable.ts @@ -82,6 +82,9 @@ export async function usersAdvertisementsEnable( const context = { operationID: "users:advertisements:enable", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsGet.ts b/src/funcs/usersAdvertisementsGet.ts index cf5a370c..118fb466 100644 --- a/src/funcs/usersAdvertisementsGet.ts +++ b/src/funcs/usersAdvertisementsGet.ts @@ -79,6 +79,9 @@ export async function usersAdvertisementsGet( const context = { operationID: "users:advertisements:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsList.ts b/src/funcs/usersAdvertisementsList.ts index 180ee5d1..7cb2c810 100644 --- a/src/funcs/usersAdvertisementsList.ts +++ b/src/funcs/usersAdvertisementsList.ts @@ -85,6 +85,9 @@ export async function usersAdvertisementsList( const context = { operationID: "users:advertisements:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersAdvertisementsUpdate.ts b/src/funcs/usersAdvertisementsUpdate.ts index 099b1bfe..c7f4d023 100644 --- a/src/funcs/usersAdvertisementsUpdate.ts +++ b/src/funcs/usersAdvertisementsUpdate.ts @@ -82,6 +82,9 @@ export async function usersAdvertisementsUpdate( const context = { operationID: "users:advertisements:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersBenefitsGet.ts b/src/funcs/usersBenefitsGet.ts index 89033c6e..8fc53e54 100644 --- a/src/funcs/usersBenefitsGet.ts +++ b/src/funcs/usersBenefitsGet.ts @@ -77,6 +77,9 @@ export async function usersBenefitsGet( const context = { operationID: "users:benefits:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersBenefitsList.ts b/src/funcs/usersBenefitsList.ts index f1c75ff0..c26605d5 100644 --- a/src/funcs/usersBenefitsList.ts +++ b/src/funcs/usersBenefitsList.ts @@ -88,6 +88,9 @@ export async function usersBenefitsList( const context = { operationID: "users:benefits:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersDownloadablesGet.ts b/src/funcs/usersDownloadablesGet.ts index 061596af..9aba3d46 100644 --- a/src/funcs/usersDownloadablesGet.ts +++ b/src/funcs/usersDownloadablesGet.ts @@ -75,6 +75,9 @@ export async function usersDownloadablesGet( const context = { operationID: "users:downloadables:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersDownloadablesList.ts b/src/funcs/usersDownloadablesList.ts index e929ba97..d1320f0d 100644 --- a/src/funcs/usersDownloadablesList.ts +++ b/src/funcs/usersDownloadablesList.ts @@ -83,6 +83,9 @@ export async function usersDownloadablesList( const context = { operationID: "users:downloadables:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersLicenseKeysActivate.ts b/src/funcs/usersLicenseKeysActivate.ts index f3f8d190..4ae92052 100644 --- a/src/funcs/usersLicenseKeysActivate.ts +++ b/src/funcs/usersLicenseKeysActivate.ts @@ -72,6 +72,9 @@ export async function usersLicenseKeysActivate( const context = { operationID: "users:license_keys:activate", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersLicenseKeysDeactivate.ts b/src/funcs/usersLicenseKeysDeactivate.ts index 981bfdaf..9a4e795f 100644 --- a/src/funcs/usersLicenseKeysDeactivate.ts +++ b/src/funcs/usersLicenseKeysDeactivate.ts @@ -72,6 +72,9 @@ export async function usersLicenseKeysDeactivate( const context = { operationID: "users:license_keys:deactivate", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersLicenseKeysGet.ts b/src/funcs/usersLicenseKeysGet.ts index 576a5e07..bbf2d136 100644 --- a/src/funcs/usersLicenseKeysGet.ts +++ b/src/funcs/usersLicenseKeysGet.ts @@ -80,6 +80,9 @@ export async function usersLicenseKeysGet( const context = { operationID: "users:license_keys:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersLicenseKeysList.ts b/src/funcs/usersLicenseKeysList.ts index a0911714..d0ab2077 100644 --- a/src/funcs/usersLicenseKeysList.ts +++ b/src/funcs/usersLicenseKeysList.ts @@ -85,6 +85,9 @@ export async function usersLicenseKeysList( const context = { operationID: "users:license_keys:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersLicenseKeysValidate.ts b/src/funcs/usersLicenseKeysValidate.ts index 33e01de0..038901b2 100644 --- a/src/funcs/usersLicenseKeysValidate.ts +++ b/src/funcs/usersLicenseKeysValidate.ts @@ -71,6 +71,9 @@ export async function usersLicenseKeysValidate( const context = { operationID: "users:license_keys:validate", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersOrdersGet.ts b/src/funcs/usersOrdersGet.ts index f21b73a4..63b47ac9 100644 --- a/src/funcs/usersOrdersGet.ts +++ b/src/funcs/usersOrdersGet.ts @@ -78,6 +78,9 @@ export async function usersOrdersGet( const context = { operationID: "users:orders:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersOrdersInvoice.ts b/src/funcs/usersOrdersInvoice.ts index c194a733..3208ad3b 100644 --- a/src/funcs/usersOrdersInvoice.ts +++ b/src/funcs/usersOrdersInvoice.ts @@ -78,6 +78,9 @@ export async function usersOrdersInvoice( const context = { operationID: "users:orders:invoice", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersOrdersList.ts b/src/funcs/usersOrdersList.ts index 36be6f21..3123bbc2 100644 --- a/src/funcs/usersOrdersList.ts +++ b/src/funcs/usersOrdersList.ts @@ -89,6 +89,9 @@ export async function usersOrdersList( const context = { operationID: "users:orders:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersSubscriptionsCancel.ts b/src/funcs/usersSubscriptionsCancel.ts index 5d772ffe..0e89ec87 100644 --- a/src/funcs/usersSubscriptionsCancel.ts +++ b/src/funcs/usersSubscriptionsCancel.ts @@ -80,6 +80,9 @@ export async function usersSubscriptionsCancel( const context = { operationID: "users:subscriptions:cancel", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersSubscriptionsGet.ts b/src/funcs/usersSubscriptionsGet.ts index 1cfd370a..be1ca601 100644 --- a/src/funcs/usersSubscriptionsGet.ts +++ b/src/funcs/usersSubscriptionsGet.ts @@ -79,6 +79,9 @@ export async function usersSubscriptionsGet( const context = { operationID: "users:subscriptions:get", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersSubscriptionsList.ts b/src/funcs/usersSubscriptionsList.ts index 5113749b..bb9bdf50 100644 --- a/src/funcs/usersSubscriptionsList.ts +++ b/src/funcs/usersSubscriptionsList.ts @@ -89,6 +89,9 @@ export async function usersSubscriptionsList( const context = { operationID: "users:subscriptions:list", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/funcs/usersSubscriptionsUpdate.ts b/src/funcs/usersSubscriptionsUpdate.ts index c4cbb362..00b5c8e5 100644 --- a/src/funcs/usersSubscriptionsUpdate.ts +++ b/src/funcs/usersSubscriptionsUpdate.ts @@ -82,6 +82,9 @@ export async function usersSubscriptionsUpdate( const context = { operationID: "users:subscriptions:update", oAuth2Scopes: [], + + resolvedSecurity: requestSecurity, + securitySource: client._options.accessToken, retryConfig: options?.retries || client._options.retryConfig diff --git a/src/hooks/types.ts b/src/hooks/types.ts index 4079cc97..df5237dc 100644 --- a/src/hooks/types.ts +++ b/src/hooks/types.ts @@ -4,12 +4,14 @@ import { HTTPClient, RequestInput } from "../lib/http.js"; import { RetryConfig } from "../lib/retries.js"; +import { SecurityState } from "../lib/security.js"; export type HookContext = { operationID: string; oAuth2Scopes?: string[]; securitySource?: any | (() => Promise); retryConfig: RetryConfig; + resolvedSecurity: SecurityState | null; }; export type Awaitable = T | Promise; diff --git a/src/lib/config.ts b/src/lib/config.ts index 6f7e10c2..7d8669e1 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.1.0", - sdkVersion: "0.15.1", - genVersion: "2.451.0", - userAgent: "speakeasy-sdk/typescript 0.15.1 2.451.0 0.1.0 @polar-sh/sdk", + sdkVersion: "0.16.0", + genVersion: "2.457.2", + userAgent: "speakeasy-sdk/typescript 0.16.0 2.457.2 0.1.0 @polar-sh/sdk", } as const; diff --git a/src/lib/env.ts b/src/lib/env.ts index 6cdb861b..f7e4aad8 100644 --- a/src/lib/env.ts +++ b/src/lib/env.ts @@ -13,11 +13,10 @@ export interface Env { } export const envSchema: z.ZodType = z.object({ - POLAR_ACCESS_TOKEN: z.string(), + POLAR_ACCESS_TOKEN: z.string().optional(), - POLAR_DEBUG: z.coerce.boolean(), -}) - .partial(); + POLAR_DEBUG: z.coerce.boolean().optional(), +}); let envMemo: Env | undefined = undefined; /** diff --git a/src/lib/primitives.ts b/src/lib/primitives.ts index 23794a2b..48b28674 100644 --- a/src/lib/primitives.ts +++ b/src/lib/primitives.ts @@ -2,6 +2,26 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ +class InvariantError extends Error { + constructor(message: string) { + super(message); + this.name = "InvariantError"; + } +} + +export function invariant( + condition: unknown, + message: string, +): asserts condition { + if (!condition) { + throw new InvariantError(message); + } +} + +export type ExactPartial = { + [P in keyof T]?: T[P] | undefined; +}; + export type Remap = { [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */ ? Mapping[k] diff --git a/src/lib/security.ts b/src/lib/security.ts index f74646dd..4404346c 100644 --- a/src/lib/security.ts +++ b/src/lib/security.ts @@ -5,6 +5,14 @@ import * as components from "../models/components/index.js"; import { env } from "./env.js"; +type OAuth2PasswordFlow = { + username: string; + password?: string | undefined; + clientID: string; + clientSecret?: string | undefined; + tokenURL: string; +}; + export enum SecurityErrorCode { Incomplete = "incomplete", UnrecognisedSecurityType = "unrecognized_security_type", @@ -38,6 +46,7 @@ export type SecurityState = { headers: Record; queryParams: Record; cookies: Record; + oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" }; }; type SecurityInputBasic = { @@ -74,7 +83,18 @@ type SecurityInputOAuth2 = { type SecurityInputOAuth2ClientCredentials = { type: "oauth2:client_credentials"; - value: string | null | undefined; + value: + | { clientID?: string | undefined; clientSecret?: string | undefined } + | null + | undefined; +}; + +type SecurityInputOAuth2PasswordCredentials = { + type: "oauth2:password"; + value: + | string + | null + | undefined; fieldName: string; }; @@ -90,6 +110,7 @@ export type SecurityInput = | SecurityInputAPIKey | SecurityInputOAuth2 | SecurityInputOAuth2ClientCredentials + | SecurityInputOAuth2PasswordCredentials | SecurityInputOIDC | SecurityInputCustom; @@ -101,6 +122,7 @@ export function resolveSecurity( headers: {}, queryParams: {}, cookies: {}, + oauth2: { type: "none" }, }; const option = options.find((opts) => { @@ -111,6 +133,12 @@ export function resolveSecurity( return o.value.username != null || o.value.password != null; } else if (o.type === "http:custom") { return null; + } else if (o.type === "oauth2:password") { + return ( + typeof o.value === "string" && !!o.value + ); + } else if (o.type === "oauth2:client_credentials") { + return o.value.clientID != null || o.value.clientSecret != null; } else if (typeof o.value === "string") { return !!o.value; } else { @@ -153,6 +181,9 @@ export function resolveSecurity( case "oauth2": applyBearer(state, spec); break; + case "oauth2:password": + applyBearer(state, spec); + break; case "oauth2:client_credentials": break; case "openIdConnect": @@ -180,9 +211,13 @@ function applyBasic( function applyBearer( state: SecurityState, - spec: SecurityInputBearer | SecurityInputOAuth2 | SecurityInputOIDC, + spec: + | SecurityInputBearer + | SecurityInputOAuth2 + | SecurityInputOIDC + | SecurityInputOAuth2PasswordCredentials, ) { - if (spec.value == null) { + if (typeof spec.value !== "string" || !spec.value) { return; } @@ -193,6 +228,7 @@ function applyBearer( state.headers[spec.fieldName] = value; } + export function resolveGlobalSecurity( security: Partial | null | undefined, ): SecurityState | null { diff --git a/src/models/components/authorizeorganization.ts b/src/models/components/authorizeorganization.ts new file mode 100644 index 00000000..cdb31d18 --- /dev/null +++ b/src/models/components/authorizeorganization.ts @@ -0,0 +1,62 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; + +export type AuthorizeOrganization = { + id: string; + slug: string; + avatarUrl: string | null; +}; + +/** @internal */ +export const AuthorizeOrganization$inboundSchema: z.ZodType< + AuthorizeOrganization, + z.ZodTypeDef, + unknown +> = z.object({ + id: z.string(), + slug: z.string(), + avatar_url: z.nullable(z.string()), +}).transform((v) => { + return remap$(v, { + "avatar_url": "avatarUrl", + }); +}); + +/** @internal */ +export type AuthorizeOrganization$Outbound = { + id: string; + slug: string; + avatar_url: string | null; +}; + +/** @internal */ +export const AuthorizeOrganization$outboundSchema: z.ZodType< + AuthorizeOrganization$Outbound, + z.ZodTypeDef, + AuthorizeOrganization +> = z.object({ + id: z.string(), + slug: z.string(), + avatarUrl: z.nullable(z.string()), +}).transform((v) => { + return remap$(v, { + avatarUrl: "avatar_url", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AuthorizeOrganization$ { + /** @deprecated use `AuthorizeOrganization$inboundSchema` instead. */ + export const inboundSchema = AuthorizeOrganization$inboundSchema; + /** @deprecated use `AuthorizeOrganization$outboundSchema` instead. */ + export const outboundSchema = AuthorizeOrganization$outboundSchema; + /** @deprecated use `AuthorizeOrganization$Outbound` instead. */ + export type Outbound = AuthorizeOrganization$Outbound; +} diff --git a/src/models/components/authorizeresponseorganization.ts b/src/models/components/authorizeresponseorganization.ts new file mode 100644 index 00000000..a20c33d7 --- /dev/null +++ b/src/models/components/authorizeresponseorganization.ts @@ -0,0 +1,115 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; +import { ClosedEnum } from "../../types/enums.js"; +import { + AuthorizeOrganization, + AuthorizeOrganization$inboundSchema, + AuthorizeOrganization$Outbound, + AuthorizeOrganization$outboundSchema, +} from "./authorizeorganization.js"; +import { + OAuth2ClientPublic, + OAuth2ClientPublic$inboundSchema, + OAuth2ClientPublic$Outbound, + OAuth2ClientPublic$outboundSchema, +} from "./oauth2clientpublic.js"; +import { Scope, Scope$inboundSchema, Scope$outboundSchema } from "./scope.js"; + +export const AuthorizeResponseOrganizationSubType = { + Organization: "organization", +} as const; +export type AuthorizeResponseOrganizationSubType = ClosedEnum< + typeof AuthorizeResponseOrganizationSubType +>; + +export type AuthorizeResponseOrganization = { + client: OAuth2ClientPublic; + subType?: "organization" | undefined; + sub: AuthorizeOrganization | null; + scopes: Array; + organizations: Array; +}; + +/** @internal */ +export const AuthorizeResponseOrganizationSubType$inboundSchema: + z.ZodNativeEnum = z.nativeEnum( + AuthorizeResponseOrganizationSubType, + ); + +/** @internal */ +export const AuthorizeResponseOrganizationSubType$outboundSchema: + z.ZodNativeEnum = + AuthorizeResponseOrganizationSubType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AuthorizeResponseOrganizationSubType$ { + /** @deprecated use `AuthorizeResponseOrganizationSubType$inboundSchema` instead. */ + export const inboundSchema = + AuthorizeResponseOrganizationSubType$inboundSchema; + /** @deprecated use `AuthorizeResponseOrganizationSubType$outboundSchema` instead. */ + export const outboundSchema = + AuthorizeResponseOrganizationSubType$outboundSchema; +} + +/** @internal */ +export const AuthorizeResponseOrganization$inboundSchema: z.ZodType< + AuthorizeResponseOrganization, + z.ZodTypeDef, + unknown +> = z.object({ + client: OAuth2ClientPublic$inboundSchema, + sub_type: z.literal("organization").optional(), + sub: z.nullable(AuthorizeOrganization$inboundSchema), + scopes: z.array(Scope$inboundSchema), + organizations: z.array(AuthorizeOrganization$inboundSchema), +}).transform((v) => { + return remap$(v, { + "sub_type": "subType", + }); +}); + +/** @internal */ +export type AuthorizeResponseOrganization$Outbound = { + client: OAuth2ClientPublic$Outbound; + sub_type: "organization"; + sub: AuthorizeOrganization$Outbound | null; + scopes: Array; + organizations: Array; +}; + +/** @internal */ +export const AuthorizeResponseOrganization$outboundSchema: z.ZodType< + AuthorizeResponseOrganization$Outbound, + z.ZodTypeDef, + AuthorizeResponseOrganization +> = z.object({ + client: OAuth2ClientPublic$outboundSchema, + subType: z.literal("organization").default("organization"), + sub: z.nullable(AuthorizeOrganization$outboundSchema), + scopes: z.array(Scope$outboundSchema), + organizations: z.array(AuthorizeOrganization$outboundSchema), +}).transform((v) => { + return remap$(v, { + subType: "sub_type", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AuthorizeResponseOrganization$ { + /** @deprecated use `AuthorizeResponseOrganization$inboundSchema` instead. */ + export const inboundSchema = AuthorizeResponseOrganization$inboundSchema; + /** @deprecated use `AuthorizeResponseOrganization$outboundSchema` instead. */ + export const outboundSchema = AuthorizeResponseOrganization$outboundSchema; + /** @deprecated use `AuthorizeResponseOrganization$Outbound` instead. */ + export type Outbound = AuthorizeResponseOrganization$Outbound; +} diff --git a/src/models/components/authorizeresponseuser.ts b/src/models/components/authorizeresponseuser.ts new file mode 100644 index 00000000..3f3b1427 --- /dev/null +++ b/src/models/components/authorizeresponseuser.ts @@ -0,0 +1,108 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; +import { ClosedEnum } from "../../types/enums.js"; +import { + AuthorizeUser, + AuthorizeUser$inboundSchema, + AuthorizeUser$Outbound, + AuthorizeUser$outboundSchema, +} from "./authorizeuser.js"; +import { + OAuth2ClientPublic, + OAuth2ClientPublic$inboundSchema, + OAuth2ClientPublic$Outbound, + OAuth2ClientPublic$outboundSchema, +} from "./oauth2clientpublic.js"; +import { Scope, Scope$inboundSchema, Scope$outboundSchema } from "./scope.js"; + +export const AuthorizeResponseUserSubType = { + User: "user", +} as const; +export type AuthorizeResponseUserSubType = ClosedEnum< + typeof AuthorizeResponseUserSubType +>; + +export type AuthorizeResponseUser = { + client: OAuth2ClientPublic; + subType?: "user" | undefined; + sub: AuthorizeUser | null; + scopes: Array; +}; + +/** @internal */ +export const AuthorizeResponseUserSubType$inboundSchema: z.ZodNativeEnum< + typeof AuthorizeResponseUserSubType +> = z.nativeEnum(AuthorizeResponseUserSubType); + +/** @internal */ +export const AuthorizeResponseUserSubType$outboundSchema: z.ZodNativeEnum< + typeof AuthorizeResponseUserSubType +> = AuthorizeResponseUserSubType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AuthorizeResponseUserSubType$ { + /** @deprecated use `AuthorizeResponseUserSubType$inboundSchema` instead. */ + export const inboundSchema = AuthorizeResponseUserSubType$inboundSchema; + /** @deprecated use `AuthorizeResponseUserSubType$outboundSchema` instead. */ + export const outboundSchema = AuthorizeResponseUserSubType$outboundSchema; +} + +/** @internal */ +export const AuthorizeResponseUser$inboundSchema: z.ZodType< + AuthorizeResponseUser, + z.ZodTypeDef, + unknown +> = z.object({ + client: OAuth2ClientPublic$inboundSchema, + sub_type: z.literal("user").optional(), + sub: z.nullable(AuthorizeUser$inboundSchema), + scopes: z.array(Scope$inboundSchema), +}).transform((v) => { + return remap$(v, { + "sub_type": "subType", + }); +}); + +/** @internal */ +export type AuthorizeResponseUser$Outbound = { + client: OAuth2ClientPublic$Outbound; + sub_type: "user"; + sub: AuthorizeUser$Outbound | null; + scopes: Array; +}; + +/** @internal */ +export const AuthorizeResponseUser$outboundSchema: z.ZodType< + AuthorizeResponseUser$Outbound, + z.ZodTypeDef, + AuthorizeResponseUser +> = z.object({ + client: OAuth2ClientPublic$outboundSchema, + subType: z.literal("user").default("user"), + sub: z.nullable(AuthorizeUser$outboundSchema), + scopes: z.array(Scope$outboundSchema), +}).transform((v) => { + return remap$(v, { + subType: "sub_type", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace AuthorizeResponseUser$ { + /** @deprecated use `AuthorizeResponseUser$inboundSchema` instead. */ + export const inboundSchema = AuthorizeResponseUser$inboundSchema; + /** @deprecated use `AuthorizeResponseUser$outboundSchema` instead. */ + export const outboundSchema = AuthorizeResponseUser$outboundSchema; + /** @deprecated use `AuthorizeResponseUser$Outbound` instead. */ + export type Outbound = AuthorizeResponseUser$Outbound; +} diff --git a/src/models/components/donationuser.ts b/src/models/components/authorizeuser.ts similarity index 51% rename from src/models/components/donationuser.ts rename to src/models/components/authorizeuser.ts index 2080758a..5487e57d 100644 --- a/src/models/components/donationuser.ts +++ b/src/models/components/authorizeuser.ts @@ -5,47 +5,45 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; -export type DonationUser = { +export type AuthorizeUser = { id: string; - publicName: string; + email: string; avatarUrl: string | null; }; /** @internal */ -export const DonationUser$inboundSchema: z.ZodType< - DonationUser, +export const AuthorizeUser$inboundSchema: z.ZodType< + AuthorizeUser, z.ZodTypeDef, unknown > = z.object({ id: z.string(), - public_name: z.string(), + email: z.string(), avatar_url: z.nullable(z.string()), }).transform((v) => { return remap$(v, { - "public_name": "publicName", "avatar_url": "avatarUrl", }); }); /** @internal */ -export type DonationUser$Outbound = { +export type AuthorizeUser$Outbound = { id: string; - public_name: string; + email: string; avatar_url: string | null; }; /** @internal */ -export const DonationUser$outboundSchema: z.ZodType< - DonationUser$Outbound, +export const AuthorizeUser$outboundSchema: z.ZodType< + AuthorizeUser$Outbound, z.ZodTypeDef, - DonationUser + AuthorizeUser > = z.object({ id: z.string(), - publicName: z.string(), + email: z.string(), avatarUrl: z.nullable(z.string()), }).transform((v) => { return remap$(v, { - publicName: "public_name", avatarUrl: "avatar_url", }); }); @@ -54,11 +52,11 @@ export const DonationUser$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace DonationUser$ { - /** @deprecated use `DonationUser$inboundSchema` instead. */ - export const inboundSchema = DonationUser$inboundSchema; - /** @deprecated use `DonationUser$outboundSchema` instead. */ - export const outboundSchema = DonationUser$outboundSchema; - /** @deprecated use `DonationUser$Outbound` instead. */ - export type Outbound = DonationUser$Outbound; +export namespace AuthorizeUser$ { + /** @deprecated use `AuthorizeUser$inboundSchema` instead. */ + export const inboundSchema = AuthorizeUser$inboundSchema; + /** @deprecated use `AuthorizeUser$outboundSchema` instead. */ + export const outboundSchema = AuthorizeUser$outboundSchema; + /** @deprecated use `AuthorizeUser$Outbound` instead. */ + export type Outbound = AuthorizeUser$Outbound; } diff --git a/src/models/components/benefitdiscord.ts b/src/models/components/benefitdiscord.ts index 486b4ae9..5739dd90 100644 --- a/src/models/components/benefitdiscord.ts +++ b/src/models/components/benefitdiscord.ts @@ -11,12 +11,6 @@ import { BenefitDiscordProperties$Outbound, BenefitDiscordProperties$outboundSchema, } from "./benefitdiscordproperties.js"; -import { - BenefitDiscordPropertiesInput, - BenefitDiscordPropertiesInput$inboundSchema, - BenefitDiscordPropertiesInput$Outbound, - BenefitDiscordPropertiesInput$outboundSchema, -} from "./benefitdiscordpropertiesinput.js"; export const BenefitDiscordType = { Discord: "discord", @@ -66,49 +60,6 @@ export type BenefitDiscord = { properties: BenefitDiscordProperties; }; -/** - * A benefit of type `discord`. - * - * @remarks - * - * Use it to automatically invite your backers to a Discord server. - */ -export type BenefitDiscordInput = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the benefit. - */ - id: string; - type?: "discord" | undefined; - /** - * The description of the benefit. - */ - description: string; - /** - * Whether the benefit is selectable when creating a product. - */ - selectable: boolean; - /** - * Whether the benefit is deletable. - */ - deletable: boolean; - /** - * The ID of the organization owning the benefit. - */ - organizationId: string; - /** - * Properties for a benefit of type `discord`. - */ - properties: BenefitDiscordPropertiesInput; -}; - /** @internal */ export const BenefitDiscordType$inboundSchema: z.ZodNativeEnum< typeof BenefitDiscordType @@ -203,77 +154,3 @@ export namespace BenefitDiscord$ { /** @deprecated use `BenefitDiscord$Outbound` instead. */ export type Outbound = BenefitDiscord$Outbound; } - -/** @internal */ -export const BenefitDiscordInput$inboundSchema: z.ZodType< - BenefitDiscordInput, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - type: z.literal("discord").optional(), - description: z.string(), - selectable: z.boolean(), - deletable: z.boolean(), - organization_id: z.string(), - properties: BenefitDiscordPropertiesInput$inboundSchema, -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - "organization_id": "organizationId", - }); -}); - -/** @internal */ -export type BenefitDiscordInput$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - type: "discord"; - description: string; - selectable: boolean; - deletable: boolean; - organization_id: string; - properties: BenefitDiscordPropertiesInput$Outbound; -}; - -/** @internal */ -export const BenefitDiscordInput$outboundSchema: z.ZodType< - BenefitDiscordInput$Outbound, - z.ZodTypeDef, - BenefitDiscordInput -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - type: z.literal("discord").default("discord"), - description: z.string(), - selectable: z.boolean(), - deletable: z.boolean(), - organizationId: z.string(), - properties: BenefitDiscordPropertiesInput$outboundSchema, -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - organizationId: "organization_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BenefitDiscordInput$ { - /** @deprecated use `BenefitDiscordInput$inboundSchema` instead. */ - export const inboundSchema = BenefitDiscordInput$inboundSchema; - /** @deprecated use `BenefitDiscordInput$outboundSchema` instead. */ - export const outboundSchema = BenefitDiscordInput$outboundSchema; - /** @deprecated use `BenefitDiscordInput$Outbound` instead. */ - export type Outbound = BenefitDiscordInput$Outbound; -} diff --git a/src/models/components/benefitdiscordpropertiesinput.ts b/src/models/components/benefitdiscordpropertiesinput.ts deleted file mode 100644 index c41d18cf..00000000 --- a/src/models/components/benefitdiscordpropertiesinput.ts +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; - -/** - * Properties for a benefit of type `discord`. - */ -export type BenefitDiscordPropertiesInput = { - /** - * The ID of the Discord server. - */ - guildId: string; - /** - * The ID of the Discord role to grant. - */ - roleId: string; -}; - -/** @internal */ -export const BenefitDiscordPropertiesInput$inboundSchema: z.ZodType< - BenefitDiscordPropertiesInput, - z.ZodTypeDef, - unknown -> = z.object({ - guild_id: z.string(), - role_id: z.string(), -}).transform((v) => { - return remap$(v, { - "guild_id": "guildId", - "role_id": "roleId", - }); -}); - -/** @internal */ -export type BenefitDiscordPropertiesInput$Outbound = { - guild_id: string; - role_id: string; -}; - -/** @internal */ -export const BenefitDiscordPropertiesInput$outboundSchema: z.ZodType< - BenefitDiscordPropertiesInput$Outbound, - z.ZodTypeDef, - BenefitDiscordPropertiesInput -> = z.object({ - guildId: z.string(), - roleId: z.string(), -}).transform((v) => { - return remap$(v, { - guildId: "guild_id", - roleId: "role_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BenefitDiscordPropertiesInput$ { - /** @deprecated use `BenefitDiscordPropertiesInput$inboundSchema` instead. */ - export const inboundSchema = BenefitDiscordPropertiesInput$inboundSchema; - /** @deprecated use `BenefitDiscordPropertiesInput$outboundSchema` instead. */ - export const outboundSchema = BenefitDiscordPropertiesInput$outboundSchema; - /** @deprecated use `BenefitDiscordPropertiesInput$Outbound` instead. */ - export type Outbound = BenefitDiscordPropertiesInput$Outbound; -} diff --git a/src/models/components/benefitgrantwebhook.ts b/src/models/components/benefitgrantwebhook.ts index d2b3ac71..b0b81cad 100644 --- a/src/models/components/benefitgrantwebhook.ts +++ b/src/models/components/benefitgrantwebhook.ts @@ -4,6 +4,12 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; +import { + Benefit, + Benefit$inboundSchema, + Benefit$Outbound, + Benefit$outboundSchema, +} from "./benefit.js"; import { BenefitGrantAdsProperties, BenefitGrantAdsProperties$inboundSchema, @@ -46,12 +52,6 @@ import { BenefitGrantLicenseKeysProperties$Outbound, BenefitGrantLicenseKeysProperties$outboundSchema, } from "./benefitgrantlicensekeysproperties.js"; -import { - BenefitInput, - BenefitInput$inboundSchema, - BenefitInput$Outbound, - BenefitInput$outboundSchema, -} from "./benefitinput.js"; export type BenefitGrantWebhookProperties = | BenefitGrantCustomProperties @@ -124,7 +124,7 @@ export type BenefitGrantWebhook = { | BenefitGrantLicenseKeysProperties | BenefitGrantDiscordProperties | BenefitGrantGitHubRepositoryProperties; - benefit: BenefitInput; + benefit: Benefit; previousProperties?: | BenefitGrantCustomProperties | BenefitGrantArticlesProperties @@ -275,7 +275,7 @@ export const BenefitGrantWebhook$inboundSchema: z.ZodType< BenefitGrantDiscordProperties$inboundSchema, BenefitGrantGitHubRepositoryProperties$inboundSchema, ]), - benefit: BenefitInput$inboundSchema, + benefit: Benefit$inboundSchema, previous_properties: z.nullable( z.union([ BenefitGrantCustomProperties$inboundSchema, @@ -324,7 +324,7 @@ export type BenefitGrantWebhook$Outbound = { | BenefitGrantLicenseKeysProperties$Outbound | BenefitGrantDiscordProperties$Outbound | BenefitGrantGitHubRepositoryProperties$Outbound; - benefit: BenefitInput$Outbound; + benefit: Benefit$Outbound; previous_properties?: | BenefitGrantCustomProperties$Outbound | BenefitGrantArticlesProperties$Outbound @@ -363,7 +363,7 @@ export const BenefitGrantWebhook$outboundSchema: z.ZodType< BenefitGrantDiscordProperties$outboundSchema, BenefitGrantGitHubRepositoryProperties$outboundSchema, ]), - benefit: BenefitInput$outboundSchema, + benefit: Benefit$outboundSchema, previousProperties: z.nullable( z.union([ BenefitGrantCustomProperties$outboundSchema, diff --git a/src/models/components/benefitinput.ts b/src/models/components/benefitinput.ts deleted file mode 100644 index 8722dd7b..00000000 --- a/src/models/components/benefitinput.ts +++ /dev/null @@ -1,109 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { - BenefitAds, - BenefitAds$inboundSchema, - BenefitAds$Outbound, - BenefitAds$outboundSchema, -} from "./benefitads.js"; -import { - BenefitArticles, - BenefitArticles$inboundSchema, - BenefitArticles$Outbound, - BenefitArticles$outboundSchema, -} from "./benefitarticles.js"; -import { - BenefitCustom, - BenefitCustom$inboundSchema, - BenefitCustom$Outbound, - BenefitCustom$outboundSchema, -} from "./benefitcustom.js"; -import { - BenefitDiscordInput, - BenefitDiscordInput$inboundSchema, - BenefitDiscordInput$Outbound, - BenefitDiscordInput$outboundSchema, -} from "./benefitdiscord.js"; -import { - BenefitDownloadables, - BenefitDownloadables$inboundSchema, - BenefitDownloadables$Outbound, - BenefitDownloadables$outboundSchema, -} from "./benefitdownloadables.js"; -import { - BenefitGitHubRepository, - BenefitGitHubRepository$inboundSchema, - BenefitGitHubRepository$Outbound, - BenefitGitHubRepository$outboundSchema, -} from "./benefitgithubrepository.js"; -import { - BenefitLicenseKeys, - BenefitLicenseKeys$inboundSchema, - BenefitLicenseKeys$Outbound, - BenefitLicenseKeys$outboundSchema, -} from "./benefitlicensekeys.js"; - -export type BenefitInput = - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; - -/** @internal */ -export const BenefitInput$inboundSchema: z.ZodType< - BenefitInput, - z.ZodTypeDef, - unknown -> = z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type BenefitInput$Outbound = - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; - -/** @internal */ -export const BenefitInput$outboundSchema: z.ZodType< - BenefitInput$Outbound, - z.ZodTypeDef, - BenefitInput -> = z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscordInput$outboundSchema, - BenefitGitHubRepository$outboundSchema, - BenefitDownloadables$outboundSchema, - BenefitLicenseKeys$outboundSchema, - BenefitCustom$outboundSchema, -]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace BenefitInput$ { - /** @deprecated use `BenefitInput$inboundSchema` instead. */ - export const inboundSchema = BenefitInput$inboundSchema; - /** @deprecated use `BenefitInput$outboundSchema` instead. */ - export const outboundSchema = BenefitInput$outboundSchema; - /** @deprecated use `BenefitInput$Outbound` instead. */ - export type Outbound = BenefitInput$Outbound; -} diff --git a/src/models/components/checkoutlink.ts b/src/models/components/checkoutlink.ts index 40896913..80b922b5 100644 --- a/src/models/components/checkoutlink.ts +++ b/src/models/components/checkoutlink.ts @@ -11,6 +11,8 @@ import { ProductPrice$outboundSchema, } from "./productprice.js"; +export type CheckoutLinkMetadata = string | number | boolean; + /** * Checkout link data. */ @@ -27,7 +29,7 @@ export type CheckoutLink = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; paymentProcessor?: "stripe" | undefined; /** * Client secret used to access the checkout link. @@ -45,6 +47,36 @@ export type CheckoutLink = { url: string; }; +/** @internal */ +export const CheckoutLinkMetadata$inboundSchema: z.ZodType< + CheckoutLinkMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CheckoutLinkMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CheckoutLinkMetadata$outboundSchema: z.ZodType< + CheckoutLinkMetadata$Outbound, + z.ZodTypeDef, + CheckoutLinkMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CheckoutLinkMetadata$ { + /** @deprecated use `CheckoutLinkMetadata$inboundSchema` instead. */ + export const inboundSchema = CheckoutLinkMetadata$inboundSchema; + /** @deprecated use `CheckoutLinkMetadata$outboundSchema` instead. */ + export const outboundSchema = CheckoutLinkMetadata$outboundSchema; + /** @deprecated use `CheckoutLinkMetadata$Outbound` instead. */ + export type Outbound = CheckoutLinkMetadata$Outbound; +} + /** @internal */ export const CheckoutLink$inboundSchema: z.ZodType< CheckoutLink, @@ -56,7 +88,7 @@ export const CheckoutLink$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), payment_processor: z.literal("stripe").optional(), client_secret: z.string(), success_url: z.nullable(z.string()), @@ -80,7 +112,7 @@ export type CheckoutLink$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; payment_processor: "stripe"; client_secret: string; success_url: string | null; @@ -98,7 +130,7 @@ export const CheckoutLink$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), paymentProcessor: z.literal("stripe").default("stripe"), clientSecret: z.string(), successUrl: z.nullable(z.string()), diff --git a/src/models/components/checkoutlinkcreate.ts b/src/models/components/checkoutlinkcreate.ts index 946f3d23..07d93df4 100644 --- a/src/models/components/checkoutlinkcreate.ts +++ b/src/models/components/checkoutlinkcreate.ts @@ -6,6 +6,8 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; import { ClosedEnum } from "../../types/enums.js"; +export type CheckoutLinkCreateMetadata = string | number | boolean; + /** * Payment processor to use. Currently only Stripe is supported. */ @@ -29,10 +31,14 @@ export type CheckoutLinkCreate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; /** * Payment processor to use. Currently only Stripe is supported. */ @@ -47,6 +53,36 @@ export type CheckoutLinkCreate = { successUrl?: string | null | undefined; }; +/** @internal */ +export const CheckoutLinkCreateMetadata$inboundSchema: z.ZodType< + CheckoutLinkCreateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CheckoutLinkCreateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CheckoutLinkCreateMetadata$outboundSchema: z.ZodType< + CheckoutLinkCreateMetadata$Outbound, + z.ZodTypeDef, + CheckoutLinkCreateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CheckoutLinkCreateMetadata$ { + /** @deprecated use `CheckoutLinkCreateMetadata$inboundSchema` instead. */ + export const inboundSchema = CheckoutLinkCreateMetadata$inboundSchema; + /** @deprecated use `CheckoutLinkCreateMetadata$outboundSchema` instead. */ + export const outboundSchema = CheckoutLinkCreateMetadata$outboundSchema; + /** @deprecated use `CheckoutLinkCreateMetadata$Outbound` instead. */ + export type Outbound = CheckoutLinkCreateMetadata$Outbound; +} + /** @internal */ export const CheckoutLinkCreatePaymentProcessor$inboundSchema: z.ZodNativeEnum< typeof CheckoutLinkCreatePaymentProcessor @@ -75,7 +111,8 @@ export const CheckoutLinkCreate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), payment_processor: z.literal("stripe").optional(), product_price_id: z.string(), success_url: z.nullable(z.string()).optional(), @@ -89,7 +126,7 @@ export const CheckoutLinkCreate$inboundSchema: z.ZodType< /** @internal */ export type CheckoutLinkCreate$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; payment_processor: "stripe"; product_price_id: string; success_url?: string | null | undefined; @@ -101,7 +138,8 @@ export const CheckoutLinkCreate$outboundSchema: z.ZodType< z.ZodTypeDef, CheckoutLinkCreate > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), paymentProcessor: z.literal("stripe").default("stripe"), productPriceId: z.string(), successUrl: z.nullable(z.string()).optional(), diff --git a/src/models/components/checkoutlinkupdate.ts b/src/models/components/checkoutlinkupdate.ts index 5e196ef4..5561888a 100644 --- a/src/models/components/checkoutlinkupdate.ts +++ b/src/models/components/checkoutlinkupdate.ts @@ -5,6 +5,8 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; +export type CheckoutLinkUpdateMetadata = string | number | boolean; + /** * Schema to update an existing checkout link. */ @@ -15,23 +17,59 @@ export type CheckoutLinkUpdate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; /** * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. */ successUrl?: string | null | undefined; }; +/** @internal */ +export const CheckoutLinkUpdateMetadata$inboundSchema: z.ZodType< + CheckoutLinkUpdateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CheckoutLinkUpdateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CheckoutLinkUpdateMetadata$outboundSchema: z.ZodType< + CheckoutLinkUpdateMetadata$Outbound, + z.ZodTypeDef, + CheckoutLinkUpdateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CheckoutLinkUpdateMetadata$ { + /** @deprecated use `CheckoutLinkUpdateMetadata$inboundSchema` instead. */ + export const inboundSchema = CheckoutLinkUpdateMetadata$inboundSchema; + /** @deprecated use `CheckoutLinkUpdateMetadata$outboundSchema` instead. */ + export const outboundSchema = CheckoutLinkUpdateMetadata$outboundSchema; + /** @deprecated use `CheckoutLinkUpdateMetadata$Outbound` instead. */ + export type Outbound = CheckoutLinkUpdateMetadata$Outbound; +} + /** @internal */ export const CheckoutLinkUpdate$inboundSchema: z.ZodType< CheckoutLinkUpdate, z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), success_url: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { @@ -41,7 +79,7 @@ export const CheckoutLinkUpdate$inboundSchema: z.ZodType< /** @internal */ export type CheckoutLinkUpdate$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; success_url?: string | null | undefined; }; @@ -51,7 +89,9 @@ export const CheckoutLinkUpdate$outboundSchema: z.ZodType< z.ZodTypeDef, CheckoutLinkUpdate > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), successUrl: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { diff --git a/src/models/components/checkoutproduct.ts b/src/models/components/checkoutproduct.ts index 09d9649a..7f670864 100644 --- a/src/models/components/checkoutproduct.ts +++ b/src/models/components/checkoutproduct.ts @@ -21,10 +21,6 @@ import { ProductMediaFileRead$inboundSchema, ProductMediaFileRead$Outbound, ProductMediaFileRead$outboundSchema, - ProductMediaFileReadInput, - ProductMediaFileReadInput$inboundSchema, - ProductMediaFileReadInput$Outbound, - ProductMediaFileReadInput$outboundSchema, } from "./productmediafileread.js"; import { ProductPrice, @@ -85,56 +81,6 @@ export type CheckoutProduct = { medias: Array; }; -/** - * Product data for a checkout session. - */ -export type CheckoutProductInput = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the product. - */ - id: string; - /** - * The name of the product. - */ - name: string; - /** - * The description of the product. - */ - description: string | null; - /** - * Whether the product is a subscription tier. - */ - isRecurring: boolean; - /** - * Whether the product is archived and no longer available. - */ - isArchived: boolean; - /** - * The ID of the organization owning the product. - */ - organizationId: string; - /** - * List of prices for this product. - */ - prices: Array; - /** - * List of benefits granted by the product. - */ - benefits: Array; - /** - * List of medias associated to the product. - */ - medias: Array; -}; - /** @internal */ export const CheckoutProductBenefits$inboundSchema: z.ZodType< CheckoutProductBenefits, @@ -254,91 +200,3 @@ export namespace CheckoutProduct$ { /** @deprecated use `CheckoutProduct$Outbound` instead. */ export type Outbound = CheckoutProduct$Outbound; } - -/** @internal */ -export const CheckoutProductInput$inboundSchema: z.ZodType< - CheckoutProductInput, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - name: z.string(), - description: z.nullable(z.string()), - is_recurring: z.boolean(), - is_archived: z.boolean(), - organization_id: z.string(), - prices: z.array(ProductPrice$inboundSchema), - benefits: z.array( - z.union([BenefitBase$inboundSchema, BenefitArticles$inboundSchema]), - ), - medias: z.array(ProductMediaFileReadInput$inboundSchema), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - "is_recurring": "isRecurring", - "is_archived": "isArchived", - "organization_id": "organizationId", - }); -}); - -/** @internal */ -export type CheckoutProductInput$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - name: string; - description: string | null; - is_recurring: boolean; - is_archived: boolean; - organization_id: string; - prices: Array; - benefits: Array; - medias: Array; -}; - -/** @internal */ -export const CheckoutProductInput$outboundSchema: z.ZodType< - CheckoutProductInput$Outbound, - z.ZodTypeDef, - CheckoutProductInput -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - name: z.string(), - description: z.nullable(z.string()), - isRecurring: z.boolean(), - isArchived: z.boolean(), - organizationId: z.string(), - prices: z.array(ProductPrice$outboundSchema), - benefits: z.array( - z.union([BenefitBase$outboundSchema, BenefitArticles$outboundSchema]), - ), - medias: z.array(ProductMediaFileReadInput$outboundSchema), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - isRecurring: "is_recurring", - isArchived: "is_archived", - organizationId: "organization_id", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace CheckoutProductInput$ { - /** @deprecated use `CheckoutProductInput$inboundSchema` instead. */ - export const inboundSchema = CheckoutProductInput$inboundSchema; - /** @deprecated use `CheckoutProductInput$outboundSchema` instead. */ - export const outboundSchema = CheckoutProductInput$outboundSchema; - /** @deprecated use `CheckoutProductInput$Outbound` instead. */ - export type Outbound = CheckoutProductInput$Outbound; -} diff --git a/src/models/components/checkoutupdate.ts b/src/models/components/checkoutupdate.ts index de5335f0..de399d58 100644 --- a/src/models/components/checkoutupdate.ts +++ b/src/models/components/checkoutupdate.ts @@ -13,6 +13,8 @@ import { export type CustomFieldData = {}; +export type CheckoutUpdateMetadata = string | number | boolean; + /** * Update an existing checkout session using an access token. */ @@ -36,10 +38,14 @@ export type CheckoutUpdate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; customerIpAddress?: string | null | undefined; /** * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. @@ -81,6 +87,36 @@ export namespace CustomFieldData$ { export type Outbound = CustomFieldData$Outbound; } +/** @internal */ +export const CheckoutUpdateMetadata$inboundSchema: z.ZodType< + CheckoutUpdateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CheckoutUpdateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CheckoutUpdateMetadata$outboundSchema: z.ZodType< + CheckoutUpdateMetadata$Outbound, + z.ZodTypeDef, + CheckoutUpdateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CheckoutUpdateMetadata$ { + /** @deprecated use `CheckoutUpdateMetadata$inboundSchema` instead. */ + export const inboundSchema = CheckoutUpdateMetadata$inboundSchema; + /** @deprecated use `CheckoutUpdateMetadata$outboundSchema` instead. */ + export const outboundSchema = CheckoutUpdateMetadata$outboundSchema; + /** @deprecated use `CheckoutUpdateMetadata$Outbound` instead. */ + export type Outbound = CheckoutUpdateMetadata$Outbound; +} + /** @internal */ export const CheckoutUpdate$inboundSchema: z.ZodType< CheckoutUpdate, @@ -95,7 +131,9 @@ export const CheckoutUpdate$inboundSchema: z.ZodType< customer_email: z.nullable(z.string()).optional(), customer_billing_address: z.nullable(Address$inboundSchema).optional(), customer_tax_id: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), customer_ip_address: z.nullable(z.string()).optional(), success_url: z.nullable(z.string()).optional(), embed_origin: z.nullable(z.string()).optional(), @@ -122,7 +160,7 @@ export type CheckoutUpdate$Outbound = { customer_email?: string | null | undefined; customer_billing_address?: Address$Outbound | null | undefined; customer_tax_id?: string | null | undefined; - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; customer_ip_address?: string | null | undefined; success_url?: string | null | undefined; embed_origin?: string | null | undefined; @@ -142,7 +180,9 @@ export const CheckoutUpdate$outboundSchema: z.ZodType< customerEmail: z.nullable(z.string()).optional(), customerBillingAddress: z.nullable(Address$outboundSchema).optional(), customerTaxId: z.nullable(z.string()).optional(), - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), customerIpAddress: z.nullable(z.string()).optional(), successUrl: z.nullable(z.string()).optional(), embedOrigin: z.nullable(z.string()).optional(), diff --git a/src/models/components/customfieldcheckbox.ts b/src/models/components/customfieldcheckbox.ts index f5e85235..b03d1d38 100644 --- a/src/models/components/customfieldcheckbox.ts +++ b/src/models/components/customfieldcheckbox.ts @@ -12,6 +12,8 @@ import { CustomFieldCheckboxProperties$outboundSchema, } from "./customfieldcheckboxproperties.js"; +export type CustomFieldCheckboxMetadata = string | number | boolean; + export const CustomFieldCheckboxType = { Checkbox: "checkbox", } as const; @@ -35,10 +37,10 @@ export type CustomFieldCheckbox = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type?: "checkbox" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. */ slug: string; /** @@ -52,6 +54,36 @@ export type CustomFieldCheckbox = { properties: CustomFieldCheckboxProperties; }; +/** @internal */ +export const CustomFieldCheckboxMetadata$inboundSchema: z.ZodType< + CustomFieldCheckboxMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCheckboxMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldCheckboxMetadata$outboundSchema: z.ZodType< + CustomFieldCheckboxMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCheckboxMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCheckboxMetadata$ { + /** @deprecated use `CustomFieldCheckboxMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCheckboxMetadata$inboundSchema; + /** @deprecated use `CustomFieldCheckboxMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCheckboxMetadata$outboundSchema; + /** @deprecated use `CustomFieldCheckboxMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCheckboxMetadata$Outbound; +} + /** @internal */ export const CustomFieldCheckboxType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCheckboxType @@ -84,7 +116,7 @@ export const CustomFieldCheckbox$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("checkbox").optional(), slug: z.string(), name: z.string(), @@ -103,7 +135,7 @@ export type CustomFieldCheckbox$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type: "checkbox"; slug: string; name: string; @@ -120,7 +152,7 @@ export const CustomFieldCheckbox$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("checkbox").default("checkbox"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldcreatecheckbox.ts b/src/models/components/customfieldcreatecheckbox.ts index 4159967d..0b66308a 100644 --- a/src/models/components/customfieldcreatecheckbox.ts +++ b/src/models/components/customfieldcreatecheckbox.ts @@ -12,6 +12,8 @@ import { CustomFieldCheckboxProperties$outboundSchema, } from "./customfieldcheckboxproperties.js"; +export type CustomFieldCreateCheckboxMetadata = string | number | boolean; + export const CustomFieldCreateCheckboxType = { Checkbox: "checkbox", } as const; @@ -29,13 +31,17 @@ export type CustomFieldCreateCheckbox = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type?: "checkbox" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. */ slug: string; /** @@ -49,6 +55,40 @@ export type CustomFieldCreateCheckbox = { properties: CustomFieldCheckboxProperties; }; +/** @internal */ +export const CustomFieldCreateCheckboxMetadata$inboundSchema: z.ZodType< + CustomFieldCreateCheckboxMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCreateCheckboxMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldCreateCheckboxMetadata$outboundSchema: z.ZodType< + CustomFieldCreateCheckboxMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCreateCheckboxMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateCheckboxMetadata$ { + /** @deprecated use `CustomFieldCreateCheckboxMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateCheckboxMetadata$inboundSchema; + /** @deprecated use `CustomFieldCreateCheckboxMetadata$outboundSchema` instead. */ + export const outboundSchema = + CustomFieldCreateCheckboxMetadata$outboundSchema; + /** @deprecated use `CustomFieldCreateCheckboxMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCreateCheckboxMetadata$Outbound; +} + /** @internal */ export const CustomFieldCreateCheckboxType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCreateCheckboxType @@ -76,7 +116,8 @@ export const CustomFieldCreateCheckbox$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("checkbox").optional(), slug: z.string(), name: z.string(), @@ -90,7 +131,7 @@ export const CustomFieldCreateCheckbox$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldCreateCheckbox$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type: "checkbox"; slug: string; name: string; @@ -104,7 +145,8 @@ export const CustomFieldCreateCheckbox$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldCreateCheckbox > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("checkbox").default("checkbox"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldcreatedate.ts b/src/models/components/customfieldcreatedate.ts index 05c5b545..58921909 100644 --- a/src/models/components/customfieldcreatedate.ts +++ b/src/models/components/customfieldcreatedate.ts @@ -12,6 +12,8 @@ import { CustomFieldDateProperties$outboundSchema, } from "./customfielddateproperties.js"; +export type CustomFieldCreateDateMetadata = string | number | boolean; + export const CustomFieldCreateDateType = { Date: "date", } as const; @@ -29,13 +31,17 @@ export type CustomFieldCreateDate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type?: "date" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. */ slug: string; /** @@ -49,6 +55,36 @@ export type CustomFieldCreateDate = { properties: CustomFieldDateProperties; }; +/** @internal */ +export const CustomFieldCreateDateMetadata$inboundSchema: z.ZodType< + CustomFieldCreateDateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCreateDateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldCreateDateMetadata$outboundSchema: z.ZodType< + CustomFieldCreateDateMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCreateDateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateDateMetadata$ { + /** @deprecated use `CustomFieldCreateDateMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateDateMetadata$inboundSchema; + /** @deprecated use `CustomFieldCreateDateMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateDateMetadata$outboundSchema; + /** @deprecated use `CustomFieldCreateDateMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCreateDateMetadata$Outbound; +} + /** @internal */ export const CustomFieldCreateDateType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCreateDateType @@ -76,7 +112,8 @@ export const CustomFieldCreateDate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("date").optional(), slug: z.string(), name: z.string(), @@ -90,7 +127,7 @@ export const CustomFieldCreateDate$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldCreateDate$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type: "date"; slug: string; name: string; @@ -104,7 +141,8 @@ export const CustomFieldCreateDate$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldCreateDate > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("date").default("date"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldcreatenumber.ts b/src/models/components/customfieldcreatenumber.ts index dd77581e..ebb5d260 100644 --- a/src/models/components/customfieldcreatenumber.ts +++ b/src/models/components/customfieldcreatenumber.ts @@ -12,6 +12,8 @@ import { CustomFieldNumberProperties$outboundSchema, } from "./customfieldnumberproperties.js"; +export type CustomFieldCreateNumberMetadata = string | number | boolean; + export const CustomFieldCreateNumberType = { Number: "number", } as const; @@ -29,13 +31,17 @@ export type CustomFieldCreateNumber = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type?: "number" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. */ slug: string; /** @@ -49,6 +55,39 @@ export type CustomFieldCreateNumber = { properties: CustomFieldNumberProperties; }; +/** @internal */ +export const CustomFieldCreateNumberMetadata$inboundSchema: z.ZodType< + CustomFieldCreateNumberMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCreateNumberMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldCreateNumberMetadata$outboundSchema: z.ZodType< + CustomFieldCreateNumberMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCreateNumberMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateNumberMetadata$ { + /** @deprecated use `CustomFieldCreateNumberMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateNumberMetadata$inboundSchema; + /** @deprecated use `CustomFieldCreateNumberMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateNumberMetadata$outboundSchema; + /** @deprecated use `CustomFieldCreateNumberMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCreateNumberMetadata$Outbound; +} + /** @internal */ export const CustomFieldCreateNumberType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCreateNumberType @@ -76,7 +115,8 @@ export const CustomFieldCreateNumber$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("number").optional(), slug: z.string(), name: z.string(), @@ -90,7 +130,7 @@ export const CustomFieldCreateNumber$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldCreateNumber$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type: "number"; slug: string; name: string; @@ -104,7 +144,8 @@ export const CustomFieldCreateNumber$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldCreateNumber > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("number").default("number"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldcreateselect.ts b/src/models/components/customfieldcreateselect.ts index 2603fc4a..377073bc 100644 --- a/src/models/components/customfieldcreateselect.ts +++ b/src/models/components/customfieldcreateselect.ts @@ -12,6 +12,8 @@ import { CustomFieldSelectProperties$outboundSchema, } from "./customfieldselectproperties.js"; +export type CustomFieldCreateSelectMetadata = string | number | boolean; + export const CustomFieldCreateSelectType = { Select: "select", } as const; @@ -29,13 +31,17 @@ export type CustomFieldCreateSelect = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type?: "select" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. */ slug: string; /** @@ -49,6 +55,39 @@ export type CustomFieldCreateSelect = { properties: CustomFieldSelectProperties; }; +/** @internal */ +export const CustomFieldCreateSelectMetadata$inboundSchema: z.ZodType< + CustomFieldCreateSelectMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCreateSelectMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldCreateSelectMetadata$outboundSchema: z.ZodType< + CustomFieldCreateSelectMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCreateSelectMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateSelectMetadata$ { + /** @deprecated use `CustomFieldCreateSelectMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateSelectMetadata$inboundSchema; + /** @deprecated use `CustomFieldCreateSelectMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateSelectMetadata$outboundSchema; + /** @deprecated use `CustomFieldCreateSelectMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCreateSelectMetadata$Outbound; +} + /** @internal */ export const CustomFieldCreateSelectType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCreateSelectType @@ -76,7 +115,8 @@ export const CustomFieldCreateSelect$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("select").optional(), slug: z.string(), name: z.string(), @@ -90,7 +130,7 @@ export const CustomFieldCreateSelect$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldCreateSelect$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type: "select"; slug: string; name: string; @@ -104,7 +144,8 @@ export const CustomFieldCreateSelect$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldCreateSelect > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("select").default("select"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldcreatetext.ts b/src/models/components/customfieldcreatetext.ts index a9bef513..ab1e96be 100644 --- a/src/models/components/customfieldcreatetext.ts +++ b/src/models/components/customfieldcreatetext.ts @@ -12,6 +12,8 @@ import { CustomFieldTextProperties$outboundSchema, } from "./customfieldtextproperties.js"; +export type CustomFieldCreateTextMetadata = string | number | boolean; + export const CustomFieldCreateTextType = { Text: "text", } as const; @@ -29,13 +31,17 @@ export type CustomFieldCreateText = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type?: "text" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens. */ slug: string; /** @@ -49,6 +55,36 @@ export type CustomFieldCreateText = { properties: CustomFieldTextProperties; }; +/** @internal */ +export const CustomFieldCreateTextMetadata$inboundSchema: z.ZodType< + CustomFieldCreateTextMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldCreateTextMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldCreateTextMetadata$outboundSchema: z.ZodType< + CustomFieldCreateTextMetadata$Outbound, + z.ZodTypeDef, + CustomFieldCreateTextMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldCreateTextMetadata$ { + /** @deprecated use `CustomFieldCreateTextMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldCreateTextMetadata$inboundSchema; + /** @deprecated use `CustomFieldCreateTextMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldCreateTextMetadata$outboundSchema; + /** @deprecated use `CustomFieldCreateTextMetadata$Outbound` instead. */ + export type Outbound = CustomFieldCreateTextMetadata$Outbound; +} + /** @internal */ export const CustomFieldCreateTextType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldCreateTextType @@ -76,7 +112,8 @@ export const CustomFieldCreateText$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("text").optional(), slug: z.string(), name: z.string(), @@ -90,7 +127,7 @@ export const CustomFieldCreateText$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldCreateText$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; type: "text"; slug: string; name: string; @@ -104,7 +141,8 @@ export const CustomFieldCreateText$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldCreateText > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), type: z.literal("text").default("text"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfielddate.ts b/src/models/components/customfielddate.ts index 9a34a93b..e7d8f251 100644 --- a/src/models/components/customfielddate.ts +++ b/src/models/components/customfielddate.ts @@ -12,6 +12,8 @@ import { CustomFieldDateProperties$outboundSchema, } from "./customfielddateproperties.js"; +export type CustomFieldDateMetadata = string | number | boolean; + export const CustomFieldDateType = { Date: "date", } as const; @@ -33,10 +35,10 @@ export type CustomFieldDate = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type?: "date" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. */ slug: string; /** @@ -50,6 +52,36 @@ export type CustomFieldDate = { properties: CustomFieldDateProperties; }; +/** @internal */ +export const CustomFieldDateMetadata$inboundSchema: z.ZodType< + CustomFieldDateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldDateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldDateMetadata$outboundSchema: z.ZodType< + CustomFieldDateMetadata$Outbound, + z.ZodTypeDef, + CustomFieldDateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldDateMetadata$ { + /** @deprecated use `CustomFieldDateMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldDateMetadata$inboundSchema; + /** @deprecated use `CustomFieldDateMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldDateMetadata$outboundSchema; + /** @deprecated use `CustomFieldDateMetadata$Outbound` instead. */ + export type Outbound = CustomFieldDateMetadata$Outbound; +} + /** @internal */ export const CustomFieldDateType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldDateType @@ -82,7 +114,7 @@ export const CustomFieldDate$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("date").optional(), slug: z.string(), name: z.string(), @@ -101,7 +133,7 @@ export type CustomFieldDate$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type: "date"; slug: string; name: string; @@ -118,7 +150,7 @@ export const CustomFieldDate$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("date").default("date"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldnumber.ts b/src/models/components/customfieldnumber.ts index 6985181a..11090f03 100644 --- a/src/models/components/customfieldnumber.ts +++ b/src/models/components/customfieldnumber.ts @@ -12,6 +12,8 @@ import { CustomFieldNumberProperties$outboundSchema, } from "./customfieldnumberproperties.js"; +export type CustomFieldNumberMetadata = string | number | boolean; + export const CustomFieldNumberType = { Number: "number", } as const; @@ -33,10 +35,10 @@ export type CustomFieldNumber = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type?: "number" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. */ slug: string; /** @@ -50,6 +52,36 @@ export type CustomFieldNumber = { properties: CustomFieldNumberProperties; }; +/** @internal */ +export const CustomFieldNumberMetadata$inboundSchema: z.ZodType< + CustomFieldNumberMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldNumberMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldNumberMetadata$outboundSchema: z.ZodType< + CustomFieldNumberMetadata$Outbound, + z.ZodTypeDef, + CustomFieldNumberMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldNumberMetadata$ { + /** @deprecated use `CustomFieldNumberMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldNumberMetadata$inboundSchema; + /** @deprecated use `CustomFieldNumberMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldNumberMetadata$outboundSchema; + /** @deprecated use `CustomFieldNumberMetadata$Outbound` instead. */ + export type Outbound = CustomFieldNumberMetadata$Outbound; +} + /** @internal */ export const CustomFieldNumberType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldNumberType @@ -82,7 +114,7 @@ export const CustomFieldNumber$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("number").optional(), slug: z.string(), name: z.string(), @@ -101,7 +133,7 @@ export type CustomFieldNumber$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type: "number"; slug: string; name: string; @@ -118,7 +150,7 @@ export const CustomFieldNumber$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("number").default("number"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldselect.ts b/src/models/components/customfieldselect.ts index 734a4931..41ff82dc 100644 --- a/src/models/components/customfieldselect.ts +++ b/src/models/components/customfieldselect.ts @@ -12,6 +12,8 @@ import { CustomFieldSelectProperties$outboundSchema, } from "./customfieldselectproperties.js"; +export type CustomFieldSelectMetadata = string | number | boolean; + export const CustomFieldSelectType = { Select: "select", } as const; @@ -33,10 +35,10 @@ export type CustomFieldSelect = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type?: "select" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. */ slug: string; /** @@ -50,6 +52,36 @@ export type CustomFieldSelect = { properties: CustomFieldSelectProperties; }; +/** @internal */ +export const CustomFieldSelectMetadata$inboundSchema: z.ZodType< + CustomFieldSelectMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldSelectMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldSelectMetadata$outboundSchema: z.ZodType< + CustomFieldSelectMetadata$Outbound, + z.ZodTypeDef, + CustomFieldSelectMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldSelectMetadata$ { + /** @deprecated use `CustomFieldSelectMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldSelectMetadata$inboundSchema; + /** @deprecated use `CustomFieldSelectMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldSelectMetadata$outboundSchema; + /** @deprecated use `CustomFieldSelectMetadata$Outbound` instead. */ + export type Outbound = CustomFieldSelectMetadata$Outbound; +} + /** @internal */ export const CustomFieldSelectType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldSelectType @@ -82,7 +114,7 @@ export const CustomFieldSelect$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("select").optional(), slug: z.string(), name: z.string(), @@ -101,7 +133,7 @@ export type CustomFieldSelect$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type: "select"; slug: string; name: string; @@ -118,7 +150,7 @@ export const CustomFieldSelect$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("select").default("select"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldtext.ts b/src/models/components/customfieldtext.ts index c3ed755d..e58fb6e5 100644 --- a/src/models/components/customfieldtext.ts +++ b/src/models/components/customfieldtext.ts @@ -12,6 +12,8 @@ import { CustomFieldTextProperties$outboundSchema, } from "./customfieldtextproperties.js"; +export type CustomFieldTextMetadata = string | number | boolean; + export const CustomFieldTextType = { Text: "text", } as const; @@ -33,10 +35,10 @@ export type CustomFieldText = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type?: "text" | undefined; /** - * Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization. + * Identifier of the custom field. It'll be used as key when storing the value. */ slug: string; /** @@ -50,6 +52,36 @@ export type CustomFieldText = { properties: CustomFieldTextProperties; }; +/** @internal */ +export const CustomFieldTextMetadata$inboundSchema: z.ZodType< + CustomFieldTextMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldTextMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldTextMetadata$outboundSchema: z.ZodType< + CustomFieldTextMetadata$Outbound, + z.ZodTypeDef, + CustomFieldTextMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldTextMetadata$ { + /** @deprecated use `CustomFieldTextMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldTextMetadata$inboundSchema; + /** @deprecated use `CustomFieldTextMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldTextMetadata$outboundSchema; + /** @deprecated use `CustomFieldTextMetadata$Outbound` instead. */ + export type Outbound = CustomFieldTextMetadata$Outbound; +} + /** @internal */ export const CustomFieldTextType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldTextType @@ -82,7 +114,7 @@ export const CustomFieldText$inboundSchema: z.ZodType< z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("text").optional(), slug: z.string(), name: z.string(), @@ -101,7 +133,7 @@ export type CustomFieldText$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; type: "text"; slug: string; name: string; @@ -118,7 +150,7 @@ export const CustomFieldText$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), type: z.literal("text").default("text"), slug: z.string(), name: z.string(), diff --git a/src/models/components/customfieldupdatecheckbox.ts b/src/models/components/customfieldupdatecheckbox.ts index 5b7f1867..fd234ddb 100644 --- a/src/models/components/customfieldupdatecheckbox.ts +++ b/src/models/components/customfieldupdatecheckbox.ts @@ -11,6 +11,8 @@ import { CustomFieldCheckboxProperties$outboundSchema, } from "./customfieldcheckboxproperties.js"; +export type CustomFieldUpdateCheckboxMetadata = string | number | boolean; + export const CustomFieldUpdateCheckboxType = { Checkbox: "checkbox", } as const; @@ -28,16 +30,54 @@ export type CustomFieldUpdateCheckbox = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type?: "checkbox" | undefined; properties?: CustomFieldCheckboxProperties | null | undefined; }; +/** @internal */ +export const CustomFieldUpdateCheckboxMetadata$inboundSchema: z.ZodType< + CustomFieldUpdateCheckboxMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldUpdateCheckboxMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldUpdateCheckboxMetadata$outboundSchema: z.ZodType< + CustomFieldUpdateCheckboxMetadata$Outbound, + z.ZodTypeDef, + CustomFieldUpdateCheckboxMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldUpdateCheckboxMetadata$ { + /** @deprecated use `CustomFieldUpdateCheckboxMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldUpdateCheckboxMetadata$inboundSchema; + /** @deprecated use `CustomFieldUpdateCheckboxMetadata$outboundSchema` instead. */ + export const outboundSchema = + CustomFieldUpdateCheckboxMetadata$outboundSchema; + /** @deprecated use `CustomFieldUpdateCheckboxMetadata$Outbound` instead. */ + export type Outbound = CustomFieldUpdateCheckboxMetadata$Outbound; +} + /** @internal */ export const CustomFieldUpdateCheckboxType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldUpdateCheckboxType @@ -65,7 +105,9 @@ export const CustomFieldUpdateCheckbox$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("checkbox").optional(), @@ -75,7 +117,7 @@ export const CustomFieldUpdateCheckbox$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldUpdateCheckbox$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type: "checkbox"; @@ -88,7 +130,9 @@ export const CustomFieldUpdateCheckbox$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldUpdateCheckbox > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("checkbox").default("checkbox"), diff --git a/src/models/components/customfieldupdatedate.ts b/src/models/components/customfieldupdatedate.ts index f37c0fbd..26eb100a 100644 --- a/src/models/components/customfieldupdatedate.ts +++ b/src/models/components/customfieldupdatedate.ts @@ -11,6 +11,8 @@ import { CustomFieldDateProperties$outboundSchema, } from "./customfielddateproperties.js"; +export type CustomFieldUpdateDateMetadata = string | number | boolean; + export const CustomFieldUpdateDateType = { Date: "date", } as const; @@ -28,16 +30,50 @@ export type CustomFieldUpdateDate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type?: "date" | undefined; properties?: CustomFieldDateProperties | null | undefined; }; +/** @internal */ +export const CustomFieldUpdateDateMetadata$inboundSchema: z.ZodType< + CustomFieldUpdateDateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldUpdateDateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldUpdateDateMetadata$outboundSchema: z.ZodType< + CustomFieldUpdateDateMetadata$Outbound, + z.ZodTypeDef, + CustomFieldUpdateDateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldUpdateDateMetadata$ { + /** @deprecated use `CustomFieldUpdateDateMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldUpdateDateMetadata$inboundSchema; + /** @deprecated use `CustomFieldUpdateDateMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldUpdateDateMetadata$outboundSchema; + /** @deprecated use `CustomFieldUpdateDateMetadata$Outbound` instead. */ + export type Outbound = CustomFieldUpdateDateMetadata$Outbound; +} + /** @internal */ export const CustomFieldUpdateDateType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldUpdateDateType @@ -65,7 +101,9 @@ export const CustomFieldUpdateDate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("date").optional(), @@ -74,7 +112,7 @@ export const CustomFieldUpdateDate$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldUpdateDate$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type: "date"; @@ -87,7 +125,9 @@ export const CustomFieldUpdateDate$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldUpdateDate > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("date").default("date"), diff --git a/src/models/components/customfieldupdatenumber.ts b/src/models/components/customfieldupdatenumber.ts index 9367b218..46ee0091 100644 --- a/src/models/components/customfieldupdatenumber.ts +++ b/src/models/components/customfieldupdatenumber.ts @@ -11,6 +11,8 @@ import { CustomFieldNumberProperties$outboundSchema, } from "./customfieldnumberproperties.js"; +export type CustomFieldUpdateNumberMetadata = string | number | boolean; + export const CustomFieldUpdateNumberType = { Number: "number", } as const; @@ -28,16 +30,53 @@ export type CustomFieldUpdateNumber = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type?: "number" | undefined; properties?: CustomFieldNumberProperties | null | undefined; }; +/** @internal */ +export const CustomFieldUpdateNumberMetadata$inboundSchema: z.ZodType< + CustomFieldUpdateNumberMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldUpdateNumberMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldUpdateNumberMetadata$outboundSchema: z.ZodType< + CustomFieldUpdateNumberMetadata$Outbound, + z.ZodTypeDef, + CustomFieldUpdateNumberMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldUpdateNumberMetadata$ { + /** @deprecated use `CustomFieldUpdateNumberMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldUpdateNumberMetadata$inboundSchema; + /** @deprecated use `CustomFieldUpdateNumberMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldUpdateNumberMetadata$outboundSchema; + /** @deprecated use `CustomFieldUpdateNumberMetadata$Outbound` instead. */ + export type Outbound = CustomFieldUpdateNumberMetadata$Outbound; +} + /** @internal */ export const CustomFieldUpdateNumberType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldUpdateNumberType @@ -65,7 +104,9 @@ export const CustomFieldUpdateNumber$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("number").optional(), @@ -74,7 +115,7 @@ export const CustomFieldUpdateNumber$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldUpdateNumber$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type: "number"; @@ -87,7 +128,9 @@ export const CustomFieldUpdateNumber$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldUpdateNumber > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("number").default("number"), diff --git a/src/models/components/customfieldupdateselect.ts b/src/models/components/customfieldupdateselect.ts index a10c46e2..04a0e855 100644 --- a/src/models/components/customfieldupdateselect.ts +++ b/src/models/components/customfieldupdateselect.ts @@ -11,6 +11,8 @@ import { CustomFieldSelectProperties$outboundSchema, } from "./customfieldselectproperties.js"; +export type CustomFieldUpdateSelectMetadata = string | number | boolean; + export const CustomFieldUpdateSelectType = { Select: "select", } as const; @@ -28,16 +30,53 @@ export type CustomFieldUpdateSelect = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type?: "select" | undefined; properties?: CustomFieldSelectProperties | null | undefined; }; +/** @internal */ +export const CustomFieldUpdateSelectMetadata$inboundSchema: z.ZodType< + CustomFieldUpdateSelectMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldUpdateSelectMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const CustomFieldUpdateSelectMetadata$outboundSchema: z.ZodType< + CustomFieldUpdateSelectMetadata$Outbound, + z.ZodTypeDef, + CustomFieldUpdateSelectMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldUpdateSelectMetadata$ { + /** @deprecated use `CustomFieldUpdateSelectMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldUpdateSelectMetadata$inboundSchema; + /** @deprecated use `CustomFieldUpdateSelectMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldUpdateSelectMetadata$outboundSchema; + /** @deprecated use `CustomFieldUpdateSelectMetadata$Outbound` instead. */ + export type Outbound = CustomFieldUpdateSelectMetadata$Outbound; +} + /** @internal */ export const CustomFieldUpdateSelectType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldUpdateSelectType @@ -65,7 +104,9 @@ export const CustomFieldUpdateSelect$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("select").optional(), @@ -74,7 +115,7 @@ export const CustomFieldUpdateSelect$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldUpdateSelect$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type: "select"; @@ -87,7 +128,9 @@ export const CustomFieldUpdateSelect$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldUpdateSelect > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("select").default("select"), diff --git a/src/models/components/customfieldupdatetext.ts b/src/models/components/customfieldupdatetext.ts index 95861dc3..b57d0229 100644 --- a/src/models/components/customfieldupdatetext.ts +++ b/src/models/components/customfieldupdatetext.ts @@ -11,6 +11,8 @@ import { CustomFieldTextProperties$outboundSchema, } from "./customfieldtextproperties.js"; +export type CustomFieldUpdateTextMetadata = string | number | boolean; + export const CustomFieldUpdateTextType = { Text: "text", } as const; @@ -28,16 +30,50 @@ export type CustomFieldUpdateText = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type?: "text" | undefined; properties?: CustomFieldTextProperties | null | undefined; }; +/** @internal */ +export const CustomFieldUpdateTextMetadata$inboundSchema: z.ZodType< + CustomFieldUpdateTextMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type CustomFieldUpdateTextMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const CustomFieldUpdateTextMetadata$outboundSchema: z.ZodType< + CustomFieldUpdateTextMetadata$Outbound, + z.ZodTypeDef, + CustomFieldUpdateTextMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace CustomFieldUpdateTextMetadata$ { + /** @deprecated use `CustomFieldUpdateTextMetadata$inboundSchema` instead. */ + export const inboundSchema = CustomFieldUpdateTextMetadata$inboundSchema; + /** @deprecated use `CustomFieldUpdateTextMetadata$outboundSchema` instead. */ + export const outboundSchema = CustomFieldUpdateTextMetadata$outboundSchema; + /** @deprecated use `CustomFieldUpdateTextMetadata$Outbound` instead. */ + export type Outbound = CustomFieldUpdateTextMetadata$Outbound; +} + /** @internal */ export const CustomFieldUpdateTextType$inboundSchema: z.ZodNativeEnum< typeof CustomFieldUpdateTextType @@ -65,7 +101,9 @@ export const CustomFieldUpdateText$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("text").optional(), @@ -74,7 +112,7 @@ export const CustomFieldUpdateText$inboundSchema: z.ZodType< /** @internal */ export type CustomFieldUpdateText$Outbound = { - metadata?: { [k: string]: string } | null | undefined; + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; slug?: string | null | undefined; type: "text"; @@ -87,7 +125,9 @@ export const CustomFieldUpdateText$outboundSchema: z.ZodType< z.ZodTypeDef, CustomFieldUpdateText > = z.object({ - metadata: z.nullable(z.record(z.string())).optional(), + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), slug: z.nullable(z.string()).optional(), type: z.literal("text").default("text"), diff --git a/src/models/components/donation.ts b/src/models/components/donation.ts deleted file mode 100644 index 97273886..00000000 --- a/src/models/components/donation.ts +++ /dev/null @@ -1,152 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - DonationOrganization, - DonationOrganization$inboundSchema, - DonationOrganization$Outbound, - DonationOrganization$outboundSchema, -} from "./donationorganization.js"; -import { - DonationUser, - DonationUser$inboundSchema, - DonationUser$Outbound, - DonationUser$outboundSchema, -} from "./donationuser.js"; -import { - Issue, - Issue$inboundSchema, - Issue$Outbound, - Issue$outboundSchema, -} from "./issue.js"; - -export type Donor = DonationUser | DonationOrganization; - -export type Donation = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the object. - */ - id: string; - amount: number; - currency: string; - message: string | null; - donor: DonationUser | DonationOrganization | null; - email: string; - issue: Issue | null; -}; - -/** @internal */ -export const Donor$inboundSchema: z.ZodType = z - .union([DonationUser$inboundSchema, DonationOrganization$inboundSchema]); - -/** @internal */ -export type Donor$Outbound = - | DonationUser$Outbound - | DonationOrganization$Outbound; - -/** @internal */ -export const Donor$outboundSchema: z.ZodType< - Donor$Outbound, - z.ZodTypeDef, - Donor -> = z.union([DonationUser$outboundSchema, DonationOrganization$outboundSchema]); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Donor$ { - /** @deprecated use `Donor$inboundSchema` instead. */ - export const inboundSchema = Donor$inboundSchema; - /** @deprecated use `Donor$outboundSchema` instead. */ - export const outboundSchema = Donor$outboundSchema; - /** @deprecated use `Donor$Outbound` instead. */ - export type Outbound = Donor$Outbound; -} - -/** @internal */ -export const Donation$inboundSchema: z.ZodType< - Donation, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - amount: z.number().int(), - currency: z.string(), - message: z.nullable(z.string()), - donor: z.nullable( - z.union([DonationUser$inboundSchema, DonationOrganization$inboundSchema]), - ), - email: z.string(), - issue: z.nullable(Issue$inboundSchema), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - }); -}); - -/** @internal */ -export type Donation$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - amount: number; - currency: string; - message: string | null; - donor: DonationUser$Outbound | DonationOrganization$Outbound | null; - email: string; - issue: Issue$Outbound | null; -}; - -/** @internal */ -export const Donation$outboundSchema: z.ZodType< - Donation$Outbound, - z.ZodTypeDef, - Donation -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - amount: z.number().int(), - currency: z.string(), - message: z.nullable(z.string()), - donor: z.nullable( - z.union([DonationUser$outboundSchema, DonationOrganization$outboundSchema]), - ), - email: z.string(), - issue: z.nullable(Issue$outboundSchema), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Donation$ { - /** @deprecated use `Donation$inboundSchema` instead. */ - export const inboundSchema = Donation$inboundSchema; - /** @deprecated use `Donation$outboundSchema` instead. */ - export const outboundSchema = Donation$outboundSchema; - /** @deprecated use `Donation$Outbound` instead. */ - export type Outbound = Donation$Outbound; -} diff --git a/src/models/components/donationorganization.ts b/src/models/components/donationorganization.ts deleted file mode 100644 index 91f4b080..00000000 --- a/src/models/components/donationorganization.ts +++ /dev/null @@ -1,72 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; - -export type DonationOrganization = { - id: string; - platform?: "github" | undefined; - name: string; - avatarUrl: string; - isPersonal: boolean; -}; - -/** @internal */ -export const DonationOrganization$inboundSchema: z.ZodType< - DonationOrganization, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - platform: z.literal("github").optional(), - name: z.string(), - avatar_url: z.string(), - is_personal: z.boolean(), -}).transform((v) => { - return remap$(v, { - "avatar_url": "avatarUrl", - "is_personal": "isPersonal", - }); -}); - -/** @internal */ -export type DonationOrganization$Outbound = { - id: string; - platform: "github"; - name: string; - avatar_url: string; - is_personal: boolean; -}; - -/** @internal */ -export const DonationOrganization$outboundSchema: z.ZodType< - DonationOrganization$Outbound, - z.ZodTypeDef, - DonationOrganization -> = z.object({ - id: z.string(), - platform: z.literal("github").default("github"), - name: z.string(), - avatarUrl: z.string(), - isPersonal: z.boolean(), -}).transform((v) => { - return remap$(v, { - avatarUrl: "avatar_url", - isPersonal: "is_personal", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace DonationOrganization$ { - /** @deprecated use `DonationOrganization$inboundSchema` instead. */ - export const inboundSchema = DonationOrganization$inboundSchema; - /** @deprecated use `DonationOrganization$outboundSchema` instead. */ - export const outboundSchema = DonationOrganization$outboundSchema; - /** @deprecated use `DonationOrganization$Outbound` instead. */ - export type Outbound = DonationOrganization$Outbound; -} diff --git a/src/models/components/index.ts b/src/models/components/index.ts index a1cdbc90..78b43fef 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -17,6 +17,10 @@ export * from "./assignee.js"; export * from "./attachedcustomfield.js"; export * from "./attachedcustomfieldcreate.js"; export * from "./author.js"; +export * from "./authorizeorganization.js"; +export * from "./authorizeresponseorganization.js"; +export * from "./authorizeresponseuser.js"; +export * from "./authorizeuser.js"; export * from "./benefit.js"; export * from "./benefitads.js"; export * from "./benefitadscreate.js"; @@ -40,7 +44,6 @@ export * from "./benefitdiscord.js"; export * from "./benefitdiscordcreate.js"; export * from "./benefitdiscordcreateproperties.js"; export * from "./benefitdiscordproperties.js"; -export * from "./benefitdiscordpropertiesinput.js"; export * from "./benefitdiscordsubscriber.js"; export * from "./benefitdiscordsubscriberproperties.js"; export * from "./benefitdiscordupdate.js"; @@ -71,7 +74,6 @@ export * from "./benefitgrantlicensekeys.js"; export * from "./benefitgrantlicensekeysproperties.js"; export * from "./benefitgrantsubscriber.js"; export * from "./benefitgrantwebhook.js"; -export * from "./benefitinput.js"; export * from "./benefitlicensekeyactivationproperties.js"; export * from "./benefitlicensekeyexpirationproperties.js"; export * from "./benefitlicensekeys.js"; @@ -121,9 +123,6 @@ export * from "./customfieldupdatedate.js"; export * from "./customfieldupdatenumber.js"; export * from "./customfieldupdateselect.js"; export * from "./customfieldupdatetext.js"; -export * from "./donation.js"; -export * from "./donationorganization.js"; -export * from "./donationuser.js"; export * from "./downloadablefilecreate.js"; export * from "./downloadablefileread.js"; export * from "./downloadableread.js"; @@ -181,6 +180,7 @@ export * from "./metrictype.js"; export * from "./oauth2client.js"; export * from "./oauth2clientconfiguration.js"; export * from "./oauth2clientconfigurationupdate.js"; +export * from "./oauth2clientpublic.js"; export * from "./onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.js"; export * from "./onev11oauth21tokenpostxcomponentsrefreshtokenrequest.js"; export * from "./order.js"; @@ -200,6 +200,7 @@ export * from "./organizationsortproperty.js"; export * from "./organizationsubscribepromotesettings.js"; export * from "./organizationupdate.js"; export * from "./pagination.js"; +export * from "./paymentprocessor.js"; export * from "./platforms.js"; export * from "./pledge.js"; export * from "./pledger.js"; @@ -209,10 +210,8 @@ export * from "./polarcheckoutlegacyschemascheckout.js"; export * from "./polarcheckoutlegacyschemascheckoutcreate.js"; export * from "./polarcheckoutschemascheckout.js"; export * from "./polarcheckoutschemascheckoutcreate.js"; -export * from "./polarenumspaymentprocessor.js"; export * from "./product.js"; export * from "./productbenefitsupdate.js"; -export * from "./productinput.js"; export * from "./productmediafilecreate.js"; export * from "./productmediafileread.js"; export * from "./productonetimecreate.js"; @@ -247,6 +246,7 @@ export * from "./s3filecreatepart.js"; export * from "./s3fileuploadcompletedpart.js"; export * from "./s3fileuploadmultipart.js"; export * from "./s3fileuploadpart.js"; +export * from "./scope.js"; export * from "./security.js"; export * from "./state.js"; export * from "./subscription.js"; @@ -282,7 +282,6 @@ export * from "./webhookbenefitgrantupdatedpayload.js"; export * from "./webhookbenefitupdatedpayload.js"; export * from "./webhookcheckoutcreatedpayload.js"; export * from "./webhookcheckoutupdatedpayload.js"; -export * from "./webhookdonationcreatedpayload.js"; export * from "./webhookordercreatedpayload.js"; export * from "./webhookorganizationupdatedpayload.js"; export * from "./webhookpledgecreatedpayload.js"; diff --git a/src/models/components/oauth2clientpublic.ts b/src/models/components/oauth2clientpublic.ts new file mode 100644 index 00000000..7d2da231 --- /dev/null +++ b/src/models/components/oauth2clientpublic.ts @@ -0,0 +1,104 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../lib/primitives.js"; + +export type OAuth2ClientPublic = { + /** + * Creation timestamp of the object. + */ + createdAt: Date; + /** + * Last modification timestamp of the object. + */ + modifiedAt: Date | null; + clientId: string; + clientName: string | null; + clientUri: string | null; + logoUri: string | null; + tosUri: string | null; + policyUri: string | null; +}; + +/** @internal */ +export const OAuth2ClientPublic$inboundSchema: z.ZodType< + OAuth2ClientPublic, + z.ZodTypeDef, + unknown +> = z.object({ + created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), + modified_at: z.nullable( + z.string().datetime({ offset: true }).transform(v => new Date(v)), + ), + client_id: z.string(), + client_name: z.nullable(z.string()), + client_uri: z.nullable(z.string()), + logo_uri: z.nullable(z.string()), + tos_uri: z.nullable(z.string()), + policy_uri: z.nullable(z.string()), +}).transform((v) => { + return remap$(v, { + "created_at": "createdAt", + "modified_at": "modifiedAt", + "client_id": "clientId", + "client_name": "clientName", + "client_uri": "clientUri", + "logo_uri": "logoUri", + "tos_uri": "tosUri", + "policy_uri": "policyUri", + }); +}); + +/** @internal */ +export type OAuth2ClientPublic$Outbound = { + created_at: string; + modified_at: string | null; + client_id: string; + client_name: string | null; + client_uri: string | null; + logo_uri: string | null; + tos_uri: string | null; + policy_uri: string | null; +}; + +/** @internal */ +export const OAuth2ClientPublic$outboundSchema: z.ZodType< + OAuth2ClientPublic$Outbound, + z.ZodTypeDef, + OAuth2ClientPublic +> = z.object({ + createdAt: z.date().transform(v => v.toISOString()), + modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), + clientId: z.string(), + clientName: z.nullable(z.string()), + clientUri: z.nullable(z.string()), + logoUri: z.nullable(z.string()), + tosUri: z.nullable(z.string()), + policyUri: z.nullable(z.string()), +}).transform((v) => { + return remap$(v, { + createdAt: "created_at", + modifiedAt: "modified_at", + clientId: "client_id", + clientName: "client_name", + clientUri: "client_uri", + logoUri: "logo_uri", + tosUri: "tos_uri", + policyUri: "policy_uri", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OAuth2ClientPublic$ { + /** @deprecated use `OAuth2ClientPublic$inboundSchema` instead. */ + export const inboundSchema = OAuth2ClientPublic$inboundSchema; + /** @deprecated use `OAuth2ClientPublic$outboundSchema` instead. */ + export const outboundSchema = OAuth2ClientPublic$outboundSchema; + /** @deprecated use `OAuth2ClientPublic$Outbound` instead. */ + export type Outbound = OAuth2ClientPublic$Outbound; +} diff --git a/src/models/components/order.ts b/src/models/components/order.ts index 704dea3a..9289d346 100644 --- a/src/models/components/order.ts +++ b/src/models/components/order.ts @@ -34,6 +34,8 @@ import { ProductPrice$outboundSchema, } from "./productprice.js"; +export type OrderMetadata = string | number | boolean; + /** * Key-value object storing custom field values. */ @@ -52,7 +54,7 @@ export type Order = { * The ID of the object. */ id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; /** * Key-value object storing custom field values. */ @@ -72,6 +74,36 @@ export type Order = { subscription: OrderSubscription | null; }; +/** @internal */ +export const OrderMetadata$inboundSchema: z.ZodType< + OrderMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type OrderMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const OrderMetadata$outboundSchema: z.ZodType< + OrderMetadata$Outbound, + z.ZodTypeDef, + OrderMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OrderMetadata$ { + /** @deprecated use `OrderMetadata$inboundSchema` instead. */ + export const inboundSchema = OrderMetadata$inboundSchema; + /** @deprecated use `OrderMetadata$outboundSchema` instead. */ + export const outboundSchema = OrderMetadata$outboundSchema; + /** @deprecated use `OrderMetadata$Outbound` instead. */ + export type Outbound = OrderMetadata$Outbound; +} + /** @internal */ export const OrderCustomFieldData$inboundSchema: z.ZodType< OrderCustomFieldData, @@ -112,7 +144,7 @@ export const Order$inboundSchema: z.ZodType = z z.string().datetime({ offset: true }).transform(v => new Date(v)), ), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), custom_field_data: z.lazy(() => OrderCustomFieldData$inboundSchema) .optional(), amount: z.number().int(), @@ -149,7 +181,7 @@ export type Order$Outbound = { created_at: string; modified_at: string | null; id: string; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; custom_field_data?: OrderCustomFieldData$Outbound | undefined; amount: number; tax_amount: number; @@ -175,7 +207,7 @@ export const Order$outboundSchema: z.ZodType< createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), customFieldData: z.lazy(() => OrderCustomFieldData$outboundSchema).optional(), amount: z.number().int(), taxAmount: z.number().int(), diff --git a/src/models/components/ordersubscription.ts b/src/models/components/ordersubscription.ts index 54c4d478..314edb26 100644 --- a/src/models/components/ordersubscription.ts +++ b/src/models/components/ordersubscription.ts @@ -15,8 +15,10 @@ import { SubscriptionStatus$outboundSchema, } from "./subscriptionstatus.js"; +export type OrderSubscriptionMetadata = string | number | boolean; + export type OrderSubscription = { - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; /** * Creation timestamp of the object. */ @@ -44,13 +46,43 @@ export type OrderSubscription = { checkoutId: string | null; }; +/** @internal */ +export const OrderSubscriptionMetadata$inboundSchema: z.ZodType< + OrderSubscriptionMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type OrderSubscriptionMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const OrderSubscriptionMetadata$outboundSchema: z.ZodType< + OrderSubscriptionMetadata$Outbound, + z.ZodTypeDef, + OrderSubscriptionMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OrderSubscriptionMetadata$ { + /** @deprecated use `OrderSubscriptionMetadata$inboundSchema` instead. */ + export const inboundSchema = OrderSubscriptionMetadata$inboundSchema; + /** @deprecated use `OrderSubscriptionMetadata$outboundSchema` instead. */ + export const outboundSchema = OrderSubscriptionMetadata$outboundSchema; + /** @deprecated use `OrderSubscriptionMetadata$Outbound` instead. */ + export type Outbound = OrderSubscriptionMetadata$Outbound; +} + /** @internal */ export const OrderSubscription$inboundSchema: z.ZodType< OrderSubscription, z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), modified_at: z.nullable( z.string().datetime({ offset: true }).transform(v => new Date(v)), @@ -96,7 +128,7 @@ export const OrderSubscription$inboundSchema: z.ZodType< /** @internal */ export type OrderSubscription$Outbound = { - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; created_at: string; modified_at: string | null; id: string; @@ -121,7 +153,7 @@ export const OrderSubscription$outboundSchema: z.ZodType< z.ZodTypeDef, OrderSubscription > = z.object({ - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), createdAt: z.date().transform(v => v.toISOString()), modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), id: z.string(), diff --git a/src/models/components/organization.ts b/src/models/components/organization.ts index 2611491f..394aad8c 100644 --- a/src/models/components/organization.ts +++ b/src/models/components/organization.ts @@ -42,10 +42,6 @@ export type Organization = { pledgeMinimumAmount: number; pledgeBadgeShowAmount: boolean; defaultUpfrontSplitToContributors: number | null; - /** - * If this organizations accepts donations - */ - donationsEnabled: boolean; /** * Settings for the organization profile */ @@ -79,7 +75,6 @@ export const Organization$inboundSchema: z.ZodType< pledge_minimum_amount: z.number().int(), pledge_badge_show_amount: z.boolean(), default_upfront_split_to_contributors: z.nullable(z.number().int()), - donations_enabled: z.boolean(), profile_settings: z.nullable(OrganizationProfileSettings$inboundSchema), feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema), }).transform((v) => { @@ -92,7 +87,6 @@ export const Organization$inboundSchema: z.ZodType< "pledge_badge_show_amount": "pledgeBadgeShowAmount", "default_upfront_split_to_contributors": "defaultUpfrontSplitToContributors", - "donations_enabled": "donationsEnabled", "profile_settings": "profileSettings", "feature_settings": "featureSettings", }); @@ -115,7 +109,6 @@ export type Organization$Outbound = { pledge_minimum_amount: number; pledge_badge_show_amount: boolean; default_upfront_split_to_contributors: number | null; - donations_enabled: boolean; profile_settings: OrganizationProfileSettings$Outbound | null; feature_settings: OrganizationFeatureSettings$Outbound | null; }; @@ -141,7 +134,6 @@ export const Organization$outboundSchema: z.ZodType< pledgeMinimumAmount: z.number().int(), pledgeBadgeShowAmount: z.boolean(), defaultUpfrontSplitToContributors: z.nullable(z.number().int()), - donationsEnabled: z.boolean(), profileSettings: z.nullable(OrganizationProfileSettings$outboundSchema), featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema), }).transform((v) => { @@ -153,7 +145,6 @@ export const Organization$outboundSchema: z.ZodType< pledgeMinimumAmount: "pledge_minimum_amount", pledgeBadgeShowAmount: "pledge_badge_show_amount", defaultUpfrontSplitToContributors: "default_upfront_split_to_contributors", - donationsEnabled: "donations_enabled", profileSettings: "profile_settings", featureSettings: "feature_settings", }); diff --git a/src/models/components/organizationcreate.ts b/src/models/components/organizationcreate.ts index d9742eae..d4c40b45 100644 --- a/src/models/components/organizationcreate.ts +++ b/src/models/components/organizationcreate.ts @@ -15,7 +15,6 @@ export type OrganizationCreate = { name: string; slug: string; avatarUrl?: string | null | undefined; - donationsEnabled?: boolean | undefined; featureSettings?: OrganizationFeatureSettings | null | undefined; }; @@ -28,13 +27,11 @@ export const OrganizationCreate$inboundSchema: z.ZodType< name: z.string(), slug: z.string(), avatar_url: z.nullable(z.string()).optional(), - donations_enabled: z.boolean().default(false), feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema) .optional(), }).transform((v) => { return remap$(v, { "avatar_url": "avatarUrl", - "donations_enabled": "donationsEnabled", "feature_settings": "featureSettings", }); }); @@ -44,7 +41,6 @@ export type OrganizationCreate$Outbound = { name: string; slug: string; avatar_url?: string | null | undefined; - donations_enabled: boolean; feature_settings?: OrganizationFeatureSettings$Outbound | null | undefined; }; @@ -57,13 +53,11 @@ export const OrganizationCreate$outboundSchema: z.ZodType< name: z.string(), slug: z.string(), avatarUrl: z.nullable(z.string()).optional(), - donationsEnabled: z.boolean().default(false), featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema) .optional(), }).transform((v) => { return remap$(v, { avatarUrl: "avatar_url", - donationsEnabled: "donations_enabled", featureSettings: "feature_settings", }); }); diff --git a/src/models/components/organizationupdate.ts b/src/models/components/organizationupdate.ts index 77a30f7d..caf0120f 100644 --- a/src/models/components/organizationupdate.ts +++ b/src/models/components/organizationupdate.ts @@ -27,7 +27,6 @@ export type OrganizationUpdate = { pledgeMinimumAmount?: number | undefined; totalMonthlySpendingLimit?: number | null | undefined; perUserMonthlySpendingLimit?: number | null | undefined; - donationsEnabled?: boolean | undefined; profileSettings?: OrganizationProfileSettings | null | undefined; featureSettings?: OrganizationFeatureSettings | null | undefined; }; @@ -48,7 +47,6 @@ export const OrganizationUpdate$inboundSchema: z.ZodType< pledge_minimum_amount: z.number().int().default(2000), total_monthly_spending_limit: z.nullable(z.number().int()).optional(), per_user_monthly_spending_limit: z.nullable(z.number().int()).optional(), - donations_enabled: z.boolean().default(false), profile_settings: z.nullable(OrganizationProfileSettings$inboundSchema) .optional(), feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema) @@ -64,7 +62,6 @@ export const OrganizationUpdate$inboundSchema: z.ZodType< "pledge_minimum_amount": "pledgeMinimumAmount", "total_monthly_spending_limit": "totalMonthlySpendingLimit", "per_user_monthly_spending_limit": "perUserMonthlySpendingLimit", - "donations_enabled": "donationsEnabled", "profile_settings": "profileSettings", "feature_settings": "featureSettings", }); @@ -81,7 +78,6 @@ export type OrganizationUpdate$Outbound = { pledge_minimum_amount: number; total_monthly_spending_limit?: number | null | undefined; per_user_monthly_spending_limit?: number | null | undefined; - donations_enabled: boolean; profile_settings?: OrganizationProfileSettings$Outbound | null | undefined; feature_settings?: OrganizationFeatureSettings$Outbound | null | undefined; }; @@ -101,7 +97,6 @@ export const OrganizationUpdate$outboundSchema: z.ZodType< pledgeMinimumAmount: z.number().int().default(2000), totalMonthlySpendingLimit: z.nullable(z.number().int()).optional(), perUserMonthlySpendingLimit: z.nullable(z.number().int()).optional(), - donationsEnabled: z.boolean().default(false), profileSettings: z.nullable(OrganizationProfileSettings$outboundSchema) .optional(), featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema) @@ -116,7 +111,6 @@ export const OrganizationUpdate$outboundSchema: z.ZodType< pledgeMinimumAmount: "pledge_minimum_amount", totalMonthlySpendingLimit: "total_monthly_spending_limit", perUserMonthlySpendingLimit: "per_user_monthly_spending_limit", - donationsEnabled: "donations_enabled", profileSettings: "profile_settings", featureSettings: "feature_settings", }); diff --git a/src/models/components/paymentprocessor.ts b/src/models/components/paymentprocessor.ts new file mode 100644 index 00000000..2b518d31 --- /dev/null +++ b/src/models/components/paymentprocessor.ts @@ -0,0 +1,32 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; + +export const PaymentProcessor = { + Stripe: "stripe", +} as const; +export type PaymentProcessor = ClosedEnum; + +/** @internal */ +export const PaymentProcessor$inboundSchema: z.ZodNativeEnum< + typeof PaymentProcessor +> = z.nativeEnum(PaymentProcessor); + +/** @internal */ +export const PaymentProcessor$outboundSchema: z.ZodNativeEnum< + typeof PaymentProcessor +> = PaymentProcessor$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace PaymentProcessor$ { + /** @deprecated use `PaymentProcessor$inboundSchema` instead. */ + export const inboundSchema = PaymentProcessor$inboundSchema; + /** @deprecated use `PaymentProcessor$outboundSchema` instead. */ + export const outboundSchema = PaymentProcessor$outboundSchema; +} diff --git a/src/models/components/polarcheckoutschemascheckout.ts b/src/models/components/polarcheckoutschemascheckout.ts index 7d3d138a..73b9f0f2 100644 --- a/src/models/components/polarcheckoutschemascheckout.ts +++ b/src/models/components/polarcheckoutschemascheckout.ts @@ -21,10 +21,6 @@ import { CheckoutProduct$inboundSchema, CheckoutProduct$Outbound, CheckoutProduct$outboundSchema, - CheckoutProductInput, - CheckoutProductInput$inboundSchema, - CheckoutProductInput$Outbound, - CheckoutProductInput$outboundSchema, } from "./checkoutproduct.js"; import { CheckoutStatus, @@ -45,6 +41,8 @@ export type PolarCheckoutSchemasCheckoutCustomFieldData = {}; export type PaymentProcessorMetadata = {}; +export type PolarCheckoutSchemasCheckoutMetadata = string | number | boolean; + /** * Checkout session data retrieved using an access token. */ @@ -119,7 +117,7 @@ export type PolarCheckoutSchemasCheckout = { customerBillingAddress: Address | null; customerTaxId: string | null; paymentProcessorMetadata: PaymentProcessorMetadata; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; /** * Product data for a checkout session. */ @@ -129,90 +127,6 @@ export type PolarCheckoutSchemasCheckout = { attachedCustomFields: Array; }; -/** - * Checkout session data retrieved using an access token. - */ -export type PolarCheckoutSchemasCheckoutInput = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the object. - */ - id: string; - /** - * Key-value object storing custom field values. - */ - customFieldData?: PolarCheckoutSchemasCheckoutCustomFieldData | undefined; - paymentProcessor?: "stripe" | undefined; - status: CheckoutStatus; - /** - * Client secret used to update and complete the checkout session from the client. - */ - clientSecret: string; - /** - * URL where the customer can access the checkout session. - */ - url: string; - /** - * Expiration date and time of the checkout session. - */ - expiresAt: Date; - /** - * URL where the customer will be redirected after a successful payment. - */ - successUrl: string; - /** - * When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page. - */ - embedOrigin: string | null; - amount: number | null; - /** - * Computed tax amount to pay in cents. - */ - taxAmount: number | null; - /** - * Currency code of the checkout session. - */ - currency: string | null; - /** - * Total amount to pay in cents. - */ - totalAmount: number | null; - /** - * ID of the product to checkout. - */ - productId: string; - /** - * ID of the product price to checkout. - */ - productPriceId: string; - /** - * Whether the checkout requires payment. Useful to detect free products. - */ - isPaymentRequired: boolean; - customerId: string | null; - customerName: string | null; - customerEmail: string | null; - customerIpAddress: string | null; - customerBillingAddress: Address | null; - customerTaxId: string | null; - paymentProcessorMetadata: PaymentProcessorMetadata; - metadata: { [k: string]: string }; - /** - * Product data for a checkout session. - */ - product: CheckoutProductInput; - productPrice: ProductPrice; - subscriptionId: string | null; - attachedCustomFields: Array; -}; - /** @internal */ export const PolarCheckoutSchemasCheckoutCustomFieldData$inboundSchema: z.ZodType< @@ -277,6 +191,41 @@ export namespace PaymentProcessorMetadata$ { export type Outbound = PaymentProcessorMetadata$Outbound; } +/** @internal */ +export const PolarCheckoutSchemasCheckoutMetadata$inboundSchema: z.ZodType< + PolarCheckoutSchemasCheckoutMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type PolarCheckoutSchemasCheckoutMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const PolarCheckoutSchemasCheckoutMetadata$outboundSchema: z.ZodType< + PolarCheckoutSchemasCheckoutMetadata$Outbound, + z.ZodTypeDef, + PolarCheckoutSchemasCheckoutMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace PolarCheckoutSchemasCheckoutMetadata$ { + /** @deprecated use `PolarCheckoutSchemasCheckoutMetadata$inboundSchema` instead. */ + export const inboundSchema = + PolarCheckoutSchemasCheckoutMetadata$inboundSchema; + /** @deprecated use `PolarCheckoutSchemasCheckoutMetadata$outboundSchema` instead. */ + export const outboundSchema = + PolarCheckoutSchemasCheckoutMetadata$outboundSchema; + /** @deprecated use `PolarCheckoutSchemasCheckoutMetadata$Outbound` instead. */ + export type Outbound = PolarCheckoutSchemasCheckoutMetadata$Outbound; +} + /** @internal */ export const PolarCheckoutSchemasCheckout$inboundSchema: z.ZodType< PolarCheckoutSchemasCheckout, @@ -314,7 +263,7 @@ export const PolarCheckoutSchemasCheckout$inboundSchema: z.ZodType< payment_processor_metadata: z.lazy(() => PaymentProcessorMetadata$inboundSchema ), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), product: CheckoutProduct$inboundSchema, product_price: ProductPrice$inboundSchema, subscription_id: z.nullable(z.string()), @@ -376,7 +325,7 @@ export type PolarCheckoutSchemasCheckout$Outbound = { customer_billing_address: Address$Outbound | null; customer_tax_id: string | null; payment_processor_metadata: PaymentProcessorMetadata$Outbound; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; product: CheckoutProduct$Outbound; product_price: ProductPrice$Outbound; subscription_id: string | null; @@ -418,7 +367,7 @@ export const PolarCheckoutSchemasCheckout$outboundSchema: z.ZodType< paymentProcessorMetadata: z.lazy(() => PaymentProcessorMetadata$outboundSchema ), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), product: CheckoutProduct$outboundSchema, productPrice: ProductPrice$outboundSchema, subscriptionId: z.nullable(z.string()), @@ -463,191 +412,3 @@ export namespace PolarCheckoutSchemasCheckout$ { /** @deprecated use `PolarCheckoutSchemasCheckout$Outbound` instead. */ export type Outbound = PolarCheckoutSchemasCheckout$Outbound; } - -/** @internal */ -export const PolarCheckoutSchemasCheckoutInput$inboundSchema: z.ZodType< - PolarCheckoutSchemasCheckoutInput, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - custom_field_data: z.lazy(() => - PolarCheckoutSchemasCheckoutCustomFieldData$inboundSchema - ).optional(), - payment_processor: z.literal("stripe").optional(), - status: CheckoutStatus$inboundSchema, - client_secret: z.string(), - url: z.string(), - expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - success_url: z.string(), - embed_origin: z.nullable(z.string()), - amount: z.nullable(z.number().int()), - tax_amount: z.nullable(z.number().int()), - currency: z.nullable(z.string()), - total_amount: z.nullable(z.number().int()), - product_id: z.string(), - product_price_id: z.string(), - is_payment_required: z.boolean(), - customer_id: z.nullable(z.string()), - customer_name: z.nullable(z.string()), - customer_email: z.nullable(z.string()), - customer_ip_address: z.nullable(z.string()), - customer_billing_address: z.nullable(Address$inboundSchema), - customer_tax_id: z.nullable(z.string()), - payment_processor_metadata: z.lazy(() => - PaymentProcessorMetadata$inboundSchema - ), - metadata: z.record(z.string()), - product: CheckoutProductInput$inboundSchema, - product_price: ProductPrice$inboundSchema, - subscription_id: z.nullable(z.string()), - attached_custom_fields: z.array(AttachedCustomField$inboundSchema), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - "custom_field_data": "customFieldData", - "payment_processor": "paymentProcessor", - "client_secret": "clientSecret", - "expires_at": "expiresAt", - "success_url": "successUrl", - "embed_origin": "embedOrigin", - "tax_amount": "taxAmount", - "total_amount": "totalAmount", - "product_id": "productId", - "product_price_id": "productPriceId", - "is_payment_required": "isPaymentRequired", - "customer_id": "customerId", - "customer_name": "customerName", - "customer_email": "customerEmail", - "customer_ip_address": "customerIpAddress", - "customer_billing_address": "customerBillingAddress", - "customer_tax_id": "customerTaxId", - "payment_processor_metadata": "paymentProcessorMetadata", - "product_price": "productPrice", - "subscription_id": "subscriptionId", - "attached_custom_fields": "attachedCustomFields", - }); -}); - -/** @internal */ -export type PolarCheckoutSchemasCheckoutInput$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - custom_field_data?: - | PolarCheckoutSchemasCheckoutCustomFieldData$Outbound - | undefined; - payment_processor: "stripe"; - status: string; - client_secret: string; - url: string; - expires_at: string; - success_url: string; - embed_origin: string | null; - amount: number | null; - tax_amount: number | null; - currency: string | null; - total_amount: number | null; - product_id: string; - product_price_id: string; - is_payment_required: boolean; - customer_id: string | null; - customer_name: string | null; - customer_email: string | null; - customer_ip_address: string | null; - customer_billing_address: Address$Outbound | null; - customer_tax_id: string | null; - payment_processor_metadata: PaymentProcessorMetadata$Outbound; - metadata: { [k: string]: string }; - product: CheckoutProductInput$Outbound; - product_price: ProductPrice$Outbound; - subscription_id: string | null; - attached_custom_fields: Array; -}; - -/** @internal */ -export const PolarCheckoutSchemasCheckoutInput$outboundSchema: z.ZodType< - PolarCheckoutSchemasCheckoutInput$Outbound, - z.ZodTypeDef, - PolarCheckoutSchemasCheckoutInput -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - customFieldData: z.lazy(() => - PolarCheckoutSchemasCheckoutCustomFieldData$outboundSchema - ).optional(), - paymentProcessor: z.literal("stripe").default("stripe"), - status: CheckoutStatus$outboundSchema, - clientSecret: z.string(), - url: z.string(), - expiresAt: z.date().transform(v => v.toISOString()), - successUrl: z.string(), - embedOrigin: z.nullable(z.string()), - amount: z.nullable(z.number().int()), - taxAmount: z.nullable(z.number().int()), - currency: z.nullable(z.string()), - totalAmount: z.nullable(z.number().int()), - productId: z.string(), - productPriceId: z.string(), - isPaymentRequired: z.boolean(), - customerId: z.nullable(z.string()), - customerName: z.nullable(z.string()), - customerEmail: z.nullable(z.string()), - customerIpAddress: z.nullable(z.string()), - customerBillingAddress: z.nullable(Address$outboundSchema), - customerTaxId: z.nullable(z.string()), - paymentProcessorMetadata: z.lazy(() => - PaymentProcessorMetadata$outboundSchema - ), - metadata: z.record(z.string()), - product: CheckoutProductInput$outboundSchema, - productPrice: ProductPrice$outboundSchema, - subscriptionId: z.nullable(z.string()), - attachedCustomFields: z.array(AttachedCustomField$outboundSchema), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - customFieldData: "custom_field_data", - paymentProcessor: "payment_processor", - clientSecret: "client_secret", - expiresAt: "expires_at", - successUrl: "success_url", - embedOrigin: "embed_origin", - taxAmount: "tax_amount", - totalAmount: "total_amount", - productId: "product_id", - productPriceId: "product_price_id", - isPaymentRequired: "is_payment_required", - customerId: "customer_id", - customerName: "customer_name", - customerEmail: "customer_email", - customerIpAddress: "customer_ip_address", - customerBillingAddress: "customer_billing_address", - customerTaxId: "customer_tax_id", - paymentProcessorMetadata: "payment_processor_metadata", - productPrice: "product_price", - subscriptionId: "subscription_id", - attachedCustomFields: "attached_custom_fields", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace PolarCheckoutSchemasCheckoutInput$ { - /** @deprecated use `PolarCheckoutSchemasCheckoutInput$inboundSchema` instead. */ - export const inboundSchema = PolarCheckoutSchemasCheckoutInput$inboundSchema; - /** @deprecated use `PolarCheckoutSchemasCheckoutInput$outboundSchema` instead. */ - export const outboundSchema = - PolarCheckoutSchemasCheckoutInput$outboundSchema; - /** @deprecated use `PolarCheckoutSchemasCheckoutInput$Outbound` instead. */ - export type Outbound = PolarCheckoutSchemasCheckoutInput$Outbound; -} diff --git a/src/models/components/polarcheckoutschemascheckoutcreate.ts b/src/models/components/polarcheckoutschemascheckoutcreate.ts index 044439ac..9cde0f6c 100644 --- a/src/models/components/polarcheckoutschemascheckoutcreate.ts +++ b/src/models/components/polarcheckoutschemascheckoutcreate.ts @@ -12,6 +12,11 @@ import { Address$outboundSchema, } from "./address.js"; +export type PolarCheckoutSchemasCheckoutCreateMetadata = + | string + | number + | boolean; + /** * Key-value object storing custom field values. */ @@ -20,13 +25,15 @@ export type PolarCheckoutSchemasCheckoutCreateCustomFieldData = {}; /** * Payment processor to use. Currently only Stripe is supported. */ -export const PaymentProcessor = { +export const PolarCheckoutSchemasCheckoutCreatePaymentProcessor = { Stripe: "stripe", } as const; /** * Payment processor to use. Currently only Stripe is supported. */ -export type PaymentProcessor = ClosedEnum; +export type PolarCheckoutSchemasCheckoutCreatePaymentProcessor = ClosedEnum< + typeof PolarCheckoutSchemasCheckoutCreatePaymentProcessor +>; /** * Create a new checkout session. @@ -43,10 +50,14 @@ export type PolarCheckoutSchemasCheckoutCreate = { * @remarks * * The key must be a string with a maximum length of **40 characters**. - * The value must be a string with a maximum length of **500 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * * You can store up to **50 key-value pairs**. */ - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; /** * Key-value object storing custom field values. */ @@ -81,6 +92,40 @@ export type PolarCheckoutSchemasCheckoutCreate = { embedOrigin?: string | null | undefined; }; +/** @internal */ +export const PolarCheckoutSchemasCheckoutCreateMetadata$inboundSchema: + z.ZodType = + z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type PolarCheckoutSchemasCheckoutCreateMetadata$Outbound = + | string + | number + | boolean; + +/** @internal */ +export const PolarCheckoutSchemasCheckoutCreateMetadata$outboundSchema: + z.ZodType< + PolarCheckoutSchemasCheckoutCreateMetadata$Outbound, + z.ZodTypeDef, + PolarCheckoutSchemasCheckoutCreateMetadata + > = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace PolarCheckoutSchemasCheckoutCreateMetadata$ { + /** @deprecated use `PolarCheckoutSchemasCheckoutCreateMetadata$inboundSchema` instead. */ + export const inboundSchema = + PolarCheckoutSchemasCheckoutCreateMetadata$inboundSchema; + /** @deprecated use `PolarCheckoutSchemasCheckoutCreateMetadata$outboundSchema` instead. */ + export const outboundSchema = + PolarCheckoutSchemasCheckoutCreateMetadata$outboundSchema; + /** @deprecated use `PolarCheckoutSchemasCheckoutCreateMetadata$Outbound` instead. */ + export type Outbound = PolarCheckoutSchemasCheckoutCreateMetadata$Outbound; +} + /** @internal */ export const PolarCheckoutSchemasCheckoutCreateCustomFieldData$inboundSchema: z.ZodType< @@ -117,24 +162,26 @@ export namespace PolarCheckoutSchemasCheckoutCreateCustomFieldData$ { } /** @internal */ -export const PaymentProcessor$inboundSchema: z.ZodNativeEnum< - typeof PaymentProcessor -> = z.nativeEnum(PaymentProcessor); +export const PolarCheckoutSchemasCheckoutCreatePaymentProcessor$inboundSchema: + z.ZodNativeEnum = z + .nativeEnum(PolarCheckoutSchemasCheckoutCreatePaymentProcessor); /** @internal */ -export const PaymentProcessor$outboundSchema: z.ZodNativeEnum< - typeof PaymentProcessor -> = PaymentProcessor$inboundSchema; +export const PolarCheckoutSchemasCheckoutCreatePaymentProcessor$outboundSchema: + z.ZodNativeEnum = + PolarCheckoutSchemasCheckoutCreatePaymentProcessor$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace PaymentProcessor$ { - /** @deprecated use `PaymentProcessor$inboundSchema` instead. */ - export const inboundSchema = PaymentProcessor$inboundSchema; - /** @deprecated use `PaymentProcessor$outboundSchema` instead. */ - export const outboundSchema = PaymentProcessor$outboundSchema; +export namespace PolarCheckoutSchemasCheckoutCreatePaymentProcessor$ { + /** @deprecated use `PolarCheckoutSchemasCheckoutCreatePaymentProcessor$inboundSchema` instead. */ + export const inboundSchema = + PolarCheckoutSchemasCheckoutCreatePaymentProcessor$inboundSchema; + /** @deprecated use `PolarCheckoutSchemasCheckoutCreatePaymentProcessor$outboundSchema` instead. */ + export const outboundSchema = + PolarCheckoutSchemasCheckoutCreatePaymentProcessor$outboundSchema; } /** @internal */ @@ -143,7 +190,8 @@ export const PolarCheckoutSchemasCheckoutCreate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), custom_field_data: z.lazy(() => PolarCheckoutSchemasCheckoutCreateCustomFieldData$inboundSchema ).optional(), @@ -176,7 +224,7 @@ export const PolarCheckoutSchemasCheckoutCreate$inboundSchema: z.ZodType< /** @internal */ export type PolarCheckoutSchemasCheckoutCreate$Outbound = { - metadata?: { [k: string]: string } | undefined; + metadata?: { [k: string]: string | number | boolean } | undefined; custom_field_data?: | PolarCheckoutSchemasCheckoutCreateCustomFieldData$Outbound | undefined; @@ -199,7 +247,8 @@ export const PolarCheckoutSchemasCheckoutCreate$outboundSchema: z.ZodType< z.ZodTypeDef, PolarCheckoutSchemasCheckoutCreate > = z.object({ - metadata: z.record(z.string()).optional(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), customFieldData: z.lazy(() => PolarCheckoutSchemasCheckoutCreateCustomFieldData$outboundSchema ).optional(), diff --git a/src/models/components/polarenumspaymentprocessor.ts b/src/models/components/polarenumspaymentprocessor.ts deleted file mode 100644 index 734829ab..00000000 --- a/src/models/components/polarenumspaymentprocessor.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; - -export const PolarEnumsPaymentProcessor = { - Stripe: "stripe", -} as const; -export type PolarEnumsPaymentProcessor = ClosedEnum< - typeof PolarEnumsPaymentProcessor ->; - -/** @internal */ -export const PolarEnumsPaymentProcessor$inboundSchema: z.ZodNativeEnum< - typeof PolarEnumsPaymentProcessor -> = z.nativeEnum(PolarEnumsPaymentProcessor); - -/** @internal */ -export const PolarEnumsPaymentProcessor$outboundSchema: z.ZodNativeEnum< - typeof PolarEnumsPaymentProcessor -> = PolarEnumsPaymentProcessor$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace PolarEnumsPaymentProcessor$ { - /** @deprecated use `PolarEnumsPaymentProcessor$inboundSchema` instead. */ - export const inboundSchema = PolarEnumsPaymentProcessor$inboundSchema; - /** @deprecated use `PolarEnumsPaymentProcessor$outboundSchema` instead. */ - export const outboundSchema = PolarEnumsPaymentProcessor$outboundSchema; -} diff --git a/src/models/components/product.ts b/src/models/components/product.ts index c3a198b7..434409e0 100644 --- a/src/models/components/product.ts +++ b/src/models/components/product.ts @@ -29,6 +29,8 @@ import { ProductPrice$outboundSchema, } from "./productprice.js"; +export type ProductMetadata = string | number | boolean; + /** * A product. */ @@ -65,6 +67,7 @@ export type Product = { * The ID of the organization owning the product. */ organizationId: string; + metadata: { [k: string]: string | number | boolean }; /** * List of prices for this product. */ @@ -83,6 +86,36 @@ export type Product = { attachedCustomFields: Array; }; +/** @internal */ +export const ProductMetadata$inboundSchema: z.ZodType< + ProductMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type ProductMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const ProductMetadata$outboundSchema: z.ZodType< + ProductMetadata$Outbound, + z.ZodTypeDef, + ProductMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ProductMetadata$ { + /** @deprecated use `ProductMetadata$inboundSchema` instead. */ + export const inboundSchema = ProductMetadata$inboundSchema; + /** @deprecated use `ProductMetadata$outboundSchema` instead. */ + export const outboundSchema = ProductMetadata$outboundSchema; + /** @deprecated use `ProductMetadata$Outbound` instead. */ + export type Outbound = ProductMetadata$Outbound; +} + /** @internal */ export const Product$inboundSchema: z.ZodType = z.object({ @@ -98,6 +131,7 @@ export const Product$inboundSchema: z.ZodType = is_recurring: z.boolean(), is_archived: z.boolean(), organization_id: z.string(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), prices: z.array(ProductPrice$inboundSchema), benefits: z.array(Benefit$inboundSchema), medias: z.array(ProductMediaFileRead$inboundSchema), @@ -123,6 +157,7 @@ export type Product$Outbound = { is_recurring: boolean; is_archived: boolean; organization_id: string; + metadata: { [k: string]: string | number | boolean }; prices: Array; benefits: Array; medias: Array; @@ -143,6 +178,7 @@ export const Product$outboundSchema: z.ZodType< isRecurring: z.boolean(), isArchived: z.boolean(), organizationId: z.string(), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), prices: z.array(ProductPrice$outboundSchema), benefits: z.array(Benefit$outboundSchema), medias: z.array(ProductMediaFileRead$outboundSchema), diff --git a/src/models/components/productinput.ts b/src/models/components/productinput.ts deleted file mode 100644 index bbe2cfec..00000000 --- a/src/models/components/productinput.ts +++ /dev/null @@ -1,173 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { remap as remap$ } from "../../lib/primitives.js"; -import { - AttachedCustomField, - AttachedCustomField$inboundSchema, - AttachedCustomField$Outbound, - AttachedCustomField$outboundSchema, -} from "./attachedcustomfield.js"; -import { - BenefitInput, - BenefitInput$inboundSchema, - BenefitInput$Outbound, - BenefitInput$outboundSchema, -} from "./benefitinput.js"; -import { - ProductMediaFileReadInput, - ProductMediaFileReadInput$inboundSchema, - ProductMediaFileReadInput$Outbound, - ProductMediaFileReadInput$outboundSchema, -} from "./productmediafileread.js"; -import { - ProductPrice, - ProductPrice$inboundSchema, - ProductPrice$Outbound, - ProductPrice$outboundSchema, -} from "./productprice.js"; - -/** - * A product. - */ -export type ProductInput = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the product. - */ - id: string; - /** - * The name of the product. - */ - name: string; - /** - * The description of the product. - */ - description: string | null; - /** - * Whether the product is a subscription tier. - */ - isRecurring: boolean; - /** - * Whether the product is archived and no longer available. - */ - isArchived: boolean; - /** - * The ID of the organization owning the product. - */ - organizationId: string; - /** - * List of prices for this product. - */ - prices: Array; - /** - * List of benefits granted by the product. - */ - benefits: Array; - /** - * List of medias associated to the product. - */ - medias: Array; - /** - * List of custom fields attached to the product. - */ - attachedCustomFields: Array; -}; - -/** @internal */ -export const ProductInput$inboundSchema: z.ZodType< - ProductInput, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - name: z.string(), - description: z.nullable(z.string()), - is_recurring: z.boolean(), - is_archived: z.boolean(), - organization_id: z.string(), - prices: z.array(ProductPrice$inboundSchema), - benefits: z.array(BenefitInput$inboundSchema), - medias: z.array(ProductMediaFileReadInput$inboundSchema), - attached_custom_fields: z.array(AttachedCustomField$inboundSchema), -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - "is_recurring": "isRecurring", - "is_archived": "isArchived", - "organization_id": "organizationId", - "attached_custom_fields": "attachedCustomFields", - }); -}); - -/** @internal */ -export type ProductInput$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - name: string; - description: string | null; - is_recurring: boolean; - is_archived: boolean; - organization_id: string; - prices: Array; - benefits: Array; - medias: Array; - attached_custom_fields: Array; -}; - -/** @internal */ -export const ProductInput$outboundSchema: z.ZodType< - ProductInput$Outbound, - z.ZodTypeDef, - ProductInput -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - name: z.string(), - description: z.nullable(z.string()), - isRecurring: z.boolean(), - isArchived: z.boolean(), - organizationId: z.string(), - prices: z.array(ProductPrice$outboundSchema), - benefits: z.array(BenefitInput$outboundSchema), - medias: z.array(ProductMediaFileReadInput$outboundSchema), - attachedCustomFields: z.array(AttachedCustomField$outboundSchema), -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - isRecurring: "is_recurring", - isArchived: "is_archived", - organizationId: "organization_id", - attachedCustomFields: "attached_custom_fields", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ProductInput$ { - /** @deprecated use `ProductInput$inboundSchema` instead. */ - export const inboundSchema = ProductInput$inboundSchema; - /** @deprecated use `ProductInput$outboundSchema` instead. */ - export const outboundSchema = ProductInput$outboundSchema; - /** @deprecated use `ProductInput$Outbound` instead. */ - export type Outbound = ProductInput$Outbound; -} diff --git a/src/models/components/productmediafileread.ts b/src/models/components/productmediafileread.ts index a6731ef7..4ff74454 100644 --- a/src/models/components/productmediafileread.ts +++ b/src/models/components/productmediafileread.ts @@ -37,30 +37,6 @@ export type ProductMediaFileRead = { publicUrl: string; }; -/** - * File to be used as a product media file. - */ -export type ProductMediaFileReadInput = { - /** - * The ID of the object. - */ - id: string; - organizationId: string; - name: string; - path: string; - mimeType: string; - size: number; - storageVersion: string | null; - checksumEtag: string | null; - checksumSha256Base64: string | null; - checksumSha256Hex: string | null; - lastModifiedAt: Date | null; - version: string | null; - service?: "product_media" | undefined; - isUploaded: boolean; - createdAt: Date; -}; - /** @internal */ export const Service$inboundSchema: z.ZodNativeEnum = z .nativeEnum(Service); @@ -193,107 +169,3 @@ export namespace ProductMediaFileRead$ { /** @deprecated use `ProductMediaFileRead$Outbound` instead. */ export type Outbound = ProductMediaFileRead$Outbound; } - -/** @internal */ -export const ProductMediaFileReadInput$inboundSchema: z.ZodType< - ProductMediaFileReadInput, - z.ZodTypeDef, - unknown -> = z.object({ - id: z.string(), - organization_id: z.string(), - name: z.string(), - path: z.string(), - mime_type: z.string(), - size: z.number().int(), - storage_version: z.nullable(z.string()), - checksum_etag: z.nullable(z.string()), - checksum_sha256_base64: z.nullable(z.string()), - checksum_sha256_hex: z.nullable(z.string()), - last_modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - version: z.nullable(z.string()), - service: z.literal("product_media").optional(), - is_uploaded: z.boolean(), - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), -}).transform((v) => { - return remap$(v, { - "organization_id": "organizationId", - "mime_type": "mimeType", - "storage_version": "storageVersion", - "checksum_etag": "checksumEtag", - "checksum_sha256_base64": "checksumSha256Base64", - "checksum_sha256_hex": "checksumSha256Hex", - "last_modified_at": "lastModifiedAt", - "is_uploaded": "isUploaded", - "created_at": "createdAt", - }); -}); - -/** @internal */ -export type ProductMediaFileReadInput$Outbound = { - id: string; - organization_id: string; - name: string; - path: string; - mime_type: string; - size: number; - storage_version: string | null; - checksum_etag: string | null; - checksum_sha256_base64: string | null; - checksum_sha256_hex: string | null; - last_modified_at: string | null; - version: string | null; - service: "product_media"; - is_uploaded: boolean; - created_at: string; -}; - -/** @internal */ -export const ProductMediaFileReadInput$outboundSchema: z.ZodType< - ProductMediaFileReadInput$Outbound, - z.ZodTypeDef, - ProductMediaFileReadInput -> = z.object({ - id: z.string(), - organizationId: z.string(), - name: z.string(), - path: z.string(), - mimeType: z.string(), - size: z.number().int(), - storageVersion: z.nullable(z.string()), - checksumEtag: z.nullable(z.string()), - checksumSha256Base64: z.nullable(z.string()), - checksumSha256Hex: z.nullable(z.string()), - lastModifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - version: z.nullable(z.string()), - service: z.literal("product_media").default("product_media"), - isUploaded: z.boolean(), - createdAt: z.date().transform(v => v.toISOString()), -}).transform((v) => { - return remap$(v, { - organizationId: "organization_id", - mimeType: "mime_type", - storageVersion: "storage_version", - checksumEtag: "checksum_etag", - checksumSha256Base64: "checksum_sha256_base64", - checksumSha256Hex: "checksum_sha256_hex", - lastModifiedAt: "last_modified_at", - isUploaded: "is_uploaded", - createdAt: "created_at", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ProductMediaFileReadInput$ { - /** @deprecated use `ProductMediaFileReadInput$inboundSchema` instead. */ - export const inboundSchema = ProductMediaFileReadInput$inboundSchema; - /** @deprecated use `ProductMediaFileReadInput$outboundSchema` instead. */ - export const outboundSchema = ProductMediaFileReadInput$outboundSchema; - /** @deprecated use `ProductMediaFileReadInput$Outbound` instead. */ - export type Outbound = ProductMediaFileReadInput$Outbound; -} diff --git a/src/models/components/productonetimecreate.ts b/src/models/components/productonetimecreate.ts index 50795a9b..ce0937c5 100644 --- a/src/models/components/productonetimecreate.ts +++ b/src/models/components/productonetimecreate.ts @@ -29,6 +29,8 @@ import { ProductPriceOneTimeFreeCreate$outboundSchema, } from "./productpriceonetimefreecreate.js"; +export type ProductOneTimeCreateMetadata = string | number | boolean; + export type Prices = | ProductPriceOneTimeFreeCreate | ProductPriceOneTimeFixedCreate @@ -38,6 +40,20 @@ export type Prices = * Schema to create a one-time product. */ export type ProductOneTimeCreate = { + /** + * Key-value object allowing you to store additional information. + * + * @remarks + * + * The key must be a string with a maximum length of **40 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * + * You can store up to **50 key-value pairs**. + */ + metadata?: { [k: string]: string | number | boolean } | undefined; /** * The name of the product. */ @@ -68,6 +84,36 @@ export type ProductOneTimeCreate = { organizationId?: string | null | undefined; }; +/** @internal */ +export const ProductOneTimeCreateMetadata$inboundSchema: z.ZodType< + ProductOneTimeCreateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type ProductOneTimeCreateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const ProductOneTimeCreateMetadata$outboundSchema: z.ZodType< + ProductOneTimeCreateMetadata$Outbound, + z.ZodTypeDef, + ProductOneTimeCreateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ProductOneTimeCreateMetadata$ { + /** @deprecated use `ProductOneTimeCreateMetadata$inboundSchema` instead. */ + export const inboundSchema = ProductOneTimeCreateMetadata$inboundSchema; + /** @deprecated use `ProductOneTimeCreateMetadata$outboundSchema` instead. */ + export const outboundSchema = ProductOneTimeCreateMetadata$outboundSchema; + /** @deprecated use `ProductOneTimeCreateMetadata$Outbound` instead. */ + export type Outbound = ProductOneTimeCreateMetadata$Outbound; +} + /** @internal */ export const Prices$inboundSchema: z.ZodType = z .union([ @@ -112,6 +158,8 @@ export const ProductOneTimeCreate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), name: z.string(), description: z.nullable(z.string()).optional(), prices: z.array( @@ -134,6 +182,7 @@ export const ProductOneTimeCreate$inboundSchema: z.ZodType< /** @internal */ export type ProductOneTimeCreate$Outbound = { + metadata?: { [k: string]: string | number | boolean } | undefined; name: string; description?: string | null | undefined; prices: Array< @@ -154,6 +203,8 @@ export const ProductOneTimeCreate$outboundSchema: z.ZodType< z.ZodTypeDef, ProductOneTimeCreate > = z.object({ + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), name: z.string(), description: z.nullable(z.string()).optional(), prices: z.array( diff --git a/src/models/components/productrecurringcreate.ts b/src/models/components/productrecurringcreate.ts index 8d6dafbf..2fe7dc2f 100644 --- a/src/models/components/productrecurringcreate.ts +++ b/src/models/components/productrecurringcreate.ts @@ -23,6 +23,8 @@ import { ProductPriceRecurringFreeCreate$outboundSchema, } from "./productpricerecurringfreecreate.js"; +export type ProductRecurringCreateMetadata = string | number | boolean; + /** * List of available prices for this product. */ @@ -34,6 +36,20 @@ export type ProductRecurringCreatePrices = * Schema to create a recurring product, i.e. a subscription. */ export type ProductRecurringCreate = { + /** + * Key-value object allowing you to store additional information. + * + * @remarks + * + * The key must be a string with a maximum length of **40 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * + * You can store up to **50 key-value pairs**. + */ + metadata?: { [k: string]: string | number | boolean } | undefined; /** * The name of the product. */ @@ -62,6 +78,36 @@ export type ProductRecurringCreate = { organizationId?: string | null | undefined; }; +/** @internal */ +export const ProductRecurringCreateMetadata$inboundSchema: z.ZodType< + ProductRecurringCreateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type ProductRecurringCreateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const ProductRecurringCreateMetadata$outboundSchema: z.ZodType< + ProductRecurringCreateMetadata$Outbound, + z.ZodTypeDef, + ProductRecurringCreateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ProductRecurringCreateMetadata$ { + /** @deprecated use `ProductRecurringCreateMetadata$inboundSchema` instead. */ + export const inboundSchema = ProductRecurringCreateMetadata$inboundSchema; + /** @deprecated use `ProductRecurringCreateMetadata$outboundSchema` instead. */ + export const outboundSchema = ProductRecurringCreateMetadata$outboundSchema; + /** @deprecated use `ProductRecurringCreateMetadata$Outbound` instead. */ + export type Outbound = ProductRecurringCreateMetadata$Outbound; +} + /** @internal */ export const ProductRecurringCreatePrices$inboundSchema: z.ZodType< ProductRecurringCreatePrices, @@ -106,6 +152,8 @@ export const ProductRecurringCreate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), name: z.string(), description: z.nullable(z.string()).optional(), prices: z.union([ @@ -125,6 +173,7 @@ export const ProductRecurringCreate$inboundSchema: z.ZodType< /** @internal */ export type ProductRecurringCreate$Outbound = { + metadata?: { [k: string]: string | number | boolean } | undefined; name: string; description?: string | null | undefined; prices: @@ -143,6 +192,8 @@ export const ProductRecurringCreate$outboundSchema: z.ZodType< z.ZodTypeDef, ProductRecurringCreate > = z.object({ + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])) + .optional(), name: z.string(), description: z.nullable(z.string()).optional(), prices: z.union([ diff --git a/src/models/components/productupdate.ts b/src/models/components/productupdate.ts index c38cfe19..8f04833c 100644 --- a/src/models/components/productupdate.ts +++ b/src/models/components/productupdate.ts @@ -47,6 +47,8 @@ import { ProductPriceRecurringFreeCreate$outboundSchema, } from "./productpricerecurringfreecreate.js"; +export type ProductUpdateMetadata = string | number | boolean; + export type ProductUpdatePrices = | ExistingProductPrice | ProductPriceOneTimeFreeCreate @@ -59,6 +61,20 @@ export type ProductUpdatePrices = * Schema to update a product. */ export type ProductUpdate = { + /** + * Key-value object allowing you to store additional information. + * + * @remarks + * + * The key must be a string with a maximum length of **40 characters**. + * The value must be either: + * * A string with a maximum length of **500 characters** + * * An integer + * * A boolean + * + * You can store up to **50 key-value pairs**. + */ + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; /** * The description of the product. @@ -89,6 +105,36 @@ export type ProductUpdate = { attachedCustomFields?: Array | null | undefined; }; +/** @internal */ +export const ProductUpdateMetadata$inboundSchema: z.ZodType< + ProductUpdateMetadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type ProductUpdateMetadata$Outbound = string | number | boolean; + +/** @internal */ +export const ProductUpdateMetadata$outboundSchema: z.ZodType< + ProductUpdateMetadata$Outbound, + z.ZodTypeDef, + ProductUpdateMetadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ProductUpdateMetadata$ { + /** @deprecated use `ProductUpdateMetadata$inboundSchema` instead. */ + export const inboundSchema = ProductUpdateMetadata$inboundSchema; + /** @deprecated use `ProductUpdateMetadata$outboundSchema` instead. */ + export const outboundSchema = ProductUpdateMetadata$outboundSchema; + /** @deprecated use `ProductUpdateMetadata$Outbound` instead. */ + export type Outbound = ProductUpdateMetadata$Outbound; +} + /** @internal */ export const ProductUpdatePrices$inboundSchema: z.ZodType< ProductUpdatePrices, @@ -145,6 +191,9 @@ export const ProductUpdate$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), description: z.nullable(z.string()).optional(), is_archived: z.nullable(z.boolean()).optional(), @@ -173,6 +222,7 @@ export const ProductUpdate$inboundSchema: z.ZodType< /** @internal */ export type ProductUpdate$Outbound = { + metadata?: { [k: string]: string | number | boolean } | null | undefined; name?: string | null | undefined; description?: string | null | undefined; is_archived?: boolean | null | undefined; @@ -200,6 +250,9 @@ export const ProductUpdate$outboundSchema: z.ZodType< z.ZodTypeDef, ProductUpdate > = z.object({ + metadata: z.nullable( + z.record(z.union([z.string(), z.number().int(), z.boolean()])), + ).optional(), name: z.nullable(z.string()).optional(), description: z.nullable(z.string()).optional(), isArchived: z.nullable(z.boolean()).optional(), diff --git a/src/models/components/scope.ts b/src/models/components/scope.ts new file mode 100644 index 00000000..794fdc69 --- /dev/null +++ b/src/models/components/scope.ts @@ -0,0 +1,73 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; + +export const Scope = { + Openid: "openid", + Profile: "profile", + Email: "email", + UserRead: "user:read", + Admin: "admin", + WebDefault: "web_default", + OrganizationsRead: "organizations:read", + OrganizationsWrite: "organizations:write", + CustomFieldsRead: "custom_fields:read", + CustomFieldsWrite: "custom_fields:write", + CheckoutLinksRead: "checkout_links:read", + CheckoutLinksWrite: "checkout_links:write", + CheckoutsRead: "checkouts:read", + CheckoutsWrite: "checkouts:write", + ProductsRead: "products:read", + ProductsWrite: "products:write", + BenefitsRead: "benefits:read", + BenefitsWrite: "benefits:write", + FilesRead: "files:read", + FilesWrite: "files:write", + SubscriptionsRead: "subscriptions:read", + SubscriptionsWrite: "subscriptions:write", + OrdersRead: "orders:read", + MetricsRead: "metrics:read", + ArticlesRead: "articles:read", + ArticlesWrite: "articles:write", + WebhooksRead: "webhooks:read", + WebhooksWrite: "webhooks:write", + ExternalOrganizationsRead: "external_organizations:read", + LicenseKeysRead: "license_keys:read", + LicenseKeysWrite: "license_keys:write", + RepositoriesRead: "repositories:read", + RepositoriesWrite: "repositories:write", + IssuesRead: "issues:read", + IssuesWrite: "issues:write", + UserBenefitsRead: "user:benefits:read", + UserOrdersRead: "user:orders:read", + UserSubscriptionsRead: "user:subscriptions:read", + UserSubscriptionsWrite: "user:subscriptions:write", + UserDownloadablesRead: "user:downloadables:read", + UserLicenseKeysRead: "user:license_keys:read", + UserAdvertisementCampaignsRead: "user:advertisement_campaigns:read", + UserAdvertisementCampaignsWrite: "user:advertisement_campaigns:write", +} as const; +export type Scope = ClosedEnum; + +/** @internal */ +export const Scope$inboundSchema: z.ZodNativeEnum = z.nativeEnum( + Scope, +); + +/** @internal */ +export const Scope$outboundSchema: z.ZodNativeEnum = + Scope$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Scope$ { + /** @deprecated use `Scope$inboundSchema` instead. */ + export const inboundSchema = Scope$inboundSchema; + /** @deprecated use `Scope$outboundSchema` instead. */ + export const outboundSchema = Scope$outboundSchema; +} diff --git a/src/models/components/subscription.ts b/src/models/components/subscription.ts index 4f41d599..517a4f96 100644 --- a/src/models/components/subscription.ts +++ b/src/models/components/subscription.ts @@ -10,12 +10,6 @@ import { Product$Outbound, Product$outboundSchema, } from "./product.js"; -import { - ProductInput, - ProductInput$inboundSchema, - ProductInput$Outbound, - ProductInput$outboundSchema, -} from "./productinput.js"; import { ProductPriceRecurring, ProductPriceRecurring$inboundSchema, @@ -39,6 +33,8 @@ import { SubscriptionUser$outboundSchema, } from "./subscriptionuser.js"; +export type Metadata = string | number | boolean; + /** * Key-value object storing custom field values. */ @@ -70,7 +66,7 @@ export type Subscription = { productId: string; priceId: string; checkoutId: string | null; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; /** * Key-value object storing custom field values. */ @@ -83,44 +79,35 @@ export type Subscription = { price: ProductPriceRecurring; }; -export type SubscriptionInput = { - /** - * Creation timestamp of the object. - */ - createdAt: Date; - /** - * Last modification timestamp of the object. - */ - modifiedAt: Date | null; - /** - * The ID of the object. - */ - id: string; - amount: number | null; - currency: string | null; - recurringInterval: SubscriptionRecurringInterval; - status: SubscriptionStatus; - currentPeriodStart: Date; - currentPeriodEnd: Date | null; - cancelAtPeriodEnd: boolean; - startedAt: Date | null; - endedAt: Date | null; - userId: string; - productId: string; - priceId: string; - checkoutId: string | null; - metadata: { [k: string]: string }; - /** - * Key-value object storing custom field values. - */ - customFieldData?: SubscriptionCustomFieldData | undefined; - user: SubscriptionUser; - /** - * A product. - */ - product: ProductInput; - price: ProductPriceRecurring; -}; +/** @internal */ +export const Metadata$inboundSchema: z.ZodType< + Metadata, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** @internal */ +export type Metadata$Outbound = string | number | boolean; + +/** @internal */ +export const Metadata$outboundSchema: z.ZodType< + Metadata$Outbound, + z.ZodTypeDef, + Metadata +> = z.union([z.string(), z.number().int(), z.boolean()]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Metadata$ { + /** @deprecated use `Metadata$inboundSchema` instead. */ + export const inboundSchema = Metadata$inboundSchema; + /** @deprecated use `Metadata$outboundSchema` instead. */ + export const outboundSchema = Metadata$outboundSchema; + /** @deprecated use `Metadata$Outbound` instead. */ + export type Outbound = Metadata$Outbound; +} /** @internal */ export const SubscriptionCustomFieldData$inboundSchema: z.ZodType< @@ -184,7 +171,7 @@ export const Subscription$inboundSchema: z.ZodType< product_id: z.string(), price_id: z.string(), checkout_id: z.nullable(z.string()), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), custom_field_data: z.lazy(() => SubscriptionCustomFieldData$inboundSchema) .optional(), user: SubscriptionUser$inboundSchema, @@ -226,7 +213,7 @@ export type Subscription$Outbound = { product_id: string; price_id: string; checkout_id: string | null; - metadata: { [k: string]: string }; + metadata: { [k: string]: string | number | boolean }; custom_field_data?: SubscriptionCustomFieldData$Outbound | undefined; user: SubscriptionUser$Outbound; product: Product$Outbound; @@ -255,7 +242,7 @@ export const Subscription$outboundSchema: z.ZodType< productId: z.string(), priceId: z.string(), checkoutId: z.nullable(z.string()), - metadata: z.record(z.string()), + metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])), customFieldData: z.lazy(() => SubscriptionCustomFieldData$outboundSchema) .optional(), user: SubscriptionUser$outboundSchema, @@ -291,143 +278,3 @@ export namespace Subscription$ { /** @deprecated use `Subscription$Outbound` instead. */ export type Outbound = Subscription$Outbound; } - -/** @internal */ -export const SubscriptionInput$inboundSchema: z.ZodType< - SubscriptionInput, - z.ZodTypeDef, - unknown -> = z.object({ - created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)), - modified_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - id: z.string(), - amount: z.nullable(z.number().int()), - currency: z.nullable(z.string()), - recurring_interval: SubscriptionRecurringInterval$inboundSchema, - status: SubscriptionStatus$inboundSchema, - current_period_start: z.string().datetime({ offset: true }).transform(v => - new Date(v) - ), - current_period_end: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - cancel_at_period_end: z.boolean(), - started_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - ended_at: z.nullable( - z.string().datetime({ offset: true }).transform(v => new Date(v)), - ), - user_id: z.string(), - product_id: z.string(), - price_id: z.string(), - checkout_id: z.nullable(z.string()), - metadata: z.record(z.string()), - custom_field_data: z.lazy(() => SubscriptionCustomFieldData$inboundSchema) - .optional(), - user: SubscriptionUser$inboundSchema, - product: ProductInput$inboundSchema, - price: ProductPriceRecurring$inboundSchema, -}).transform((v) => { - return remap$(v, { - "created_at": "createdAt", - "modified_at": "modifiedAt", - "recurring_interval": "recurringInterval", - "current_period_start": "currentPeriodStart", - "current_period_end": "currentPeriodEnd", - "cancel_at_period_end": "cancelAtPeriodEnd", - "started_at": "startedAt", - "ended_at": "endedAt", - "user_id": "userId", - "product_id": "productId", - "price_id": "priceId", - "checkout_id": "checkoutId", - "custom_field_data": "customFieldData", - }); -}); - -/** @internal */ -export type SubscriptionInput$Outbound = { - created_at: string; - modified_at: string | null; - id: string; - amount: number | null; - currency: string | null; - recurring_interval: string; - status: string; - current_period_start: string; - current_period_end: string | null; - cancel_at_period_end: boolean; - started_at: string | null; - ended_at: string | null; - user_id: string; - product_id: string; - price_id: string; - checkout_id: string | null; - metadata: { [k: string]: string }; - custom_field_data?: SubscriptionCustomFieldData$Outbound | undefined; - user: SubscriptionUser$Outbound; - product: ProductInput$Outbound; - price: ProductPriceRecurring$Outbound; -}; - -/** @internal */ -export const SubscriptionInput$outboundSchema: z.ZodType< - SubscriptionInput$Outbound, - z.ZodTypeDef, - SubscriptionInput -> = z.object({ - createdAt: z.date().transform(v => v.toISOString()), - modifiedAt: z.nullable(z.date().transform(v => v.toISOString())), - id: z.string(), - amount: z.nullable(z.number().int()), - currency: z.nullable(z.string()), - recurringInterval: SubscriptionRecurringInterval$outboundSchema, - status: SubscriptionStatus$outboundSchema, - currentPeriodStart: z.date().transform(v => v.toISOString()), - currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())), - cancelAtPeriodEnd: z.boolean(), - startedAt: z.nullable(z.date().transform(v => v.toISOString())), - endedAt: z.nullable(z.date().transform(v => v.toISOString())), - userId: z.string(), - productId: z.string(), - priceId: z.string(), - checkoutId: z.nullable(z.string()), - metadata: z.record(z.string()), - customFieldData: z.lazy(() => SubscriptionCustomFieldData$outboundSchema) - .optional(), - user: SubscriptionUser$outboundSchema, - product: ProductInput$outboundSchema, - price: ProductPriceRecurring$outboundSchema, -}).transform((v) => { - return remap$(v, { - createdAt: "created_at", - modifiedAt: "modified_at", - recurringInterval: "recurring_interval", - currentPeriodStart: "current_period_start", - currentPeriodEnd: "current_period_end", - cancelAtPeriodEnd: "cancel_at_period_end", - startedAt: "started_at", - endedAt: "ended_at", - userId: "user_id", - productId: "product_id", - priceId: "price_id", - checkoutId: "checkout_id", - customFieldData: "custom_field_data", - }); -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace SubscriptionInput$ { - /** @deprecated use `SubscriptionInput$inboundSchema` instead. */ - export const inboundSchema = SubscriptionInput$inboundSchema; - /** @deprecated use `SubscriptionInput$outboundSchema` instead. */ - export const outboundSchema = SubscriptionInput$outboundSchema; - /** @deprecated use `SubscriptionInput$Outbound` instead. */ - export type Outbound = SubscriptionInput$Outbound; -} diff --git a/src/models/components/webhookbenefitcreatedpayload.ts b/src/models/components/webhookbenefitcreatedpayload.ts index a702ad55..05bfe4d0 100644 --- a/src/models/components/webhookbenefitcreatedpayload.ts +++ b/src/models/components/webhookbenefitcreatedpayload.ts @@ -5,11 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - BenefitInput, - BenefitInput$inboundSchema, - BenefitInput$Outbound, - BenefitInput$outboundSchema, -} from "./benefitinput.js"; + Benefit, + Benefit$inboundSchema, + Benefit$Outbound, + Benefit$outboundSchema, +} from "./benefit.js"; export const WebhookBenefitCreatedPayloadType = { BenefitCreated: "benefit.created", @@ -27,7 +27,7 @@ export type WebhookBenefitCreatedPayloadType = ClosedEnum< */ export type WebhookBenefitCreatedPayload = { type?: "benefit.created" | undefined; - data: BenefitInput; + data: Benefit; }; /** @internal */ @@ -58,13 +58,13 @@ export const WebhookBenefitCreatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("benefit.created").optional(), - data: BenefitInput$inboundSchema, + data: Benefit$inboundSchema, }); /** @internal */ export type WebhookBenefitCreatedPayload$Outbound = { type: "benefit.created"; - data: BenefitInput$Outbound; + data: Benefit$Outbound; }; /** @internal */ @@ -74,7 +74,7 @@ export const WebhookBenefitCreatedPayload$outboundSchema: z.ZodType< WebhookBenefitCreatedPayload > = z.object({ type: z.literal("benefit.created").default("benefit.created"), - data: BenefitInput$outboundSchema, + data: Benefit$outboundSchema, }); /** diff --git a/src/models/components/webhookbenefitupdatedpayload.ts b/src/models/components/webhookbenefitupdatedpayload.ts index 20c89781..682416ff 100644 --- a/src/models/components/webhookbenefitupdatedpayload.ts +++ b/src/models/components/webhookbenefitupdatedpayload.ts @@ -5,11 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - BenefitInput, - BenefitInput$inboundSchema, - BenefitInput$Outbound, - BenefitInput$outboundSchema, -} from "./benefitinput.js"; + Benefit, + Benefit$inboundSchema, + Benefit$Outbound, + Benefit$outboundSchema, +} from "./benefit.js"; export const WebhookBenefitUpdatedPayloadType = { BenefitUpdated: "benefit.updated", @@ -27,7 +27,7 @@ export type WebhookBenefitUpdatedPayloadType = ClosedEnum< */ export type WebhookBenefitUpdatedPayload = { type?: "benefit.updated" | undefined; - data: BenefitInput; + data: Benefit; }; /** @internal */ @@ -58,13 +58,13 @@ export const WebhookBenefitUpdatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("benefit.updated").optional(), - data: BenefitInput$inboundSchema, + data: Benefit$inboundSchema, }); /** @internal */ export type WebhookBenefitUpdatedPayload$Outbound = { type: "benefit.updated"; - data: BenefitInput$Outbound; + data: Benefit$Outbound; }; /** @internal */ @@ -74,7 +74,7 @@ export const WebhookBenefitUpdatedPayload$outboundSchema: z.ZodType< WebhookBenefitUpdatedPayload > = z.object({ type: z.literal("benefit.updated").default("benefit.updated"), - data: BenefitInput$outboundSchema, + data: Benefit$outboundSchema, }); /** diff --git a/src/models/components/webhookcheckoutcreatedpayload.ts b/src/models/components/webhookcheckoutcreatedpayload.ts index 50962f26..09073f13 100644 --- a/src/models/components/webhookcheckoutcreatedpayload.ts +++ b/src/models/components/webhookcheckoutcreatedpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - PolarCheckoutSchemasCheckoutInput, - PolarCheckoutSchemasCheckoutInput$inboundSchema, - PolarCheckoutSchemasCheckoutInput$Outbound, - PolarCheckoutSchemasCheckoutInput$outboundSchema, + PolarCheckoutSchemasCheckout, + PolarCheckoutSchemasCheckout$inboundSchema, + PolarCheckoutSchemasCheckout$Outbound, + PolarCheckoutSchemasCheckout$outboundSchema, } from "./polarcheckoutschemascheckout.js"; export const WebhookCheckoutCreatedPayloadType = { @@ -30,7 +30,7 @@ export type WebhookCheckoutCreatedPayload = { /** * Checkout session data retrieved using an access token. */ - data: PolarCheckoutSchemasCheckoutInput; + data: PolarCheckoutSchemasCheckout; }; /** @internal */ @@ -62,13 +62,13 @@ export const WebhookCheckoutCreatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("checkout.created").optional(), - data: PolarCheckoutSchemasCheckoutInput$inboundSchema, + data: PolarCheckoutSchemasCheckout$inboundSchema, }); /** @internal */ export type WebhookCheckoutCreatedPayload$Outbound = { type: "checkout.created"; - data: PolarCheckoutSchemasCheckoutInput$Outbound; + data: PolarCheckoutSchemasCheckout$Outbound; }; /** @internal */ @@ -78,7 +78,7 @@ export const WebhookCheckoutCreatedPayload$outboundSchema: z.ZodType< WebhookCheckoutCreatedPayload > = z.object({ type: z.literal("checkout.created").default("checkout.created"), - data: PolarCheckoutSchemasCheckoutInput$outboundSchema, + data: PolarCheckoutSchemasCheckout$outboundSchema, }); /** diff --git a/src/models/components/webhookcheckoutupdatedpayload.ts b/src/models/components/webhookcheckoutupdatedpayload.ts index aa559597..391ad445 100644 --- a/src/models/components/webhookcheckoutupdatedpayload.ts +++ b/src/models/components/webhookcheckoutupdatedpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - PolarCheckoutSchemasCheckoutInput, - PolarCheckoutSchemasCheckoutInput$inboundSchema, - PolarCheckoutSchemasCheckoutInput$Outbound, - PolarCheckoutSchemasCheckoutInput$outboundSchema, + PolarCheckoutSchemasCheckout, + PolarCheckoutSchemasCheckout$inboundSchema, + PolarCheckoutSchemasCheckout$Outbound, + PolarCheckoutSchemasCheckout$outboundSchema, } from "./polarcheckoutschemascheckout.js"; export const WebhookCheckoutUpdatedPayloadType = { @@ -30,7 +30,7 @@ export type WebhookCheckoutUpdatedPayload = { /** * Checkout session data retrieved using an access token. */ - data: PolarCheckoutSchemasCheckoutInput; + data: PolarCheckoutSchemasCheckout; }; /** @internal */ @@ -62,13 +62,13 @@ export const WebhookCheckoutUpdatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("checkout.updated").optional(), - data: PolarCheckoutSchemasCheckoutInput$inboundSchema, + data: PolarCheckoutSchemasCheckout$inboundSchema, }); /** @internal */ export type WebhookCheckoutUpdatedPayload$Outbound = { type: "checkout.updated"; - data: PolarCheckoutSchemasCheckoutInput$Outbound; + data: PolarCheckoutSchemasCheckout$Outbound; }; /** @internal */ @@ -78,7 +78,7 @@ export const WebhookCheckoutUpdatedPayload$outboundSchema: z.ZodType< WebhookCheckoutUpdatedPayload > = z.object({ type: z.literal("checkout.updated").default("checkout.updated"), - data: PolarCheckoutSchemasCheckoutInput$outboundSchema, + data: PolarCheckoutSchemasCheckout$outboundSchema, }); /** diff --git a/src/models/components/webhookdonationcreatedpayload.ts b/src/models/components/webhookdonationcreatedpayload.ts deleted file mode 100644 index 3423a9d9..00000000 --- a/src/models/components/webhookdonationcreatedpayload.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -import * as z from "zod"; -import { ClosedEnum } from "../../types/enums.js"; -import { - Donation, - Donation$inboundSchema, - Donation$Outbound, - Donation$outboundSchema, -} from "./donation.js"; - -export const WebhookDonationCreatedPayloadType = { - DonationCreated: "donation.created", -} as const; -export type WebhookDonationCreatedPayloadType = ClosedEnum< - typeof WebhookDonationCreatedPayloadType ->; - -/** - * Sent when a new donation is created. - * - * @remarks - * - * **Discord & Slack support:** Full - */ -export type WebhookDonationCreatedPayload = { - type?: "donation.created" | undefined; - data: Donation; -}; - -/** @internal */ -export const WebhookDonationCreatedPayloadType$inboundSchema: z.ZodNativeEnum< - typeof WebhookDonationCreatedPayloadType -> = z.nativeEnum(WebhookDonationCreatedPayloadType); - -/** @internal */ -export const WebhookDonationCreatedPayloadType$outboundSchema: z.ZodNativeEnum< - typeof WebhookDonationCreatedPayloadType -> = WebhookDonationCreatedPayloadType$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebhookDonationCreatedPayloadType$ { - /** @deprecated use `WebhookDonationCreatedPayloadType$inboundSchema` instead. */ - export const inboundSchema = WebhookDonationCreatedPayloadType$inboundSchema; - /** @deprecated use `WebhookDonationCreatedPayloadType$outboundSchema` instead. */ - export const outboundSchema = - WebhookDonationCreatedPayloadType$outboundSchema; -} - -/** @internal */ -export const WebhookDonationCreatedPayload$inboundSchema: z.ZodType< - WebhookDonationCreatedPayload, - z.ZodTypeDef, - unknown -> = z.object({ - type: z.literal("donation.created").optional(), - data: Donation$inboundSchema, -}); - -/** @internal */ -export type WebhookDonationCreatedPayload$Outbound = { - type: "donation.created"; - data: Donation$Outbound; -}; - -/** @internal */ -export const WebhookDonationCreatedPayload$outboundSchema: z.ZodType< - WebhookDonationCreatedPayload$Outbound, - z.ZodTypeDef, - WebhookDonationCreatedPayload -> = z.object({ - type: z.literal("donation.created").default("donation.created"), - data: Donation$outboundSchema, -}); - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace WebhookDonationCreatedPayload$ { - /** @deprecated use `WebhookDonationCreatedPayload$inboundSchema` instead. */ - export const inboundSchema = WebhookDonationCreatedPayload$inboundSchema; - /** @deprecated use `WebhookDonationCreatedPayload$outboundSchema` instead. */ - export const outboundSchema = WebhookDonationCreatedPayload$outboundSchema; - /** @deprecated use `WebhookDonationCreatedPayload$Outbound` instead. */ - export type Outbound = WebhookDonationCreatedPayload$Outbound; -} diff --git a/src/models/components/webhookproductcreatedpayload.ts b/src/models/components/webhookproductcreatedpayload.ts index bb55820d..8e9ad596 100644 --- a/src/models/components/webhookproductcreatedpayload.ts +++ b/src/models/components/webhookproductcreatedpayload.ts @@ -5,11 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - ProductInput, - ProductInput$inboundSchema, - ProductInput$Outbound, - ProductInput$outboundSchema, -} from "./productinput.js"; + Product, + Product$inboundSchema, + Product$Outbound, + Product$outboundSchema, +} from "./product.js"; export const WebhookProductCreatedPayloadType = { ProductCreated: "product.created", @@ -30,7 +30,7 @@ export type WebhookProductCreatedPayload = { /** * A product. */ - data: ProductInput; + data: Product; }; /** @internal */ @@ -61,13 +61,13 @@ export const WebhookProductCreatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("product.created").optional(), - data: ProductInput$inboundSchema, + data: Product$inboundSchema, }); /** @internal */ export type WebhookProductCreatedPayload$Outbound = { type: "product.created"; - data: ProductInput$Outbound; + data: Product$Outbound; }; /** @internal */ @@ -77,7 +77,7 @@ export const WebhookProductCreatedPayload$outboundSchema: z.ZodType< WebhookProductCreatedPayload > = z.object({ type: z.literal("product.created").default("product.created"), - data: ProductInput$outboundSchema, + data: Product$outboundSchema, }); /** diff --git a/src/models/components/webhookproductupdatedpayload.ts b/src/models/components/webhookproductupdatedpayload.ts index c0da456f..db2192fd 100644 --- a/src/models/components/webhookproductupdatedpayload.ts +++ b/src/models/components/webhookproductupdatedpayload.ts @@ -5,11 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - ProductInput, - ProductInput$inboundSchema, - ProductInput$Outbound, - ProductInput$outboundSchema, -} from "./productinput.js"; + Product, + Product$inboundSchema, + Product$Outbound, + Product$outboundSchema, +} from "./product.js"; export const WebhookProductUpdatedPayloadType = { ProductUpdated: "product.updated", @@ -30,7 +30,7 @@ export type WebhookProductUpdatedPayload = { /** * A product. */ - data: ProductInput; + data: Product; }; /** @internal */ @@ -61,13 +61,13 @@ export const WebhookProductUpdatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("product.updated").optional(), - data: ProductInput$inboundSchema, + data: Product$inboundSchema, }); /** @internal */ export type WebhookProductUpdatedPayload$Outbound = { type: "product.updated"; - data: ProductInput$Outbound; + data: Product$Outbound; }; /** @internal */ @@ -77,7 +77,7 @@ export const WebhookProductUpdatedPayload$outboundSchema: z.ZodType< WebhookProductUpdatedPayload > = z.object({ type: z.literal("product.updated").default("product.updated"), - data: ProductInput$outboundSchema, + data: Product$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptionactivepayload.ts b/src/models/components/webhooksubscriptionactivepayload.ts index 940a7b3a..6e05ab43 100644 --- a/src/models/components/webhooksubscriptionactivepayload.ts +++ b/src/models/components/webhooksubscriptionactivepayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - SubscriptionInput, - SubscriptionInput$inboundSchema, - SubscriptionInput$Outbound, - SubscriptionInput$outboundSchema, + Subscription, + Subscription$inboundSchema, + Subscription$Outbound, + Subscription$outboundSchema, } from "./subscription.js"; export const WebhookSubscriptionActivePayloadType = { @@ -28,7 +28,7 @@ export type WebhookSubscriptionActivePayloadType = ClosedEnum< */ export type WebhookSubscriptionActivePayload = { type?: "subscription.active" | undefined; - data: SubscriptionInput; + data: Subscription; }; /** @internal */ @@ -62,13 +62,13 @@ export const WebhookSubscriptionActivePayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("subscription.active").optional(), - data: SubscriptionInput$inboundSchema, + data: Subscription$inboundSchema, }); /** @internal */ export type WebhookSubscriptionActivePayload$Outbound = { type: "subscription.active"; - data: SubscriptionInput$Outbound; + data: Subscription$Outbound; }; /** @internal */ @@ -78,7 +78,7 @@ export const WebhookSubscriptionActivePayload$outboundSchema: z.ZodType< WebhookSubscriptionActivePayload > = z.object({ type: z.literal("subscription.active").default("subscription.active"), - data: SubscriptionInput$outboundSchema, + data: Subscription$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptioncanceledpayload.ts b/src/models/components/webhooksubscriptioncanceledpayload.ts index f3e00a12..015f8877 100644 --- a/src/models/components/webhooksubscriptioncanceledpayload.ts +++ b/src/models/components/webhooksubscriptioncanceledpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - SubscriptionInput, - SubscriptionInput$inboundSchema, - SubscriptionInput$Outbound, - SubscriptionInput$outboundSchema, + Subscription, + Subscription$inboundSchema, + Subscription$Outbound, + Subscription$outboundSchema, } from "./subscription.js"; export const WebhookSubscriptionCanceledPayloadType = { @@ -28,7 +28,7 @@ export type WebhookSubscriptionCanceledPayloadType = ClosedEnum< */ export type WebhookSubscriptionCanceledPayload = { type?: "subscription.canceled" | undefined; - data: SubscriptionInput; + data: Subscription; }; /** @internal */ @@ -62,13 +62,13 @@ export const WebhookSubscriptionCanceledPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("subscription.canceled").optional(), - data: SubscriptionInput$inboundSchema, + data: Subscription$inboundSchema, }); /** @internal */ export type WebhookSubscriptionCanceledPayload$Outbound = { type: "subscription.canceled"; - data: SubscriptionInput$Outbound; + data: Subscription$Outbound; }; /** @internal */ @@ -78,7 +78,7 @@ export const WebhookSubscriptionCanceledPayload$outboundSchema: z.ZodType< WebhookSubscriptionCanceledPayload > = z.object({ type: z.literal("subscription.canceled").default("subscription.canceled"), - data: SubscriptionInput$outboundSchema, + data: Subscription$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptioncreatedpayload.ts b/src/models/components/webhooksubscriptioncreatedpayload.ts index 033db825..4eff79ab 100644 --- a/src/models/components/webhooksubscriptioncreatedpayload.ts +++ b/src/models/components/webhooksubscriptioncreatedpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - SubscriptionInput, - SubscriptionInput$inboundSchema, - SubscriptionInput$Outbound, - SubscriptionInput$outboundSchema, + Subscription, + Subscription$inboundSchema, + Subscription$Outbound, + Subscription$outboundSchema, } from "./subscription.js"; export const WebhookSubscriptionCreatedPayloadType = { @@ -27,7 +27,7 @@ export type WebhookSubscriptionCreatedPayloadType = ClosedEnum< */ export type WebhookSubscriptionCreatedPayload = { type?: "subscription.created" | undefined; - data: SubscriptionInput; + data: Subscription; }; /** @internal */ @@ -61,13 +61,13 @@ export const WebhookSubscriptionCreatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("subscription.created").optional(), - data: SubscriptionInput$inboundSchema, + data: Subscription$inboundSchema, }); /** @internal */ export type WebhookSubscriptionCreatedPayload$Outbound = { type: "subscription.created"; - data: SubscriptionInput$Outbound; + data: Subscription$Outbound; }; /** @internal */ @@ -77,7 +77,7 @@ export const WebhookSubscriptionCreatedPayload$outboundSchema: z.ZodType< WebhookSubscriptionCreatedPayload > = z.object({ type: z.literal("subscription.created").default("subscription.created"), - data: SubscriptionInput$outboundSchema, + data: Subscription$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptionrevokedpayload.ts b/src/models/components/webhooksubscriptionrevokedpayload.ts index 91083418..707f5aa0 100644 --- a/src/models/components/webhooksubscriptionrevokedpayload.ts +++ b/src/models/components/webhooksubscriptionrevokedpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - SubscriptionInput, - SubscriptionInput$inboundSchema, - SubscriptionInput$Outbound, - SubscriptionInput$outboundSchema, + Subscription, + Subscription$inboundSchema, + Subscription$Outbound, + Subscription$outboundSchema, } from "./subscription.js"; export const WebhookSubscriptionRevokedPayloadType = { @@ -28,7 +28,7 @@ export type WebhookSubscriptionRevokedPayloadType = ClosedEnum< */ export type WebhookSubscriptionRevokedPayload = { type?: "subscription.revoked" | undefined; - data: SubscriptionInput; + data: Subscription; }; /** @internal */ @@ -62,13 +62,13 @@ export const WebhookSubscriptionRevokedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("subscription.revoked").optional(), - data: SubscriptionInput$inboundSchema, + data: Subscription$inboundSchema, }); /** @internal */ export type WebhookSubscriptionRevokedPayload$Outbound = { type: "subscription.revoked"; - data: SubscriptionInput$Outbound; + data: Subscription$Outbound; }; /** @internal */ @@ -78,7 +78,7 @@ export const WebhookSubscriptionRevokedPayload$outboundSchema: z.ZodType< WebhookSubscriptionRevokedPayload > = z.object({ type: z.literal("subscription.revoked").default("subscription.revoked"), - data: SubscriptionInput$outboundSchema, + data: Subscription$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptionupdatedpayload.ts b/src/models/components/webhooksubscriptionupdatedpayload.ts index d5021426..cb5a34a2 100644 --- a/src/models/components/webhooksubscriptionupdatedpayload.ts +++ b/src/models/components/webhooksubscriptionupdatedpayload.ts @@ -5,10 +5,10 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { - SubscriptionInput, - SubscriptionInput$inboundSchema, - SubscriptionInput$Outbound, - SubscriptionInput$outboundSchema, + Subscription, + Subscription$inboundSchema, + Subscription$Outbound, + Subscription$outboundSchema, } from "./subscription.js"; export const WebhookSubscriptionUpdatedPayloadType = { @@ -31,7 +31,7 @@ export type WebhookSubscriptionUpdatedPayloadType = ClosedEnum< */ export type WebhookSubscriptionUpdatedPayload = { type?: "subscription.updated" | undefined; - data: SubscriptionInput; + data: Subscription; }; /** @internal */ @@ -65,13 +65,13 @@ export const WebhookSubscriptionUpdatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("subscription.updated").optional(), - data: SubscriptionInput$inboundSchema, + data: Subscription$inboundSchema, }); /** @internal */ export type WebhookSubscriptionUpdatedPayload$Outbound = { type: "subscription.updated"; - data: SubscriptionInput$Outbound; + data: Subscription$Outbound; }; /** @internal */ @@ -81,7 +81,7 @@ export const WebhookSubscriptionUpdatedPayload$outboundSchema: z.ZodType< WebhookSubscriptionUpdatedPayload > = z.object({ type: z.literal("subscription.updated").default("subscription.updated"), - data: SubscriptionInput$outboundSchema, + data: Subscription$outboundSchema, }); /** diff --git a/src/models/operations/index.ts b/src/models/operations/index.ts index 970be8ea..907632cc 100644 --- a/src/models/operations/index.ts +++ b/src/models/operations/index.ts @@ -44,6 +44,7 @@ export * from "./licensekeysgetactivation.js"; export * from "./licensekeyslist.js"; export * from "./licensekeysupdate.js"; export * from "./metricsget.js"; +export * from "./oauth2authorize.js"; export * from "./oauth2clientslist.js"; export * from "./oauth2clientsoauth2deleteclient.js"; export * from "./oauth2clientsoauth2getclient.js"; diff --git a/src/models/operations/licensekeyslist.ts b/src/models/operations/licensekeyslist.ts index 32426249..abaf9036 100644 --- a/src/models/operations/licensekeyslist.ts +++ b/src/models/operations/licensekeyslist.ts @@ -13,11 +13,20 @@ export type LicenseKeysListQueryParamOrganizationIDFilter = | string | Array; +/** + * Filter by benefit ID. + */ +export type LicenseKeysListQueryParamBenefitIDFilter = string | Array; + export type LicenseKeysListRequest = { /** * Filter by organization ID. */ organizationId?: string | Array | null | undefined; + /** + * Filter by benefit ID. + */ + benefitId?: string | Array | null | undefined; /** * Page number, defaults to 1. */ @@ -68,6 +77,40 @@ export namespace LicenseKeysListQueryParamOrganizationIDFilter$ { export type Outbound = LicenseKeysListQueryParamOrganizationIDFilter$Outbound; } +/** @internal */ +export const LicenseKeysListQueryParamBenefitIDFilter$inboundSchema: z.ZodType< + LicenseKeysListQueryParamBenefitIDFilter, + z.ZodTypeDef, + unknown +> = z.union([z.string(), z.array(z.string())]); + +/** @internal */ +export type LicenseKeysListQueryParamBenefitIDFilter$Outbound = + | string + | Array; + +/** @internal */ +export const LicenseKeysListQueryParamBenefitIDFilter$outboundSchema: z.ZodType< + LicenseKeysListQueryParamBenefitIDFilter$Outbound, + z.ZodTypeDef, + LicenseKeysListQueryParamBenefitIDFilter +> = z.union([z.string(), z.array(z.string())]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace LicenseKeysListQueryParamBenefitIDFilter$ { + /** @deprecated use `LicenseKeysListQueryParamBenefitIDFilter$inboundSchema` instead. */ + export const inboundSchema = + LicenseKeysListQueryParamBenefitIDFilter$inboundSchema; + /** @deprecated use `LicenseKeysListQueryParamBenefitIDFilter$outboundSchema` instead. */ + export const outboundSchema = + LicenseKeysListQueryParamBenefitIDFilter$outboundSchema; + /** @deprecated use `LicenseKeysListQueryParamBenefitIDFilter$Outbound` instead. */ + export type Outbound = LicenseKeysListQueryParamBenefitIDFilter$Outbound; +} + /** @internal */ export const LicenseKeysListRequest$inboundSchema: z.ZodType< LicenseKeysListRequest, @@ -76,17 +119,20 @@ export const LicenseKeysListRequest$inboundSchema: z.ZodType< > = z.object({ organization_id: z.nullable(z.union([z.string(), z.array(z.string())])) .optional(), + benefit_id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(), page: z.number().int().default(1), limit: z.number().int().default(10), }).transform((v) => { return remap$(v, { "organization_id": "organizationId", + "benefit_id": "benefitId", }); }); /** @internal */ export type LicenseKeysListRequest$Outbound = { organization_id?: string | Array | null | undefined; + benefit_id?: string | Array | null | undefined; page: number; limit: number; }; @@ -99,11 +145,13 @@ export const LicenseKeysListRequest$outboundSchema: z.ZodType< > = z.object({ organizationId: z.nullable(z.union([z.string(), z.array(z.string())])) .optional(), + benefitId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(), page: z.number().int().default(1), limit: z.number().int().default(10), }).transform((v) => { return remap$(v, { organizationId: "organization_id", + benefitId: "benefit_id", }); }); diff --git a/src/models/operations/oauth2authorize.ts b/src/models/operations/oauth2authorize.ts new file mode 100644 index 00000000..8f04c108 --- /dev/null +++ b/src/models/operations/oauth2authorize.ts @@ -0,0 +1,71 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import * as components from "../components/index.js"; + +/** + * Successful Response + */ +export type Oauth2AuthorizeResponseOauth2Authorize = + | (components.AuthorizeResponseUser & { subType: "user" }) + | (components.AuthorizeResponseOrganization & { subType: "organization" }); + +/** @internal */ +export const Oauth2AuthorizeResponseOauth2Authorize$inboundSchema: z.ZodType< + Oauth2AuthorizeResponseOauth2Authorize, + z.ZodTypeDef, + unknown +> = z.union([ + components.AuthorizeResponseUser$inboundSchema.and( + z.object({ sub_type: z.literal("user") }).transform((v) => ({ + subType: v.sub_type, + })), + ), + components.AuthorizeResponseOrganization$inboundSchema.and( + z.object({ sub_type: z.literal("organization") }).transform((v) => ({ + subType: v.sub_type, + })), + ), +]); + +/** @internal */ +export type Oauth2AuthorizeResponseOauth2Authorize$Outbound = + | (components.AuthorizeResponseUser$Outbound & { sub_type: "user" }) + | (components.AuthorizeResponseOrganization$Outbound & { + sub_type: "organization"; + }); + +/** @internal */ +export const Oauth2AuthorizeResponseOauth2Authorize$outboundSchema: z.ZodType< + Oauth2AuthorizeResponseOauth2Authorize$Outbound, + z.ZodTypeDef, + Oauth2AuthorizeResponseOauth2Authorize +> = z.union([ + components.AuthorizeResponseUser$outboundSchema.and( + z.object({ subType: z.literal("user") }).transform((v) => ({ + sub_type: v.subType, + })), + ), + components.AuthorizeResponseOrganization$outboundSchema.and( + z.object({ subType: z.literal("organization") }).transform((v) => ({ + sub_type: v.subType, + })), + ), +]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Oauth2AuthorizeResponseOauth2Authorize$ { + /** @deprecated use `Oauth2AuthorizeResponseOauth2Authorize$inboundSchema` instead. */ + export const inboundSchema = + Oauth2AuthorizeResponseOauth2Authorize$inboundSchema; + /** @deprecated use `Oauth2AuthorizeResponseOauth2Authorize$outboundSchema` instead. */ + export const outboundSchema = + Oauth2AuthorizeResponseOauth2Authorize$outboundSchema; + /** @deprecated use `Oauth2AuthorizeResponseOauth2Authorize$Outbound` instead. */ + export type Outbound = Oauth2AuthorizeResponseOauth2Authorize$Outbound; +} diff --git a/src/sdk/oauth2.ts b/src/sdk/oauth2.ts index 400b0f8a..9f6b3b21 100644 --- a/src/sdk/oauth2.ts +++ b/src/sdk/oauth2.ts @@ -2,6 +2,7 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ +import { oauth2Authorize } from "../funcs/oauth2Authorize.js"; import { oauth2Introspect } from "../funcs/oauth2Introspect.js"; import { oauth2Revoke } from "../funcs/oauth2Revoke.js"; import { oauth2Token } from "../funcs/oauth2Token.js"; @@ -18,6 +19,18 @@ export class Oauth2 extends ClientSDK { return (this._clients ??= new Clients(this._options)); } + /** + * Authorize + */ + async authorize( + options?: RequestOptions, + ): Promise { + return unwrapAsync(oauth2Authorize( + this, + options, + )); + } + /** * Request Token *