From 799619b00978ca714d6827dfc33c5fd8be0aca90 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 16 Oct 2024 00:27:18 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.418.4 --- .speakeasy/gen.lock | 69 +++++--- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 10 +- README.md | 2 + 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 | 26 +-- docs/models/components/articlebyline.md | 2 +- docs/models/components/articlecreate.md | 4 +- .../components/articlecreatearticlebyline.md | 17 -- .../articlecreatearticlevisibility.md | 15 -- docs/models/components/articlepreview.md | 2 +- docs/models/components/articlereceivers.md | 6 +- docs/models/components/assignee.md | 8 +- docs/models/components/author.md | 8 +- docs/models/components/benefit.md | 53 +++---- docs/models/components/benefitads.md | 6 +- docs/models/components/benefitadscreate.md | 3 +- .../models/components/benefitadssubscriber.md | 10 +- docs/models/components/benefitarticles.md | 7 +- .../components/benefitarticlessubscriber.md | 6 +- docs/models/components/benefitbase.md | 10 +- docs/models/components/benefitcustom.md | 6 +- docs/models/components/benefitcustomcreate.md | 2 +- .../components/benefitcustomsubscriber.md | 11 +- docs/models/components/benefitdiscord.md | 6 +- .../models/components/benefitdiscordcreate.md | 3 +- docs/models/components/benefitdiscordinput.md | 7 +- .../components/benefitdiscordsubscriber.md | 7 +- .../models/components/benefitdownloadables.md | 6 +- .../components/benefitdownloadablescreate.md | 2 +- .../benefitdownloadablessubscriber.md | 6 +- .../components/benefitgithubrepository.md | 9 +- .../benefitgithubrepositorycreate.md | 5 +- ...hubrepositorycreatepropertiespermission.md | 2 +- .../benefitgithubrepositorysubscriber.md | 7 +- .../benefitgithubrepositoryupdate.md | 2 +- docs/models/components/benefitgrant.md | 4 +- docs/models/components/benefitgrantads.md | 4 +- .../components/benefitgrantlicensekeys.md | 4 +- .../components/benefitgrantsubscriber.md | 4 +- docs/models/components/benefitgrantwebhook.md | 25 ++- .../components/benefitgrantwebhookbenefit.md | 142 ----------------- ...eatedpayloadbenefit.md => benefitinput.md} | 53 ++++--- .../benefitlicensekeyactivationproperties.md | 2 +- .../benefitlicensekeyexpirationproperties.md | 4 +- docs/models/components/benefitlicensekeys.md | 14 +- .../components/benefitlicensekeyscreate.md | 2 +- .../benefitlicensekeysproperties.md | 8 +- .../benefitlicensekeyssubscriber.md | 19 ++- .../benefitlicensekeyssubscriberproperties.md | 6 +- docs/models/components/benefits.md | 15 +- docs/models/components/benefittype.md | 2 +- docs/models/components/bylineprofile.md | 2 +- docs/models/components/checkoutpublic.md | 69 ++++---- docs/models/components/checkoutstatus.md | 2 +- docs/models/components/currencyamount.md | 4 +- docs/models/components/donation.md | 33 ++-- .../models/components/donationorganization.md | 2 +- docs/models/components/donationuser.md | 2 +- docs/models/components/donor.md | 4 +- .../components/downloadablefilecreate.md | 8 +- .../models/components/downloadablefileread.md | 8 +- docs/models/components/downloadableread.md | 10 +- .../models/components/externalorganization.md | 8 +- .../externalorganizationsortproperty.md | 2 +- docs/models/components/filedownload.md | 10 +- docs/models/components/fileread.md | 28 ++-- docs/models/components/fileservicetypes.md | 2 +- docs/models/components/fileupload.md | 20 +-- docs/models/components/fileuploadcompleted.md | 4 +- docs/models/components/interval.md | 15 ++ .../components/introspecttokenresponse.md | 8 +- docs/models/components/issue.md | 25 ++- docs/models/components/label.md | 2 +- .../components/licensekeyactivationbase.md | 4 +- .../components/licensekeyactivationread.md | 24 +-- docs/models/components/licensekeyread.md | 21 ++- docs/models/components/licensekeyuser.md | 23 +++ .../components/licensekeywithactivations.md | 25 +-- docs/models/components/listresourcearticle.md | 32 ++-- docs/models/components/listresourcebenefit.md | 15 +- .../components/listresourcebenefitgrant.md | 8 +- .../models/components/listresourcecheckout.md | 28 ++-- .../listresourcedownloadableread.md | 14 +- .../listresourceexternalorganization.md | 12 +- .../models/components/listresourcefileread.md | 13 +- .../components/listresourcelicensekeyread.md | 24 +-- .../components/listresourceoauth2client.md | 14 +- docs/models/components/listresourceorder.md | 53 ++++--- .../components/listresourceorganization.md | 18 +-- docs/models/components/listresourceproduct.md | 40 +++-- .../components/listresourcerepository.md | 17 +- .../components/listresourcesubscription.md | 65 ++++---- .../listresourceuseradvertisementcampaign.md | 18 +-- .../components/listresourceuserbenefit.md | 36 ++++- .../components/listresourceuserorder.md | 71 ++++----- .../listresourceusersubscription.md | 66 ++++---- docs/models/components/loc.md | 2 +- docs/models/components/metric.md | 12 +- docs/models/components/metricperiod.md | 24 +-- docs/models/components/metrics.md | 24 +-- .../models/components/metricsintervallimit.md | 2 +- .../components/metricsintervalslimits.md | 20 +-- docs/models/components/metricslimits.md | 14 +- docs/models/components/metricsresponse.md | 60 +++---- docs/models/components/metrictype.md | 2 +- docs/models/components/oauth2client.md | 10 +- .../components/oauth2clientconfiguration.md | 2 +- .../oauth2clientconfigurationupdate.md | 2 +- ...componentsauthorizationcodetokenrequest.md | 2 +- docs/models/components/order.md | 48 +++--- docs/models/components/orderbillingreason.md | 15 ++ docs/models/components/orderinvoice.md | 2 +- docs/models/components/orderproduct.md | 6 +- docs/models/components/ordersortproperty.md | 2 +- docs/models/components/ordersubscription.md | 20 +-- docs/models/components/orderuser.md | 4 +- docs/models/components/organization.md | 14 +- .../organizationavatarfilecreate.md | 8 +- .../components/organizationavatarfileread.md | 10 +- .../components/organizationsortproperty.md | 2 +- docs/models/components/pagination.md | 4 +- docs/models/components/permission.md | 2 +- docs/models/components/pledge.md | 39 ++--- docs/models/components/pledger.md | 2 +- docs/models/components/pledgestate.md | 2 +- docs/models/components/pledgetype.md | 2 +- .../polarcheckoutlegacyschemascheckout.md | 41 ++--- ...olarcheckoutlegacyschemascheckoutcreate.md | 2 +- .../polarcheckoutschemascheckout.md | 26 +-- .../polarcheckoutschemascheckoutinput.md | 26 +-- docs/models/components/prices.md | 2 +- docs/models/components/product.md | 35 ++-- docs/models/components/productbenefits.md | 15 +- docs/models/components/productinput.md | 26 ++- .../components/productmediafilecreate.md | 8 +- .../models/components/productmediafileread.md | 10 +- .../components/productmediafilereadinput.md | 8 +- .../models/components/productonetimecreate.md | 4 +- docs/models/components/productprice.md | 14 +- docs/models/components/productpriceonetime.md | 20 +-- .../components/productpriceonetimecustom.md | 10 +- .../components/productpriceonetimefixed.md | 6 +- .../productpriceonetimefixedcreate.md | 2 +- .../components/productpriceonetimefree.md | 4 +- .../components/productpricerecurring.md | 24 +-- .../components/productpricerecurringcustom.md | 12 +- .../components/productpricerecurringfixed.md | 10 +- .../productpricerecurringfixedcreate.md | 4 +- .../components/productpricerecurringfree.md | 8 +- .../productpricerecurringfreecreate.md | 4 +- .../components/productrecurringcreate.md | 2 +- .../productrecurringcreateprices.md | 4 +- docs/models/components/productupdateprices.md | 6 +- docs/models/components/reactions.md | 18 +-- docs/models/components/repositoryinput.md | 12 +- docs/models/components/repositoryoutput.md | 12 +- .../components/repositorysortproperty.md | 2 +- docs/models/components/s3downloadurl.md | 4 +- .../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/subscription.md | 65 ++++---- docs/models/components/subscriptioninput.md | 59 ++++--- .../components/subscriptionsortproperty.md | 2 +- docs/models/components/subscriptionuser.md | 4 +- .../components/tokenendpointauthmethod.md | 2 +- docs/models/components/tokenresponse.md | 2 +- .../components/useradvertisementcampaign.md | 14 +- .../useradvertisementcampaigncreate.md | 4 +- .../useradvertisementsortproperty.md | 2 +- docs/models/components/userbenefit.md | 64 ++++---- .../components/userbenefitsortproperty.md | 2 +- docs/models/components/userorder.md | 69 ++++---- docs/models/components/userorderinvoice.md | 2 +- docs/models/components/userorderproduct.md | 31 ++-- .../components/userordersortproperty.md | 2 +- .../components/userordersubscription.md | 20 +-- docs/models/components/usersubscription.md | 60 +++---- .../components/usersubscriptionproduct.md | 34 ++-- .../usersubscriptionproductbenefits.md | 14 +- .../usersubscriptionsortproperty.md | 2 +- docs/models/components/validatedlicensekey.md | 19 ++- .../webhookbenefitcreatedpayload.md | 13 +- .../webhookbenefitgrantcreatedpayload.md | 15 +- .../webhookbenefitgrantrevokedpayload.md | 10 +- .../webhookbenefitgrantupdatedpayload.md | 15 +- .../webhookbenefitupdatedpayload.md | 14 +- .../webhookbenefitupdatedpayloadbenefit.md | 141 ----------------- .../webhookcheckoutcreatedpayload.md | 22 +-- .../webhookcheckoutupdatedpayload.md | 22 +-- .../webhookdonationcreatedpayload.md | 35 ++-- .../components/webhookordercreatedpayload.md | 47 +++--- .../webhookorganizationupdatedpayload.md | 14 +- .../components/webhookpledgecreatedpayload.md | 28 ++-- .../components/webhookpledgeupdatedpayload.md | 33 ++-- .../webhookproductcreatedpayload.md | 34 ++-- .../webhookproductupdatedpayload.md | 32 ++-- .../webhooksubscriptionactivepayload.md | 115 ++++++++++++++ .../webhooksubscriptionactivepayloadtype.md | 15 ++ .../webhooksubscriptioncanceledpayload.md | 114 ++++++++++++++ .../webhooksubscriptioncanceledpayloadtype.md | 15 ++ .../webhooksubscriptioncreatedpayload.md | 65 ++++---- .../webhooksubscriptionrevokedpayload.md | 115 ++++++++++++++ .../webhooksubscriptionrevokedpayloadtype.md | 15 ++ .../webhooksubscriptionupdatedpayload.md | 69 ++++---- .../operations/advertisementslistresponse.md | 16 +- .../operations/articlesexportrequest.md | 17 ++ .../models/operations/articleslistresponse.md | 32 ++-- .../operations/articlespreviewrequest.md | 2 +- .../operations/articlevisibilityfilter.md | 2 +- .../operations/benefitscreatebenefitcreate.md | 13 +- .../benefitscreateresponsebenefitscreate.md | 147 ----------------- .../benefitsgetresponsebenefitsget.md | 146 ----------------- .../operations/benefitsgrantsresponse.md | 8 +- .../models/operations/benefitslistresponse.md | 10 +- .../operations/benefitsupdatebenefitupdate.md | 2 +- .../operations/benefitsupdaterequest.md | 8 +- .../benefitsupdateresponsebenefitsupdate.md | 146 ----------------- .../operations/checkoutscustomlistresponse.md | 28 ++-- .../externalorganizationslistresponse.md | 12 +- .../operations/filescreatefilecreate.md | 24 +-- docs/models/operations/fileslistresponse.md | 14 +- .../filesupdateresponsefilesupdate.md | 28 ++-- .../models/operations/filesuploadedrequest.md | 4 +- .../filesuploadedresponsefilesuploaded.md | 28 ++-- docs/models/operations/interval.md | 17 -- .../operations/licensekeyslistresponse.md | 24 +-- ...ricsgetqueryparamproductpricetypefilter.md | 2 +- docs/models/operations/metricsgetrequest.md | 8 +- .../operations/oauth2clientslistresponse.md | 14 +- .../oauth2clientsoauth2updateclientrequest.md | 2 +- .../oauth2introspecttokentokentypehint.md | 2 +- .../oauth2requesttokenrequestbody.md | 2 +- docs/models/operations/orderslistresponse.md | 53 ++++--- .../operations/organizationslistresponse.md | 18 +-- .../operations/productscreateproductcreate.md | 1 + docs/models/operations/productslistrequest.md | 4 +- .../models/operations/productslistresponse.md | 35 ++-- .../operations/queryparambenefittypefilter.md | 4 +- .../queryparamproductpricetypefilter.md | 2 +- .../operations/repositorieslistresponse.md | 16 +- .../operations/subscriptionslistresponse.md | 72 +++++---- docs/models/operations/tokentypehint.md | 2 +- .../userslicensekeyslistresponse.md | 24 +-- docs/sdks/articles/README.md | 78 +++++++++ docs/sdks/benefits/README.md | 6 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/funcs/articlesExport.ts | 129 +++++++++++++++ src/funcs/benefitsCreate.ts | 7 +- src/funcs/benefitsGet.ts | 7 +- src/funcs/benefitsUpdate.ts | 7 +- src/lib/config.ts | 6 +- src/models/components/articlecreate.ts | 95 +++-------- src/models/components/benefit.ts | 106 +++++++++++++ src/models/components/benefitbase.ts | 3 - src/models/components/benefitgrantwebhook.ts | 146 ++--------------- src/models/components/benefitinput.ts | 109 +++++++++++++ src/models/components/checkoutpublic.ts | 6 - src/models/components/index.ts | 8 + src/models/components/interval.ts | 34 ++++ src/models/components/issue.ts | 6 - src/models/components/licensekeyread.ts | 10 ++ src/models/components/licensekeyuser.ts | 68 ++++++++ .../components/licensekeywithactivations.ts | 10 ++ src/models/components/listresourcebenefit.ts | 149 ++---------------- src/models/components/metric.ts | 3 - .../components/metricsintervalslimits.ts | 10 +- src/models/components/metricslimits.ts | 2 +- src/models/components/metricsresponse.ts | 3 - src/models/components/order.ts | 11 ++ src/models/components/orderbillingreason.ts | 35 ++++ src/models/components/pledge.ts | 9 -- .../polarcheckoutschemascheckout.ts | 12 -- .../components/productpricerecurringcustom.ts | 3 - .../components/productpricerecurringfixed.ts | 3 - .../productpricerecurringfixedcreate.ts | 3 - .../components/productpricerecurringfree.ts | 3 - .../productpricerecurringfreecreate.ts | 3 - src/models/components/validatedlicensekey.ts | 10 ++ .../webhookbenefitcreatedpayload.ts | 148 ++--------------- .../webhookbenefitupdatedpayload.ts | 148 ++--------------- .../webhooksubscriptionactivepayload.ts | 95 +++++++++++ .../webhooksubscriptioncanceledpayload.ts | 96 +++++++++++ .../webhooksubscriptionrevokedpayload.ts | 96 +++++++++++ .../webhooksubscriptionupdatedpayload.ts | 8 +- src/models/operations/articlesexport.ts | 54 +++++++ src/models/operations/benefitscreate.ts | 67 -------- src/models/operations/benefitsget.ts | 66 -------- src/models/operations/benefitsupdate.ts | 67 -------- src/models/operations/index.ts | 1 + src/models/operations/metricsget.ts | 41 +---- src/sdk/articles.ts | 18 +++ src/sdk/benefits.ts | 7 +- 303 files changed, 3396 insertions(+), 3471 deletions(-) delete mode 100644 docs/models/components/articlecreatearticlebyline.md delete mode 100644 docs/models/components/articlecreatearticlevisibility.md delete mode 100644 docs/models/components/benefitgrantwebhookbenefit.md rename docs/models/components/{webhookbenefitcreatedpayloadbenefit.md => benefitinput.md} (59%) create mode 100644 docs/models/components/interval.md create mode 100644 docs/models/components/licensekeyuser.md create mode 100644 docs/models/components/orderbillingreason.md delete mode 100644 docs/models/components/webhookbenefitupdatedpayloadbenefit.md create mode 100644 docs/models/components/webhooksubscriptionactivepayload.md create mode 100644 docs/models/components/webhooksubscriptionactivepayloadtype.md create mode 100644 docs/models/components/webhooksubscriptioncanceledpayload.md create mode 100644 docs/models/components/webhooksubscriptioncanceledpayloadtype.md create mode 100644 docs/models/components/webhooksubscriptionrevokedpayload.md create mode 100644 docs/models/components/webhooksubscriptionrevokedpayloadtype.md create mode 100644 docs/models/operations/articlesexportrequest.md delete mode 100644 docs/models/operations/benefitscreateresponsebenefitscreate.md delete mode 100644 docs/models/operations/benefitsgetresponsebenefitsget.md delete mode 100644 docs/models/operations/benefitsupdateresponsebenefitsupdate.md delete mode 100644 docs/models/operations/interval.md create mode 100644 src/funcs/articlesExport.ts create mode 100644 src/models/components/benefit.ts create mode 100644 src/models/components/benefitinput.ts create mode 100644 src/models/components/interval.ts create mode 100644 src/models/components/licensekeyuser.ts create mode 100644 src/models/components/orderbillingreason.ts create mode 100644 src/models/components/webhooksubscriptionactivepayload.ts create mode 100644 src/models/components/webhooksubscriptioncanceledpayload.ts create mode 100644 src/models/components/webhooksubscriptionrevokedpayload.ts create mode 100644 src/models/operations/articlesexport.ts diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 56310e14..3da9fdd4 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: 9f84f5107633874d45ee97fcd4c24b5f + docChecksum: 13369c01355ded9eb4ea3731b08266ed docVersion: 0.1.0 - speakeasyVersion: 1.414.1 - generationVersion: 2.437.1 - releaseVersion: 0.13.0 - configChecksum: 1b74dfd6b9d022496d15e9422553299c + speakeasyVersion: 1.418.4 + generationVersion: 2.438.3 + releaseVersion: 0.13.1 + configChecksum: a9593b1d8912cac7e7f08c8e2fead264 repoURL: https://github.com/polarsource/polar-js.git installationURL: https://github.com/polarsource/polar-js published: true @@ -56,8 +56,6 @@ generatedFiles: - docs/models/components/article.md - docs/models/components/articlebyline.md - docs/models/components/articlecreate.md - - docs/models/components/articlecreatearticlebyline.md - - docs/models/components/articlecreatearticlevisibility.md - docs/models/components/articlepreview.md - docs/models/components/articlereceivers.md - docs/models/components/articleupdate.md @@ -143,8 +141,8 @@ generatedFiles: - docs/models/components/benefitgrantlicensekeysproperties.md - docs/models/components/benefitgrantsubscriber.md - docs/models/components/benefitgrantwebhook.md - - docs/models/components/benefitgrantwebhookbenefit.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 @@ -191,6 +189,7 @@ generatedFiles: - docs/models/components/funding.md - docs/models/components/granttype.md - docs/models/components/granttypes.md + - docs/models/components/interval.md - docs/models/components/introspecttokenresponse.md - docs/models/components/introspecttokenresponsetokentype.md - docs/models/components/issue.md @@ -205,6 +204,7 @@ generatedFiles: - docs/models/components/licensekeyread.md - docs/models/components/licensekeystatus.md - docs/models/components/licensekeyupdate.md + - docs/models/components/licensekeyuser.md - docs/models/components/licensekeyvalidate.md - docs/models/components/licensekeywithactivations.md - docs/models/components/listresourcearticle.md @@ -248,6 +248,7 @@ generatedFiles: - docs/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequest.md - docs/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequestgranttype.md - docs/models/components/order.md + - docs/models/components/orderbillingreason.md - docs/models/components/orderinvoice.md - docs/models/components/orderproduct.md - docs/models/components/ordersortproperty.md @@ -383,7 +384,6 @@ generatedFiles: - docs/models/components/validatedlicensekey.md - docs/models/components/validationerror.md - docs/models/components/webhookbenefitcreatedpayload.md - - docs/models/components/webhookbenefitcreatedpayloadbenefit.md - docs/models/components/webhookbenefitcreatedpayloadtype.md - docs/models/components/webhookbenefitgrantcreatedpayload.md - docs/models/components/webhookbenefitgrantcreatedpayloadtype.md @@ -392,7 +392,6 @@ generatedFiles: - docs/models/components/webhookbenefitgrantupdatedpayload.md - docs/models/components/webhookbenefitgrantupdatedpayloadtype.md - docs/models/components/webhookbenefitupdatedpayload.md - - docs/models/components/webhookbenefitupdatedpayloadbenefit.md - docs/models/components/webhookbenefitupdatedpayloadtype.md - docs/models/components/webhookcheckoutcreatedpayload.md - docs/models/components/webhookcheckoutcreatedpayloadtype.md @@ -412,8 +411,14 @@ generatedFiles: - docs/models/components/webhookproductcreatedpayloadtype.md - docs/models/components/webhookproductupdatedpayload.md - docs/models/components/webhookproductupdatedpayloadtype.md + - docs/models/components/webhooksubscriptionactivepayload.md + - docs/models/components/webhooksubscriptionactivepayloadtype.md + - docs/models/components/webhooksubscriptioncanceledpayload.md + - docs/models/components/webhooksubscriptioncanceledpayloadtype.md - docs/models/components/webhooksubscriptioncreatedpayload.md - docs/models/components/webhooksubscriptioncreatedpayloadtype.md + - docs/models/components/webhooksubscriptionrevokedpayload.md + - docs/models/components/webhooksubscriptionrevokedpayloadtype.md - docs/models/components/webhooksubscriptionupdatedpayload.md - docs/models/components/webhooksubscriptionupdatedpayloadtype.md - docs/models/errors/alreadycanceledsubscription.md @@ -431,6 +436,7 @@ generatedFiles: - docs/models/operations/advertisementslistrequest.md - docs/models/operations/advertisementslistresponse.md - docs/models/operations/articlesdeleterequest.md + - docs/models/operations/articlesexportrequest.md - docs/models/operations/articlesgetrequest.md - docs/models/operations/articleslistqueryparamorganizationidfilter.md - docs/models/operations/articleslistrequest.md @@ -442,10 +448,8 @@ generatedFiles: - docs/models/operations/articlevisibilityfilter.md - docs/models/operations/benefitidfilter.md - docs/models/operations/benefitscreatebenefitcreate.md - - docs/models/operations/benefitscreateresponsebenefitscreate.md - docs/models/operations/benefitsdeleterequest.md - docs/models/operations/benefitsgetrequest.md - - docs/models/operations/benefitsgetresponsebenefitsget.md - docs/models/operations/benefitsgrantsrequest.md - docs/models/operations/benefitsgrantsresponse.md - docs/models/operations/benefitslistqueryparamorganizationidfilter.md @@ -453,7 +457,6 @@ generatedFiles: - docs/models/operations/benefitslistresponse.md - docs/models/operations/benefitsupdatebenefitupdate.md - docs/models/operations/benefitsupdaterequest.md - - docs/models/operations/benefitsupdateresponsebenefitsupdate.md - docs/models/operations/benefittypefilter.md - docs/models/operations/checkoutscustomclientconfirmrequest.md - docs/models/operations/checkoutscustomclientgetrequest.md @@ -477,7 +480,6 @@ generatedFiles: - docs/models/operations/filesupdateresponsefilesupdate.md - docs/models/operations/filesuploadedrequest.md - docs/models/operations/filesuploadedresponsefilesuploaded.md - - docs/models/operations/interval.md - docs/models/operations/licensekeysgetactivationrequest.md - docs/models/operations/licensekeysgetrequest.md - docs/models/operations/licensekeyslistqueryparamorganizationidfilter.md @@ -603,6 +605,7 @@ generatedFiles: - src/funcs/advertisementsList.ts - src/funcs/articlesCreate.ts - src/funcs/articlesDelete.ts + - src/funcs/articlesExport.ts - src/funcs/articlesGet.ts - src/funcs/articlesList.ts - src/funcs/articlesPreview.ts @@ -717,6 +720,7 @@ generatedFiles: - src/models/components/articlevisibility.ts - src/models/components/assignee.ts - src/models/components/author.ts + - src/models/components/benefit.ts - src/models/components/benefitads.ts - src/models/components/benefitadscreate.ts - src/models/components/benefitadsproperties.ts @@ -770,6 +774,7 @@ 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 @@ -804,6 +809,7 @@ generatedFiles: - src/models/components/fileuploadcompleted.ts - src/models/components/funding.ts - src/models/components/index.ts + - src/models/components/interval.ts - src/models/components/introspecttokenresponse.ts - src/models/components/issue.ts - src/models/components/label.ts @@ -814,6 +820,7 @@ generatedFiles: - src/models/components/licensekeyread.ts - src/models/components/licensekeystatus.ts - src/models/components/licensekeyupdate.ts + - src/models/components/licensekeyuser.ts - src/models/components/licensekeyvalidate.ts - src/models/components/licensekeywithactivations.ts - src/models/components/listresourcearticle.ts @@ -848,6 +855,7 @@ generatedFiles: - src/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.ts - src/models/components/onev11oauth21tokenpostxcomponentsrefreshtokenrequest.ts - src/models/components/order.ts + - src/models/components/orderbillingreason.ts - src/models/components/orderinvoice.ts - src/models/components/orderproduct.ts - src/models/components/ordersortproperty.ts @@ -952,7 +960,10 @@ generatedFiles: - src/models/components/webhookpledgeupdatedpayload.ts - src/models/components/webhookproductcreatedpayload.ts - src/models/components/webhookproductupdatedpayload.ts + - src/models/components/webhooksubscriptionactivepayload.ts + - src/models/components/webhooksubscriptioncanceledpayload.ts - src/models/components/webhooksubscriptioncreatedpayload.ts + - src/models/components/webhooksubscriptionrevokedpayload.ts - src/models/components/webhooksubscriptionupdatedpayload.ts - src/models/errors/alreadycanceledsubscription.ts - src/models/errors/filenotfound.ts @@ -967,6 +978,7 @@ generatedFiles: - src/models/operations/advertisementsget.ts - src/models/operations/advertisementslist.ts - src/models/operations/articlesdelete.ts + - src/models/operations/articlesexport.ts - src/models/operations/articlesget.ts - src/models/operations/articleslist.ts - src/models/operations/articlespreview.ts @@ -1267,7 +1279,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 90065, "usage": 558834, "limit_usage": 844199, "validations": 544221, "last_validated_at": "2024-06-29T09:01:50.308Z", "expires_at": "2023-07-26T06:33:15.886Z", "activations": []} + application/json: {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Keeley_Lebsack@hotmail.com", "avatar_url": "https://earnest-tuber.info/"}, "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 90065, "usage": 558834, "limit_usage": 844199, "validations": 544221, "last_validated_at": "2024-06-29T09:01:50.308Z", "expires_at": "2023-07-26T06:33:15.886Z", "activations": []} "401": application/json: {"detail": ""} "404": @@ -1279,7 +1291,7 @@ examples: application/json: {"key": "", "organization_id": ""} responses: "200": - application/json: {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 139635, "usage": 198036, "limit_usage": 824288, "validations": 220910, "last_validated_at": "2022-11-13T06:07:19.362Z", "expires_at": "2022-09-25T18:32:26.136Z"} + application/json: {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Clotilde.Frami@hotmail.com", "avatar_url": "https://aged-soliloquy.info/"}, "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 139635, "usage": 198036, "limit_usage": 824288, "validations": 220910, "last_validated_at": "2022-11-13T06:07:19.362Z", "expires_at": "2022-09-25T18:32:26.136Z"} "404": application/json: {"detail": ""} "422": {} @@ -1289,7 +1301,7 @@ examples: application/json: {"key": "", "organization_id": "", "label": ""} responses: "200": - application/json: {"id": "", "license_key_id": "", "label": "", "created_at": "2023-08-13T13:11:06.618Z", "modified_at": "2023-03-21T09:42:16.177Z", "license_key": {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "granted", "limit_activations": 95145, "usage": 923318, "limit_usage": 246615, "validations": 548731, "last_validated_at": "2023-03-31T03:55:03.497Z", "expires_at": "2024-06-27T10:16:03.791Z"}} + application/json: {"id": "", "license_key_id": "", "label": "", "created_at": "2023-08-13T13:11:06.618Z", "modified_at": "2023-03-21T09:42:16.177Z", "license_key": {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Clemens_Lowe80@yahoo.com", "avatar_url": "https://pushy-impostor.org/"}, "benefit_id": "", "key": "", "display_key": "", "status": "granted", "limit_activations": 95145, "usage": 923318, "limit_usage": 246615, "validations": 548731, "last_validated_at": "2023-03-31T03:55:03.497Z", "expires_at": "2024-06-27T10:16:03.791Z"}} "403": application/json: {"detail": ""} "404": @@ -1707,7 +1719,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2024-02-07T13:54:48.780Z", "modified_at": "2022-04-09T17:04:24.706Z", "id": "", "metadata": {"key": "", "key1": ""}, "amount": 558834, "tax_amount": 844199, "currency": "Ouguiya", "user_id": "", "product_id": "", "product_price_id": "", "subscription_id": "", "checkout_id": "", "user": {"id": "", "email": "Jovanny_Block45@hotmail.com", "public_name": "", "github_username": "", "avatar_url": ""}, "product": {"created_at": "2024-03-16T20:58:20.526Z", "modified_at": "2023-05-10T02:28:23.859Z", "id": "", "name": "", "description": "Inverse demand-driven superstructure", "is_recurring": true, "is_archived": true, "organization_id": ""}, "product_price": {"created_at": "2023-07-26T06:33:15.810Z", "modified_at": "2024-11-29T01:50:48.954Z", "id": "", "is_archived": true, "price_currency": "", "minimum_amount": 450824, "maximum_amount": 262795, "preset_amount": 213457}, "subscription": {"metadata": {"key": "", "key1": "", "key2": ""}, "created_at": "2024-12-06T14:08:11.458Z", "modified_at": "2022-08-30T01:43:46.083Z", "id": "", "amount": 521235, "currency": "Bulgarian Lev", "recurring_interval": "year", "status": "trialing", "current_period_start": "2022-12-10T13:21:21.114Z", "current_period_end": "2023-09-21T05:37:11.740Z", "cancel_at_period_end": true, "started_at": "2023-01-14T09:14:56.629Z", "ended_at": "2023-08-29T15:06:35.313Z", "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": "", "metadata": {"key": "", "key1": ""}, "amount": 558834, "tax_amount": 844199, "currency": "Ouguiya", "billing_reason": "subscription_cycle", "user_id": "", "product_id": "", "product_price_id": "", "subscription_id": "", "checkout_id": "", "user": {"id": "", "email": "Jovanny_Block45@hotmail.com", "public_name": "", "github_username": "", "avatar_url": ""}, "product": {"created_at": "2024-03-16T20:58:20.526Z", "modified_at": "2023-05-10T02:28:23.859Z", "id": "", "name": "", "description": "Inverse demand-driven superstructure", "is_recurring": true, "is_archived": true, "organization_id": ""}, "product_price": {"created_at": "2023-07-26T06:33:15.810Z", "modified_at": "2024-11-29T01:50:48.954Z", "id": "", "is_archived": true, "price_currency": "", "minimum_amount": 450824, "maximum_amount": 262795, "preset_amount": 213457}, "subscription": {"metadata": {"key": "", "key1": "", "key2": ""}, "created_at": "2024-12-06T14:08:11.458Z", "modified_at": "2022-08-30T01:43:46.083Z", "id": "", "amount": 521235, "currency": "Bulgarian Lev", "recurring_interval": "year", "status": "trialing", "current_period_start": "2022-12-10T13:21:21.114Z", "current_period_end": "2023-09-21T05:37:11.740Z", "cancel_at_period_end": true, "started_at": "2023-01-14T09:14:56.629Z", "ended_at": "2023-08-29T15:06:35.313Z", "user_id": "", "product_id": "", "price_id": "", "checkout_id": ""}} "404": application/json: {"detail": ""} "422": {} @@ -1817,7 +1829,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 90065, "usage": 558834, "limit_usage": 844199, "validations": 544221, "last_validated_at": "2024-06-29T09:01:50.308Z", "expires_at": "2023-07-26T06:33:15.886Z", "activations": []} + application/json: {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Keeley_Lebsack@hotmail.com", "avatar_url": "https://earnest-tuber.info/"}, "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 90065, "usage": 558834, "limit_usage": 844199, "validations": 544221, "last_validated_at": "2024-06-29T09:01:50.308Z", "expires_at": "2023-07-26T06:33:15.886Z", "activations": []} "401": application/json: {"detail": ""} "404": @@ -1830,7 +1842,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 24555, "usage": 597129, "limit_usage": 15652, "validations": 344620, "last_validated_at": "2024-02-16T11:11:26.963Z", "expires_at": "2024-12-22T15:27:45.933Z"} + application/json: {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Lavern48@hotmail.com", "avatar_url": "https://unlucky-hydrolyze.biz/"}, "benefit_id": "", "key": "", "display_key": "", "status": "disabled", "limit_activations": 24555, "usage": 597129, "limit_usage": 15652, "validations": 344620, "last_validated_at": "2024-02-16T11:11:26.963Z", "expires_at": "2024-12-22T15:27:45.933Z"} "401": application/json: {"detail": ""} "404": @@ -1844,7 +1856,7 @@ examples: activation_id: "" responses: "200": - application/json: {"id": "", "license_key_id": "", "label": "", "created_at": "2023-12-01T08:59:23.884Z", "modified_at": "2024-08-24T19:22:44.851Z", "license_key": {"id": "", "organization_id": "", "user_id": "", "benefit_id": "", "key": "", "display_key": "", "status": "revoked", "limit_activations": 291118, "usage": 806587, "limit_usage": 221587, "validations": 620000, "last_validated_at": "2022-10-02T13:06:32.609Z", "expires_at": "2022-08-12T06:04:08.773Z"}} + application/json: {"id": "", "license_key_id": "", "label": "", "created_at": "2023-12-01T08:59:23.884Z", "modified_at": "2024-08-24T19:22:44.851Z", "license_key": {"id": "", "organization_id": "", "user_id": "", "user": {"id": "", "public_name": "", "email": "Jammie.Mraz@yahoo.com", "avatar_url": "https://crowded-annual.info"}, "benefit_id": "", "key": "", "display_key": "", "status": "revoked", "limit_activations": 291118, "usage": 806587, "limit_usage": 221587, "validations": 620000, "last_validated_at": "2022-10-02T13:06:32.609Z", "expires_at": "2022-08-12T06:04:08.773Z"}} "401": application/json: {"detail": ""} "404": @@ -1893,7 +1905,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": "", "expires_at": "2023-08-07T16:01:01.665Z", "success_url": "https://obedient-operating.org/", "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": "2024-08-05T16:21:06.140Z", "modified_at": "2022-02-17T11:15:43.137Z", "id": "", "description": "dramatic old-fashioned catalog indeed save orchestrate yippee", "selectable": true, "deletable": true, "organization_id": "", "properties": {"paid_articles": true}}, {"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": "2022-12-03T08:08:37.108Z", "modified_at": "2023-06-18T22:45:32.983Z", "id": "", "is_archived": true, "price_currency": "", "price_amount": 916344}, "url": "https://lumpy-jellyfish.com"} + application/json: {"created_at": "2022-06-23T19:45:02.115Z", "modified_at": "2022-11-26T05:04:17.930Z", "id": "", "status": "succeeded", "client_secret": "", "expires_at": "2023-08-07T16:01:01.665Z", "success_url": "https://obedient-operating.org/", "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": "2023-12-08T10:02:16.170Z", "modified_at": "2022-05-07T00:40:28.451Z", "id": "", "is_archived": true, "price_currency": "", "minimum_amount": 158060, "maximum_amount": 193250, "preset_amount": 588843, "recurring_interval": "month"}, "url": "https://lumpy-jellyfish.com"} "404": application/json: {"detail": ""} "422": {} @@ -1904,7 +1916,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": "", "expires_at": "2023-07-14T01:44:24.320Z", "success_url": "https://passionate-understanding.com/", "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": "2023-05-18T03:23:17.454Z", "modified_at": "2023-05-12T02:46:47.249Z", "id": "", "is_archived": false, "price_currency": "", "price_amount": 397244}, {"created_at": "2024-07-17T17:12:46.256Z", "modified_at": "2022-05-05T14:10:40.215Z", "id": "", "is_archived": true, "price_currency": "", "price_amount": 332353, "recurring_interval": "year"}, {"created_at": "2023-07-26T03:19:06.461Z", "modified_at": "2024-12-17T05:21:34.525Z", "id": "", "is_archived": false, "price_currency": "", "minimum_amount": 176169, "maximum_amount": 827753, "preset_amount": 768625}], "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": "2024-11-26T08:39:18.244Z", "modified_at": "2022-08-06T22:52:15.498Z", "id": "", "is_archived": true, "price_currency": "", "minimum_amount": 859643, "maximum_amount": 413943, "preset_amount": 162847}, "url": "https://simple-flint.org/"} + application/json: {"created_at": "2024-10-22T20:45:21.815Z", "modified_at": "2023-07-17T23:31:05.499Z", "id": "", "status": "expired", "client_secret": "", "expires_at": "2023-07-14T01:44:24.320Z", "success_url": "https://passionate-understanding.com/", "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, "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}, {"created_at": "2024-07-08T15:45:04.860Z", "modified_at": "2023-09-22T09:06:50.882Z", "id": "", "is_archived": true, "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, "price_currency": "", "price_amount": 172495}, "url": "https://simple-flint.org/"} "404": application/json: {"detail": ""} "422": {} @@ -1915,7 +1927,16 @@ 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": "", "expires_at": "2022-07-30T06:29:51.767Z", "success_url": "https://secondary-gallery.net", "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": "2024-02-24T15:04:47.497Z", "modified_at": "2023-05-29T07:44:57.350Z", "id": "", "is_archived": true, "price_currency": "", "minimum_amount": 374415, "maximum_amount": 368960, "preset_amount": 837753, "recurring_interval": "year"}], "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-10-03T19:17:53.981Z", "modified_at": "2023-08-02T07:58:58.651Z", "id": "", "description": "ha restfully filter", "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": "2022-11-22T10:10:52.850Z", "modified_at": "2024-03-28T19:26:19.018Z", "id": "", "is_archived": true, "recurring_interval": "month"}, "url": "https://apt-devastation.biz/"} + application/json: {"created_at": "2024-09-27T22:33:04.250Z", "modified_at": "2024-07-24T02:45:26.067Z", "id": "", "status": "succeeded", "client_secret": "", "expires_at": "2022-07-30T06:29:51.767Z", "success_url": "https://secondary-gallery.net", "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}], "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, "price_currency": "", "minimum_amount": 638939, "maximum_amount": 942266, "preset_amount": 508098}, "url": "https://apt-devastation.biz/"} "404": application/json: {"detail": ""} "422": {} + articles:export: + speakeasy-default-articles:export: + parameters: + query: + organization_id: "cf4e3d5e-2b50-4470-a85b-8d021391fabb" + responses: + "200": + application/json: "" + "422": {} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 4a45c003..a9896139 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -15,7 +15,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true typescript: - version: 0.13.0 + version: 0.13.1 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index ad2b11d4..94ce3bbf 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.414.1 +speakeasyVersion: 1.418.4 sources: Polar-OAS: sourceNamespace: polar-oas - sourceRevisionDigest: sha256:42496c2c1381522d95c89a43a7bbb5d2598aed8b34542782ced0831e3121b723 - sourceBlobDigest: sha256:e17ea29a2bc4fc5f01ead9a66ea39f07913e6ea3732e5ecf47675de704af2041 + sourceRevisionDigest: sha256:f87d955636fb8c810a7062a8e3ed99ec716281562a4cb47b3053856bc2e8fb73 + sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed tags: - latest - main @@ -11,8 +11,8 @@ targets: polar: source: Polar-OAS sourceNamespace: polar-oas - sourceRevisionDigest: sha256:42496c2c1381522d95c89a43a7bbb5d2598aed8b34542782ced0831e3121b723 - sourceBlobDigest: sha256:e17ea29a2bc4fc5f01ead9a66ea39f07913e6ea3732e5ecf47675de704af2041 + sourceRevisionDigest: sha256:f87d955636fb8c810a7062a8e3ed99ec716281562a4cb47b3053856bc2e8fb73 + sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 7ba60495..952fe10c 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,7 @@ run(); * [list](docs/sdks/articles/README.md#list) - List Articles * [create](docs/sdks/articles/README.md#create) - Create Article +* [export](docs/sdks/articles/README.md#export) - Export Articles * [get](docs/sdks/articles/README.md#get) - Get Article * [update](docs/sdks/articles/README.md#update) - Update Article * [delete](docs/sdks/articles/README.md#delete) - Delete Article @@ -285,6 +286,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`advertisementsList`](docs/sdks/advertisements/README.md#list) - List Campaigns - [`articlesCreate`](docs/sdks/articles/README.md#create) - Create Article - [`articlesDelete`](docs/sdks/articles/README.md#delete) - Delete Article +- [`articlesExport`](docs/sdks/articles/README.md#export) - Export Articles - [`articlesGet`](docs/sdks/articles/README.md#get) - Get Article - [`articlesList`](docs/sdks/articles/README.md#list) - List Articles - [`articlesPreview`](docs/sdks/articles/README.md#preview) - Send Article Preview diff --git a/RELEASES.md b/RELEASES.md index a64dcc88..436e24b3 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -118,4 +118,14 @@ Based on: ### Generated - [typescript v0.13.0] . ### Releases -- [NPM v0.13.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.0 - . \ No newline at end of file +- [NPM v0.13.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.0 - . + +## 2024-10-16 00:25:52 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.418.4 (2.438.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.13.1] . +### Releases +- [NPM v0.13.1] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.1 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index d75cc7f6..4bd05670 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -27,6 +27,12 @@ actions: - "lang": "typescript" "label": "create" "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.articles.create({\n title: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" + - target: $["paths"]["/v1/articles/export"]["get"] + update: + "x-codeSamples": + - "lang": "typescript" + "label": "export" + "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.articles.export({\n organizationId: \"cf4e3d5e-2b50-4470-a85b-8d021391fabb\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" - target: $["paths"]["/v1/articles/{id}"]["delete"] update: "x-codeSamples": diff --git a/docs/models/components/address.md b/docs/models/components/address.md index 9e52251f..78e35a12 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: "Liechtenstein", + country: "Papua New Guinea", }; ``` diff --git a/docs/models/components/advertisementcampaign.md b/docs/models/components/advertisementcampaign.md index ccd77c56..ade1a784 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("2024-08-30T20:05:14.177Z"), - modifiedAt: new Date("2024-08-16T19:55:21.868Z"), + createdAt: new Date("2023-12-22T00:45:52.216Z"), + modifiedAt: new Date("2022-10-03T04:08:49.934Z"), id: "", - imageUrl: "https://square-fowl.org/", - imageUrlDark: "https://narrow-interior.name", + imageUrl: "https://burly-replacement.info", + imageUrlDark: "https://damp-advertisement.net/", text: "", - linkUrl: "https://brown-governance.net/", + linkUrl: "https://lovely-excess.info", }; ``` diff --git a/docs/models/components/advertisementcampaignlistresource.md b/docs/models/components/advertisementcampaignlistresource.md index 7f4e1bbf..e455920e 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-07-11T03:19:08.621Z"), - modifiedAt: new Date("2024-01-18T21:54:07.604Z"), + createdAt: new Date("2024-03-01T07:32:00.160Z"), + modifiedAt: new Date("2023-10-16T13:56:30.312Z"), id: "", - imageUrl: "https://awful-swim.biz", - imageUrlDark: "https://oblong-finer.org", + imageUrl: "https://extra-large-daughter.info/", + imageUrlDark: "https://forsaken-recommendation.name/", text: "", - linkUrl: "https://foolhardy-cow.info", + linkUrl: "https://silky-airbus.name", }, ], pagination: { - totalCount: 332116, - maxPage: 159757, + totalCount: 438417, + maxPage: 361300, }, dimensions: [ - 937408, + 992382, ], }; ``` diff --git a/docs/models/components/advertisementsortproperty.md b/docs/models/components/advertisementsortproperty.md index f7e291e5..9842da04 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 = "-views"; +let value: AdvertisementSortProperty = "-clicks"; ``` ## Values diff --git a/docs/models/components/article.md b/docs/models/components/article.md index d682cd77..334bed59 100644 --- a/docs/models/components/article.md +++ b/docs/models/components/article.md @@ -12,40 +12,40 @@ let value: Article = { body: "", byline: { name: "", - avatarUrl: "https://bleak-median.com", + avatarUrl: "https://yellowish-resolve.info", }, visibility: "private", userId: "", organizationId: "", organization: { - createdAt: new Date("2023-04-30T01:03:37.412Z"), - modifiedAt: new Date("2024-09-30T03:17:45.166Z"), + createdAt: new Date("2024-03-11T04:48:45.754Z"), + modifiedAt: new Date("2022-12-10T00:54:33.907Z"), id: "", name: "", slug: "", - avatarUrl: "https://wry-bakeware.com/", + avatarUrl: "https://cooperative-fuel.name", bio: "", - company: "Sanford, Franey and Franecki", + company: "Pagac and Sons", blog: "", location: "", - email: "Tyra_Sipes@yahoo.com", + email: "Noah.Grady@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 986941, + pledgeMinimumAmount: 507819, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 95645, + defaultUpfrontSplitToContributors: 211584, donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2023-05-02T03:02:44.155Z"), + publishedAt: new Date("2023-06-26T04:55:39.703Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2024-04-18T06:42:06.014Z"), + paidSubscribersOnlyEndsAt: new Date("2024-06-09T18:38:23.027Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2024-12-20T13:50:06.096Z"), - emailSentToCount: 119716, - ogImageUrl: "https://sleepy-mythology.org/", + notificationsSentAt: new Date("2024-08-25T15:21:53.101Z"), + emailSentToCount: 666762, + ogImageUrl: "https://trusty-heroine.biz/", ogDescription: "", }; ``` diff --git a/docs/models/components/articlebyline.md b/docs/models/components/articlebyline.md index fc26bea6..2b921f76 100644 --- a/docs/models/components/articlebyline.md +++ b/docs/models/components/articlebyline.md @@ -5,7 +5,7 @@ ```typescript import { ArticleByline } from "@polar-sh/sdk/models/components"; -let value: ArticleByline = "user"; +let value: ArticleByline = "organization"; ``` ## Values diff --git a/docs/models/components/articlecreate.md b/docs/models/components/articlecreate.md index f8554df9..93bfee1d 100644 --- a/docs/models/components/articlecreate.md +++ b/docs/models/components/articlecreate.md @@ -19,8 +19,8 @@ let value: ArticleCreate = { | `body` | *string* | :heavy_minus_sign: | Body in string format. Either one of body or body_base64 is required. | | `bodyBase64` | *string* | :heavy_minus_sign: | Body in base64-encoded format. Can be helpful to bypass Web Application Firewalls (WAF). Either one of body or body_base64 is required. | | `organizationId` | *string* | :heavy_minus_sign: | The ID of the organization owning the article. **Required unless you use an organization token.** | -| `byline` | [components.ArticleCreateArticleByline](../../models/components/articlecreatearticlebyline.md) | :heavy_minus_sign: | If the user or organization should be credited in the byline. | -| `visibility` | [components.ArticleCreateArticleVisibility](../../models/components/articlecreatearticlevisibility.md) | :heavy_minus_sign: | N/A | +| `byline` | [components.ArticleByline](../../models/components/articlebyline.md) | :heavy_minus_sign: | N/A | +| `visibility` | [components.ArticleVisibility](../../models/components/articlevisibility.md) | :heavy_minus_sign: | N/A | | `paidSubscribersOnly` | *boolean* | :heavy_minus_sign: | Set to true to only make this article available for subscribers to a paid subscription tier in the organization. | | `paidSubscribersOnlyEndsAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | If specified, time at which the article should no longer be restricted to paid subscribers. Only relevant if `paid_subscribers_only` is true. | | `publishedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Time of publishing. If this date is in the future, the post will be scheduled to publish at this time. If visibility is 'public', published_at will default to the current time. | diff --git a/docs/models/components/articlecreatearticlebyline.md b/docs/models/components/articlecreatearticlebyline.md deleted file mode 100644 index 70acdf9c..00000000 --- a/docs/models/components/articlecreatearticlebyline.md +++ /dev/null @@ -1,17 +0,0 @@ -# ArticleCreateArticleByline - -If the user or organization should be credited in the byline. - -## Example Usage - -```typescript -import { ArticleCreateArticleByline } from "@polar-sh/sdk/models/components"; - -let value: ArticleCreateArticleByline = "user"; -``` - -## Values - -```typescript -"user" | "organization" -``` \ No newline at end of file diff --git a/docs/models/components/articlecreatearticlevisibility.md b/docs/models/components/articlecreatearticlevisibility.md deleted file mode 100644 index d168782f..00000000 --- a/docs/models/components/articlecreatearticlevisibility.md +++ /dev/null @@ -1,15 +0,0 @@ -# ArticleCreateArticleVisibility - -## Example Usage - -```typescript -import { ArticleCreateArticleVisibility } from "@polar-sh/sdk/models/components"; - -let value: ArticleCreateArticleVisibility = "hidden"; -``` - -## Values - -```typescript -"public" | "hidden" | "private" -``` \ No newline at end of file diff --git a/docs/models/components/articlepreview.md b/docs/models/components/articlepreview.md index 20276bcc..c22de92e 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: "Velma51@yahoo.com", + email: "Malachi_Windler38@hotmail.com", }; ``` diff --git a/docs/models/components/articlereceivers.md b/docs/models/components/articlereceivers.md index 31ba5297..4f373422 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: 689029, - premiumSubscribers: 15446, - organizationMembers: 647089, + freeSubscribers: 194526, + premiumSubscribers: 736480, + organizationMembers: 165116, }; ``` diff --git a/docs/models/components/assignee.md b/docs/models/components/assignee.md index b2e49b86..d81e4e70 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: 26189, - login: "Madalyn_Quigley5", - htmlUrl: "https://twin-singing.name", - avatarUrl: "https://which-thorn.com/", + id: 636696, + login: "Stella.Champlin94", + htmlUrl: "https://esteemed-lay.info", + avatarUrl: "https://sugary-zebra.biz", }; ``` diff --git a/docs/models/components/author.md b/docs/models/components/author.md index 04074083..dbcfaa42 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: 121066, - login: "Kariane.Kohler42", - htmlUrl: "https://near-hammock.com", - avatarUrl: "https://obvious-pendant.net", + id: 436663, + login: "Garrick_Ferry87", + htmlUrl: "https://wasteful-confusion.com", + avatarUrl: "https://avaricious-earth.org", }; ``` diff --git a/docs/models/components/benefit.md b/docs/models/components/benefit.md index ebe80ea8..d3628ed5 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("2022-10-20T17:39:45.167Z"), - modifiedAt: new Date("2022-05-21T01:38:02.928Z"), + createdAt: new Date("2023-06-06T10:43:50.149Z"), + modifiedAt: new Date("2022-11-13T23:20:26.533Z"), id: "", description: - "overconfidently punctually anneal although amongst supposing elastic", + "yak chilly instantly foolishly quantify phooey as opera stabilise", selectable: false, deletable: false, organizationId: "", @@ -25,11 +25,10 @@ const value: components.BenefitArticles = { ```typescript const value: components.BenefitAds = { - createdAt: new Date("2024-11-25T18:02:23.702Z"), - modifiedAt: new Date("2022-03-29T08:13:52.389Z"), + createdAt: new Date("2022-02-07T17:40:49.949Z"), + modifiedAt: new Date("2022-04-12T05:09:19.218Z"), id: "", - description: - "um phew about helpless astride breed essential huzzah oxygenate", + description: "curl fully brook mmm bah carp gah off er bah", selectable: false, deletable: false, organizationId: "", @@ -41,10 +40,10 @@ const value: components.BenefitAds = { ```typescript const value: components.BenefitCustom = { - createdAt: new Date("2024-10-12T17:44:21.842Z"), - modifiedAt: new Date("2022-09-18T20:45:01.005Z"), + createdAt: new Date("2023-04-16T01:44:35.832Z"), + modifiedAt: new Date("2023-04-23T10:52:03.142Z"), id: "", - description: "lovable eek glow anxiously hidden or", + description: "lotion simple er doubtfully", selectable: false, deletable: false, organizationId: "", @@ -59,10 +58,10 @@ const value: components.BenefitCustom = { ```typescript const value: components.BenefitDiscord = { - createdAt: new Date("2022-03-31T15:24:09.344Z"), - modifiedAt: new Date("2024-08-03T03:25:30.360Z"), + createdAt: new Date("2023-04-11T20:54:26.937Z"), + modifiedAt: new Date("2023-02-23T06:18:24.673Z"), id: "", - description: "ew svelte contravene till crumble", + description: "space informal minus dark while beyond untimely whenever", selectable: false, deletable: false, organizationId: "", @@ -78,10 +77,10 @@ const value: components.BenefitDiscord = { ```typescript const value: components.BenefitGitHubRepository = { - createdAt: new Date("2024-11-25T03:26:32.516Z"), - modifiedAt: new Date("2023-06-30T12:33:10.822Z"), + createdAt: new Date("2024-08-29T10:56:21.811Z"), + modifiedAt: new Date("2023-05-07T08:26:35.788Z"), id: "", - description: "between than yahoo", + description: "save dapper untimely spark once charlatan hm except", selectable: false, deletable: false, organizationId: "", @@ -89,7 +88,7 @@ const value: components.BenefitGitHubRepository = { repositoryId: "", repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "pull", }, }; ``` @@ -98,11 +97,10 @@ const value: components.BenefitGitHubRepository = { ```typescript const value: components.BenefitDownloadables = { - createdAt: new Date("2022-10-16T01:37:14.449Z"), - modifiedAt: new Date("2024-09-30T14:09:22.071Z"), + createdAt: new Date("2024-10-06T08:46:10.626Z"), + modifiedAt: new Date("2022-08-21T10:30:21.944Z"), id: "", - description: - "powerfully fooey excitedly tentacle even monstrous plait indeed", + description: "perky if defiantly reassemble information adrenalin", selectable: false, deletable: false, organizationId: "", @@ -121,25 +119,24 @@ const value: components.BenefitDownloadables = { ```typescript const value: components.BenefitLicenseKeys = { - createdAt: new Date("2022-08-26T19:56:08.017Z"), - modifiedAt: new Date("2024-09-26T15:04:08.995Z"), + createdAt: new Date("2023-11-26T13:41:08.143Z"), + modifiedAt: new Date("2023-12-31T14:12:56.950Z"), id: "", - description: - "triumphantly footrest coexist hammock rag display ostrich aboard pfft so", + description: "underneath phew scholarship what shabby bloom blah", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 217340, + ttl: 459112, timeframe: "day", }, activations: { - limit: 783687, + limit: 316392, enableUserAdmin: false, }, - limitUsage: 127908, + limitUsage: 906531, }, }; ``` diff --git a/docs/models/components/benefitads.md b/docs/models/components/benefitads.md index 2f93dec5..ed4d4fdc 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-11-08T20:16:52.924Z"), - modifiedAt: new Date("2024-03-20T05:44:31.552Z"), + createdAt: new Date("2024-10-28T02:42:30.721Z"), + modifiedAt: new Date("2022-07-03T20:54:21.016Z"), id: "", - description: "yowza yippee old-fashioned that or ouch splurge", + description: "eek override absent", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitadscreate.md b/docs/models/components/benefitadscreate.md index aa3ce221..6537c239 100644 --- a/docs/models/components/benefitadscreate.md +++ b/docs/models/components/benefitadscreate.md @@ -6,7 +6,8 @@ import { BenefitAdsCreate } from "@polar-sh/sdk/models/components"; let value: BenefitAdsCreate = { - description: "honestly under huzzah providence boyfriend rawhide", + description: + "solemnly circa suspiciously every commonly meaningfully lender annual gummy", properties: {}, }; ``` diff --git a/docs/models/components/benefitadssubscriber.md b/docs/models/components/benefitadssubscriber.md index 27e95a26..7e8cba7a 100644 --- a/docs/models/components/benefitadssubscriber.md +++ b/docs/models/components/benefitadssubscriber.md @@ -6,19 +6,19 @@ import { BenefitAdsSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitAdsSubscriber = { - createdAt: new Date("2022-04-18T07:39:21.900Z"), - modifiedAt: new Date("2023-07-04T08:31:11.803Z"), + createdAt: new Date("2023-08-03T23:23:59.966Z"), + modifiedAt: new Date("2023-08-18T21:58:52.875Z"), id: "", description: - "till congregate inhibit unlucky helpless oof tuba greatly sans jaggedly", + "dividend investigate minty louse ferret commonly talkative liberalize", selectable: false, deletable: false, organizationId: "", properties: {}, grants: [ { - createdAt: new Date("2023-08-18T14:04:25.286Z"), - modifiedAt: new Date("2022-10-16T21:08:46.705Z"), + createdAt: new Date("2022-09-25T08:37:09.478Z"), + modifiedAt: new Date("2024-03-02T11:27:13.468Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitarticles.md b/docs/models/components/benefitarticles.md index e719baad..1b59cc9c 100644 --- a/docs/models/components/benefitarticles.md +++ b/docs/models/components/benefitarticles.md @@ -10,11 +10,10 @@ Use it to grant access to posts. import { BenefitArticles } from "@polar-sh/sdk/models/components"; let value: BenefitArticles = { - createdAt: new Date("2024-08-13T00:48:23.012Z"), - modifiedAt: new Date("2023-02-03T04:35:58.234Z"), + createdAt: new Date("2023-03-11T21:56:42.620Z"), + modifiedAt: new Date("2023-04-20T20:35:52.502Z"), id: "", - description: - "circumnavigate hastily in meanwhile oxidize except understanding ascribe", + description: "broadcast whoever triangular past", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitarticlessubscriber.md b/docs/models/components/benefitarticlessubscriber.md index 882997c1..5b7420ee 100644 --- a/docs/models/components/benefitarticlessubscriber.md +++ b/docs/models/components/benefitarticlessubscriber.md @@ -6,10 +6,10 @@ import { BenefitArticlesSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitArticlesSubscriber = { - createdAt: new Date("2024-11-26T08:57:48.541Z"), - modifiedAt: new Date("2024-06-27T02:43:23.928Z"), + createdAt: new Date("2024-10-28T06:45:26.918Z"), + modifiedAt: new Date("2023-09-23T21:28:43.149Z"), id: "", - description: "a mmm upsell more short who sign flowery", + description: "foolishly why beside commonly intently prime hm", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitbase.md b/docs/models/components/benefitbase.md index f7031893..439b44b7 100644 --- a/docs/models/components/benefitbase.md +++ b/docs/models/components/benefitbase.md @@ -6,12 +6,12 @@ import { BenefitBase } from "@polar-sh/sdk/models/components"; let value: BenefitBase = { - createdAt: new Date("2023-09-11T01:48:22.048Z"), - modifiedAt: new Date("2024-01-22T07:34:32.676Z"), + createdAt: new Date("2022-10-26T13:05:57.095Z"), + modifiedAt: new Date("2024-02-17T17:04:58.533Z"), id: "", - type: "downloadables", + type: "articles", description: - "encouragement openly painfully unabashedly sticky once fathom collaborate hepatitis", + "up loosely coil sympathetically whether convoke confirm mid individual", selectable: false, deletable: false, organizationId: "", @@ -25,7 +25,7 @@ let value: BenefitBase = { | `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.BenefitType](../../models/components/benefittype.md) | :heavy_check_mark: | The type of the benefit. | +| `type` | [components.BenefitType](../../models/components/benefittype.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. | diff --git a/docs/models/components/benefitcustom.md b/docs/models/components/benefitcustom.md index f7108a20..1d7dbd51 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-05-02T16:25:41.913Z"), - modifiedAt: new Date("2024-03-15T04:28:30.370Z"), + createdAt: new Date("2024-05-18T02:46:56.122Z"), + modifiedAt: new Date("2024-01-08T16:05:33.519Z"), id: "", - description: "finally notwithstanding merrily quip muddy around", + description: "capsize ew as serpentine surprisingly orange", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitcustomcreate.md b/docs/models/components/benefitcustomcreate.md index 1e94c51c..3d52e6aa 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: "indeed apud decouple yuck huzzah worriedly abacus", + description: "char notwithstanding yuck inside", isTaxApplicable: false, properties: {}, }; diff --git a/docs/models/components/benefitcustomsubscriber.md b/docs/models/components/benefitcustomsubscriber.md index 9ed48c48..9c229a06 100644 --- a/docs/models/components/benefitcustomsubscriber.md +++ b/docs/models/components/benefitcustomsubscriber.md @@ -6,18 +6,17 @@ import { BenefitCustomSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitCustomSubscriber = { - createdAt: new Date("2023-01-15T19:49:53.185Z"), - modifiedAt: new Date("2023-07-20T09:01:53.227Z"), + createdAt: new Date("2023-01-23T08:27:25.525Z"), + modifiedAt: new Date("2022-10-16T03:05:22.272Z"), id: "", - description: - "save jiggle although psst superficial enthusiastically but jealously", + description: "respray coagulate submissive ridge veg", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-08-11T14:00:17.759Z"), - modifiedAt: new Date("2024-02-28T15:41:38.993Z"), + createdAt: new Date("2022-01-26T11:12:58.424Z"), + modifiedAt: new Date("2023-08-06T02:09:12.930Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitdiscord.md b/docs/models/components/benefitdiscord.md index 610afd24..e26a4989 100644 --- a/docs/models/components/benefitdiscord.md +++ b/docs/models/components/benefitdiscord.md @@ -10,11 +10,11 @@ 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("2022-08-07T22:18:55.052Z"), - modifiedAt: new Date("2024-03-31T18:00:09.052Z"), + createdAt: new Date("2022-06-06T12:51:23.470Z"), + modifiedAt: new Date("2024-08-05T23:18:52.742Z"), id: "", description: - "lanky politely feminize deduction sometimes sarong legging sophisticated", + "apropos separate impish whenever viability outside blissfully crocodile gladly", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdiscordcreate.md b/docs/models/components/benefitdiscordcreate.md index f609e7f1..e969a6d5 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: - "fooey assured meanwhile once uh-huh loudly even emboss doubtfully aha", + description: "whoa microblog overconfidently punctually", properties: { guildToken: "", roleId: "", diff --git a/docs/models/components/benefitdiscordinput.md b/docs/models/components/benefitdiscordinput.md index cdaf408d..4d4d73e3 100644 --- a/docs/models/components/benefitdiscordinput.md +++ b/docs/models/components/benefitdiscordinput.md @@ -10,10 +10,11 @@ Use it to automatically invite your backers to a Discord server. import { BenefitDiscordInput } from "@polar-sh/sdk/models/components"; let value: BenefitDiscordInput = { - createdAt: new Date("2023-01-15T10:39:41.179Z"), - modifiedAt: new Date("2022-07-02T07:43:41.839Z"), + createdAt: new Date("2023-10-26T18:56:37.422Z"), + modifiedAt: new Date("2024-01-09T18:32:25.623Z"), id: "", - description: "joyfully annual doodle dish redress up dowse aw for", + description: + "anticodon instead instead yippee narrate apud fully curse decisive firsthand", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdiscordsubscriber.md b/docs/models/components/benefitdiscordsubscriber.md index a35b3a91..da7123c9 100644 --- a/docs/models/components/benefitdiscordsubscriber.md +++ b/docs/models/components/benefitdiscordsubscriber.md @@ -6,11 +6,10 @@ import { BenefitDiscordSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitDiscordSubscriber = { - createdAt: new Date("2024-02-26T00:50:26.019Z"), - modifiedAt: new Date("2023-01-24T03:16:54.696Z"), + createdAt: new Date("2024-07-15T12:42:19.873Z"), + modifiedAt: new Date("2023-08-09T19:43:23.369Z"), id: "", - description: - "majestically because weatherize airbrush happily short-term galoshes", + description: "flight swathe amongst dislocate however entire", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdownloadables.md b/docs/models/components/benefitdownloadables.md index 0a9e46dc..3e7370b6 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("2024-05-03T07:58:46.256Z"), - modifiedAt: new Date("2022-03-30T07:01:36.026Z"), + createdAt: new Date("2022-10-03T02:53:48.626Z"), + modifiedAt: new Date("2022-03-13T16:03:30.818Z"), id: "", - description: "yet rarely dally woot down whereas team since", + description: "psst liberalize besmirch distinction adviser accompanist", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitdownloadablescreate.md b/docs/models/components/benefitdownloadablescreate.md index 1cdec143..7eaa39f7 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: "not subsidy a petticoat emerge on pension solemnly", + description: "flickering old-fashioned which", properties: { files: [ "", diff --git a/docs/models/components/benefitdownloadablessubscriber.md b/docs/models/components/benefitdownloadablessubscriber.md index 054cca6b..d5e572b8 100644 --- a/docs/models/components/benefitdownloadablessubscriber.md +++ b/docs/models/components/benefitdownloadablessubscriber.md @@ -6,10 +6,10 @@ import { BenefitDownloadablesSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitDownloadablesSubscriber = { - createdAt: new Date("2022-05-28T17:43:25.762Z"), - modifiedAt: new Date("2024-05-21T08:36:06.500Z"), + createdAt: new Date("2022-10-25T06:04:46.666Z"), + modifiedAt: new Date("2022-04-19T08:02:38.105Z"), id: "", - description: "yum exterior pfft throughout absent", + description: "only self-confidence reluctantly conceal toward happily", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitgithubrepository.md b/docs/models/components/benefitgithubrepository.md index d8ff08ce..e1a1123b 100644 --- a/docs/models/components/benefitgithubrepository.md +++ b/docs/models/components/benefitgithubrepository.md @@ -10,10 +10,11 @@ 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("2022-09-13T04:57:46.520Z"), - modifiedAt: new Date("2022-08-31T13:02:18.053Z"), + createdAt: new Date("2023-02-10T13:04:40.129Z"), + modifiedAt: new Date("2023-09-24T23:30:10.421Z"), id: "", - description: "beyond encode eke whose rightfully hence", + description: + "versus shoulder whereas around generously from intensely underneath what", selectable: false, deletable: false, organizationId: "", @@ -21,7 +22,7 @@ let value: BenefitGitHubRepository = { repositoryId: "", repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "admin", }, }; ``` diff --git a/docs/models/components/benefitgithubrepositorycreate.md b/docs/models/components/benefitgithubrepositorycreate.md index ea0f0b56..9d312560 100644 --- a/docs/models/components/benefitgithubrepositorycreate.md +++ b/docs/models/components/benefitgithubrepositorycreate.md @@ -6,12 +6,11 @@ import { BenefitGitHubRepositoryCreate } from "@polar-sh/sdk/models/components"; let value: BenefitGitHubRepositoryCreate = { - description: - "aw t-shirt short briskly pink behest yet huzzah than magnificent", + description: "what over suddenly ack volunteer", properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "pull", }, }; ``` diff --git a/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md b/docs/models/components/benefitgithubrepositorycreatepropertiespermission.md index 5e1ecf62..937b0aa3 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 = "pull"; +let value: BenefitGitHubRepositoryCreatePropertiesPermission = "maintain"; ``` ## Values diff --git a/docs/models/components/benefitgithubrepositorysubscriber.md b/docs/models/components/benefitgithubrepositorysubscriber.md index 6441aa8c..6b65184f 100644 --- a/docs/models/components/benefitgithubrepositorysubscriber.md +++ b/docs/models/components/benefitgithubrepositorysubscriber.md @@ -6,10 +6,11 @@ import { BenefitGitHubRepositorySubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitGitHubRepositorySubscriber = { - createdAt: new Date("2022-07-23T22:58:59.535Z"), - modifiedAt: new Date("2022-02-10T23:22:02.780Z"), + createdAt: new Date("2023-10-06T21:17:53.356Z"), + modifiedAt: new Date("2024-04-26T18:34:45.819Z"), id: "", - description: "warp now likewise printer even boo amongst", + description: + "hourly as whenever antagonize obstruct overburden mountain wrongly plan", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefitgithubrepositoryupdate.md b/docs/models/components/benefitgithubrepositoryupdate.md index cf3c5b2c..f0948d2e 100644 --- a/docs/models/components/benefitgithubrepositoryupdate.md +++ b/docs/models/components/benefitgithubrepositoryupdate.md @@ -9,7 +9,7 @@ let value: BenefitGitHubRepositoryUpdate = { properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "triage", }, }; ``` diff --git a/docs/models/components/benefitgrant.md b/docs/models/components/benefitgrant.md index 414fcf99..d16f7c85 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("2024-08-21T18:47:35.544Z"), - modifiedAt: new Date("2022-06-07T04:12:06.961Z"), + createdAt: new Date("2023-10-20T16:12:56.499Z"), + modifiedAt: new Date("2023-04-20T19:22:55.409Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantads.md b/docs/models/components/benefitgrantads.md index f26cc2f6..02cbb65f 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("2023-12-13T14:22:49.263Z"), - modifiedAt: new Date("2023-08-31T15:41:35.683Z"), + createdAt: new Date("2022-05-04T14:46:57.065Z"), + modifiedAt: new Date("2024-12-21T12:53:01.858Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantlicensekeys.md b/docs/models/components/benefitgrantlicensekeys.md index 40485d19..35975006 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("2024-11-01T23:11:27.876Z"), - modifiedAt: new Date("2024-09-11T11:00:37.375Z"), + createdAt: new Date("2024-09-02T04:18:11.595Z"), + modifiedAt: new Date("2022-03-09T18:45:54.640Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantsubscriber.md b/docs/models/components/benefitgrantsubscriber.md index 0492e2a9..285c7daf 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("2024-06-24T20:44:45.993Z"), - modifiedAt: new Date("2023-12-10T11:55:43.052Z"), + createdAt: new Date("2022-08-13T10:34:08.199Z"), + modifiedAt: new Date("2022-02-28T19:32:56.713Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitgrantwebhook.md b/docs/models/components/benefitgrantwebhook.md index 43439132..815ef382 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-10-28T06:01:39.364Z"), - modifiedAt: new Date("2022-09-04T21:23:13.781Z"), + createdAt: new Date("2023-06-01T03:37:00.180Z"), + modifiedAt: new Date("2022-09-09T06:29:34.747Z"), id: "", isGranted: false, isRevoked: false, @@ -17,14 +17,25 @@ let value: BenefitGrantWebhook = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2024-05-01T09:46:08.628Z"), - modifiedAt: new Date("2023-06-29T11:49:18.398Z"), + createdAt: new Date("2022-05-28T13:13:34.231Z"), + modifiedAt: new Date("2022-08-25T10:24:20.426Z"), id: "", - description: "untried painfully knit", + description: "throughout below knowledgeably", selectable: false, deletable: false, organizationId: "", - properties: {}, + properties: { + prefix: "", + expires: { + ttl: 750956, + timeframe: "month", + }, + activations: { + limit: 662360, + enableUserAdmin: false, + }, + limitUsage: 889439, + }, }, }; ``` @@ -45,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.BenefitGrantWebhookBenefit* | :heavy_check_mark: | N/A | +| `benefit` | *components.BenefitInput* | :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/benefitgrantwebhookbenefit.md b/docs/models/components/benefitgrantwebhookbenefit.md deleted file mode 100644 index f0028437..00000000 --- a/docs/models/components/benefitgrantwebhookbenefit.md +++ /dev/null @@ -1,142 +0,0 @@ -# BenefitGrantWebhookBenefit - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2022-05-27T03:14:14.894Z"), - modifiedAt: new Date("2023-04-17T17:29:30.648Z"), - id: "", - description: "ew flickering shanghai outside oh", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2024-05-14T04:28:07.813Z"), - modifiedAt: new Date("2023-03-08T02:24:01.012Z"), - id: "", - description: "unabashedly cute as innocently oof", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2023-12-06T11:25:38.185Z"), - modifiedAt: new Date("2024-10-29T13:21:33.515Z"), - id: "", - description: "via big minister pinstripe apologise haze dredger dilate midst", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscordInput` - -```typescript -const value: components.BenefitDiscordInput = { - createdAt: new Date("2024-11-20T14:19:41.572Z"), - modifiedAt: new Date("2022-05-10T11:56:00.057Z"), - id: "", - description: "rationalize oh healthily pillory", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2022-10-16T19:09:53.500Z"), - modifiedAt: new Date("2022-12-17T07:57:57.986Z"), - id: "", - description: "filthy past beneath humiliating", - selectable: false, - deletable: false, - organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "maintain", - }, -}; -``` - -### `components.BenefitDownloadables` - -```typescript -const value: components.BenefitDownloadables = { - createdAt: new Date("2022-07-24T03:40:16.074Z"), - modifiedAt: new Date("2022-08-13T04:52:57.760Z"), - id: "", - description: - "dandelion aw boiling tomography regarding boohoo royal machine eyebrow", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2022-05-19T01:33:52.237Z"), - modifiedAt: new Date("2024-02-15T11:16:19.506Z"), - id: "", - description: "ah although pear general coop", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 551520, - timeframe: "month", - }, - activations: { - limit: 622061, - enableUserAdmin: false, - }, - limitUsage: 980988, - }, -}; -``` - diff --git a/docs/models/components/webhookbenefitcreatedpayloadbenefit.md b/docs/models/components/benefitinput.md similarity index 59% rename from docs/models/components/webhookbenefitcreatedpayloadbenefit.md rename to docs/models/components/benefitinput.md index 385d7cd9..4f23bf6c 100644 --- a/docs/models/components/webhookbenefitcreatedpayloadbenefit.md +++ b/docs/models/components/benefitinput.md @@ -1,4 +1,4 @@ -# WebhookBenefitCreatedPayloadBenefit +# BenefitInput ## Supported Types @@ -7,11 +7,11 @@ ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2023-01-07T00:35:03.166Z"), - modifiedAt: new Date("2022-12-04T16:25:25.756Z"), + createdAt: new Date("2022-04-25T11:53:31.235Z"), + modifiedAt: new Date("2022-05-03T03:10:03.746Z"), id: "", description: - "gosh negligible yearly headline arrogantly priesthood absentmindedly knickers", + "haircut vibration incidentally up round sophisticated violently unlike neatly whenever", selectable: false, deletable: false, organizationId: "", @@ -25,10 +25,10 @@ const value: components.BenefitArticles = { ```typescript const value: components.BenefitAds = { - createdAt: new Date("2024-10-10T04:53:42.729Z"), - modifiedAt: new Date("2024-06-20T07:13:38.065Z"), + createdAt: new Date("2022-01-15T07:37:06.468Z"), + modifiedAt: new Date("2023-10-02T15:02:13.074Z"), id: "", - description: "beside beside chap strange variable writ", + description: "meh gosh past mmm but well-off joyful", selectable: false, deletable: false, organizationId: "", @@ -40,10 +40,10 @@ const value: components.BenefitAds = { ```typescript const value: components.BenefitCustom = { - createdAt: new Date("2022-03-04T10:13:58.711Z"), - modifiedAt: new Date("2022-10-26T20:34:22.774Z"), + createdAt: new Date("2023-01-13T19:33:41.074Z"), + modifiedAt: new Date("2024-10-15T16:02:57.133Z"), id: "", - description: "duster reprimand from", + description: "quicker pish during distant across mmm unlike", selectable: false, deletable: false, organizationId: "", @@ -58,10 +58,10 @@ const value: components.BenefitCustom = { ```typescript const value: components.BenefitDiscordInput = { - createdAt: new Date("2024-12-12T17:30:45.317Z"), - modifiedAt: new Date("2022-07-20T20:31:05.179Z"), + createdAt: new Date("2023-05-01T15:53:14.590Z"), + modifiedAt: new Date("2023-09-05T20:04:49.651Z"), id: "", - description: "apud fully curse decisive firsthand pish quaintly", + description: "inasmuch fedora furthermore hence consequently carouse given", selectable: false, deletable: false, organizationId: "", @@ -76,10 +76,10 @@ const value: components.BenefitDiscordInput = { ```typescript const value: components.BenefitGitHubRepository = { - createdAt: new Date("2022-03-01T16:32:42.679Z"), - modifiedAt: new Date("2022-11-22T16:09:54.713Z"), + createdAt: new Date("2023-07-30T13:26:38.433Z"), + modifiedAt: new Date("2024-07-04T11:17:21.724Z"), id: "", - description: "drat wonderful knavishly forenenst", + description: "nauseate majestic switchboard ready even who versus", selectable: false, deletable: false, organizationId: "", @@ -87,7 +87,7 @@ const value: components.BenefitGitHubRepository = { repositoryId: "", repositoryOwner: "polarsource", repositoryName: "private_repo", - permission: "maintain", + permission: "push", }, }; ``` @@ -96,10 +96,10 @@ const value: components.BenefitGitHubRepository = { ```typescript const value: components.BenefitDownloadables = { - createdAt: new Date("2022-10-19T23:23:19.077Z"), - modifiedAt: new Date("2024-05-26T17:27:56.559Z"), + createdAt: new Date("2022-09-28T15:32:41.145Z"), + modifiedAt: new Date("2023-07-21T23:45:41.026Z"), id: "", - description: "towards moisten petty plus quirkily incidentally", + description: "daily but triumphantly team yum misspend status", selectable: false, deletable: false, organizationId: "", @@ -118,24 +118,25 @@ const value: components.BenefitDownloadables = { ```typescript const value: components.BenefitLicenseKeys = { - createdAt: new Date("2024-09-09T13:26:58.540Z"), - modifiedAt: new Date("2022-05-28T13:13:34.231Z"), + createdAt: new Date("2023-08-24T22:59:30.708Z"), + modifiedAt: new Date("2024-12-22T13:01:24.491Z"), id: "", - description: "to possession busily candid", + description: + "dim amount um stealthily if slipper swine unblinking solidly zowie", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 446075, + ttl: 805401, timeframe: "year", }, activations: { - limit: 168638, + limit: 318089, enableUserAdmin: false, }, - limitUsage: 770711, + limitUsage: 369844, }, }; ``` diff --git a/docs/models/components/benefitlicensekeyactivationproperties.md b/docs/models/components/benefitlicensekeyactivationproperties.md index 213708f7..32c4f072 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: 904398, + limit: 714933, enableUserAdmin: false, }; ``` diff --git a/docs/models/components/benefitlicensekeyexpirationproperties.md b/docs/models/components/benefitlicensekeyexpirationproperties.md index 80df0486..33f1089e 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: 308864, - timeframe: "month", + ttl: 632766, + timeframe: "day", }; ``` diff --git a/docs/models/components/benefitlicensekeys.md b/docs/models/components/benefitlicensekeys.md index 1f941e7c..39b0b283 100644 --- a/docs/models/components/benefitlicensekeys.md +++ b/docs/models/components/benefitlicensekeys.md @@ -6,24 +6,24 @@ import { BenefitLicenseKeys } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeys = { - createdAt: new Date("2024-06-28T22:00:04.593Z"), - modifiedAt: new Date("2024-12-26T11:07:58.955Z"), + createdAt: new Date("2023-04-18T20:26:13.694Z"), + modifiedAt: new Date("2022-01-28T05:14:01.831Z"), id: "", - description: "so ethical than lawmaker", + description: "quixotic what worth tomorrow", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 147974, - timeframe: "month", + ttl: 776593, + timeframe: "year", }, activations: { - limit: 465310, + limit: 246846, enableUserAdmin: false, }, - limitUsage: 624312, + limitUsage: 472655, }, }; ``` diff --git a/docs/models/components/benefitlicensekeyscreate.md b/docs/models/components/benefitlicensekeyscreate.md index 09ae50b2..d3f83c0f 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: "cop vivaciously yippee tame ouch nervously", + description: "editor ack including angrily venom forenenst lovable", properties: {}, }; ``` diff --git a/docs/models/components/benefitlicensekeysproperties.md b/docs/models/components/benefitlicensekeysproperties.md index 4c51349b..7f441f7d 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: 70720, - timeframe: "day", + ttl: 943603, + timeframe: "month", }, activations: { - limit: 378581, + limit: 832530, enableUserAdmin: false, }, - limitUsage: 206931, + limitUsage: 867104, }; ``` diff --git a/docs/models/components/benefitlicensekeyssubscriber.md b/docs/models/components/benefitlicensekeyssubscriber.md index a6e1e179..7b0bd009 100644 --- a/docs/models/components/benefitlicensekeyssubscriber.md +++ b/docs/models/components/benefitlicensekeyssubscriber.md @@ -6,30 +6,29 @@ import { BenefitLicenseKeysSubscriber } from "@polar-sh/sdk/models/components"; let value: BenefitLicenseKeysSubscriber = { - createdAt: new Date("2022-07-29T12:02:54.413Z"), - modifiedAt: new Date("2022-10-02T04:44:05.671Z"), + createdAt: new Date("2022-07-29T04:07:06.634Z"), + modifiedAt: new Date("2024-09-15T12:11:57.238Z"), id: "", - description: - "gee drat phew deliberately phooey across perfectly boo triumphantly", + description: "apud light flame yawningly limp as uncover sleepily glorious", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 553896, - timeframe: "day", + ttl: 345746, + timeframe: "month", }, activations: { - limit: 777784, + limit: 410916, enableUserAdmin: false, }, - limitUsage: 71087, + limitUsage: 103253, }, grants: [ { - createdAt: new Date("2023-01-11T06:39:44.285Z"), - modifiedAt: new Date("2023-06-10T00:10:54.046Z"), + createdAt: new Date("2023-07-23T22:22:42.601Z"), + modifiedAt: new Date("2022-04-17T02:18:42.766Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/benefitlicensekeyssubscriberproperties.md b/docs/models/components/benefitlicensekeyssubscriberproperties.md index 65fff55c..c47b0dc9 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: 423032, + ttl: 449694, timeframe: "year", }, activations: { - limit: 404542, + limit: 154869, enableUserAdmin: false, }, - limitUsage: 535903, + limitUsage: 783837, }; ``` diff --git a/docs/models/components/benefits.md b/docs/models/components/benefits.md index 1bed69fd..f00ce7a5 100644 --- a/docs/models/components/benefits.md +++ b/docs/models/components/benefits.md @@ -7,12 +7,11 @@ ```typescript const value: components.BenefitBase = { - createdAt: new Date("2023-07-05T00:18:10.806Z"), - modifiedAt: new Date("2023-07-06T07:18:59.972Z"), + createdAt: new Date("2024-11-25T14:43:22.496Z"), + modifiedAt: new Date("2024-10-21T06:40:33.930Z"), id: "", - type: "custom", - description: - "since blissfully drat incidentally cosset storyboard noted grounded phooey pish", + type: "license_keys", + description: "meh opposite shoot", selectable: false, deletable: false, organizationId: "", @@ -23,10 +22,10 @@ const value: components.BenefitBase = { ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2022-09-23T07:10:05.509Z"), - modifiedAt: new Date("2024-11-11T12:54:59.231Z"), + createdAt: new Date("2024-11-16T14:38:37.631Z"), + modifiedAt: new Date("2023-01-15T09:29:40.220Z"), id: "", - description: "pish reapply vivid honesty", + description: "although syringe but ew except", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/benefittype.md b/docs/models/components/benefittype.md index dad1a7bc..bde63b99 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 = "downloadables"; ``` ## Values diff --git a/docs/models/components/bylineprofile.md b/docs/models/components/bylineprofile.md index 6521a9ce..79cf250e 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://pink-simple.org", + avatarUrl: "https://bright-loaf.biz", }; ``` diff --git a/docs/models/components/checkoutpublic.md b/docs/models/components/checkoutpublic.md index eda1c6e4..bde436cc 100644 --- a/docs/models/components/checkoutpublic.md +++ b/docs/models/components/checkoutpublic.md @@ -8,59 +8,63 @@ Checkout session data retrieved using the client secret. import { CheckoutPublic } from "@polar-sh/sdk/models/components"; let value: CheckoutPublic = { - createdAt: new Date("2023-11-06T16:01:51.588Z"), - modifiedAt: new Date("2024-04-14T18:31:45.123Z"), + createdAt: new Date("2023-12-26T18:28:53.746Z"), + modifiedAt: new Date("2022-04-08T07:55:03.665Z"), id: "", - status: "failed", + status: "expired", clientSecret: "", - expiresAt: new Date("2022-07-14T00:14:45.565Z"), - successUrl: "https://powerful-shark.biz", - amount: 500101, - taxAmount: 208959, - currency: "Turkish Lira", - totalAmount: 204579, + expiresAt: new Date("2023-06-09T15:08:25.512Z"), + successUrl: "https://golden-seafood.net", + amount: 19463, + taxAmount: 190413, + currency: "Balboa", + totalAmount: 496042, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Hazel_Jenkins52@yahoo.com", + customerEmail: "Floy.Zemlak@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Italy", + country: "Malta", }, customerTaxId: "", paymentProcessorMetadata: {}, product: { - createdAt: new Date("2024-04-28T14:16:56.411Z"), - modifiedAt: new Date("2024-01-03T07:06:59.391Z"), + createdAt: new Date("2023-12-30T06:59:24.222Z"), + modifiedAt: new Date("2023-01-31T10:52:16.926Z"), id: "", name: "", - description: "after weary oval", + description: "during godfather phew per", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-10-07T11:35:19.244Z"), - modifiedAt: new Date("2022-03-29T21:43:02.894Z"), + createdAt: new Date("2023-07-01T04:04:20.139Z"), + modifiedAt: new Date("2024-03-23T22:47:32.575Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 137914, - recurringInterval: "year", + minimumAmount: 313064, + maximumAmount: 104097, + presetAmount: 825257, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2024-06-24T09:42:38.938Z"), - modifiedAt: new Date("2023-04-01T22:38:03.818Z"), + createdAt: new Date("2022-04-27T17:18:40.571Z"), + modifiedAt: new Date("2022-05-18T18:26:16.470Z"), id: "", - type: "discord", - description: "beneath geez abnormally cleaner", + description: "unless boldly cash suspiciously", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -68,29 +72,30 @@ let value: CheckoutPublic = { id: "", organizationId: "", name: "", - path: "/private/tmp", + path: "/etc", mimeType: "", - size: 477169, + size: 577549, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-03-16T09:33:11.695Z"), + lastModifiedAt: new Date("2023-08-09T10:13:51.600Z"), version: "", isUploaded: false, - createdAt: new Date("2024-01-12T21:22:57.299Z"), + createdAt: new Date("2023-04-18T14:04:46.675Z"), sizeReadable: "", - publicUrl: "https://pleased-order.net", + publicUrl: "https://intent-starboard.net/", }, ], }, productPrice: { - createdAt: new Date("2023-06-24T23:34:58.651Z"), - modifiedAt: new Date("2024-11-01T17:29:09.841Z"), + createdAt: new Date("2024-05-10T16:19:06.783Z"), + modifiedAt: new Date("2022-02-18T12:13:52.647Z"), id: "", isArchived: false, + recurringInterval: "year", }, - url: "https://shabby-tuba.com/", + url: "https://authorized-transom.info", }; ``` @@ -101,8 +106,8 @@ let value: CheckoutPublic = { | `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. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | Payment processor used. | -| `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | Status of the checkout session. | +| `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. | | `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. | diff --git a/docs/models/components/checkoutstatus.md b/docs/models/components/checkoutstatus.md index adc1226c..8aa4b322 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 = "expired"; ``` ## Values diff --git a/docs/models/components/currencyamount.md b/docs/models/components/currencyamount.md index c59464a3..c7dc3e2f 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: "Pataca", - amount: 796898, + currency: "Trinidad and Tobago Dollar", + amount: 627706, }; ``` diff --git a/docs/models/components/donation.md b/docs/models/components/donation.md index ada41dec..a2ff4654 100644 --- a/docs/models/components/donation.md +++ b/docs/models/components/donation.md @@ -6,46 +6,47 @@ import { Donation } from "@polar-sh/sdk/models/components"; let value: Donation = { - createdAt: new Date("2023-11-23T09:32:09.666Z"), - modifiedAt: new Date("2023-04-27T22:20:58.886Z"), + createdAt: new Date("2024-04-13T22:58:10.181Z"), + modifiedAt: new Date("2023-02-17T17:56:53.516Z"), id: "", - amount: 344722, - currency: "Tala", + amount: 172249, + currency: "Turkish Lira", message: "", donor: { id: "", - publicName: "", - avatarUrl: "https://awful-clavicle.name/", + name: "", + avatarUrl: "https://medium-anticodon.com/", + isPersonal: false, }, - email: "Jaeden_Stark36@hotmail.com", + email: "Jessy.Reilly30@gmail.com", issue: { - id: "f8e41e67-f69b-434b-ac34-06e6c09ff90d", - number: 24681, + id: "be78cdc4-1398-4816-80a3-b802eed95fe0", + number: 543049, title: "", state: "closed", - issueCreatedAt: new Date("2024-02-28T13:41:03.002Z"), + issueCreatedAt: new Date("2023-05-25T11:06:48.802Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "188e7888-dfe3-4d50-b817-bd5d095833dc", + id: "263c8628-9ab0-4652-8507-8721cb4afd42", isPrivate: false, name: "MyOrg", - description: "phew poetry tank bicycle left since", + description: "jaggedly kissingly forenenst marathon um uh-huh kissingly", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "83fe2e39-e934-4ab9-b42a-322bbe49e37f", + id: "82e629a6-0a32-4d87-8c79-6e9eec8a3edc", name: "", - avatarUrl: "https://key-unblinking.name", + avatarUrl: "https://upright-sideboard.org/", isPersonal: false, bio: "", prettyName: "", - company: "Larson - Marquardt", + company: "Gerhold and Sons", blog: "", location: "", - email: "Gust.Stroman13@yahoo.com", + email: "Eliezer.Tillman@yahoo.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/donationorganization.md b/docs/models/components/donationorganization.md index b4d87689..854997f3 100644 --- a/docs/models/components/donationorganization.md +++ b/docs/models/components/donationorganization.md @@ -8,7 +8,7 @@ import { DonationOrganization } from "@polar-sh/sdk/models/components"; let value: DonationOrganization = { id: "", name: "", - avatarUrl: "https://tinted-tapioca.com/", + avatarUrl: "https://outlandish-duster.name/", isPersonal: false, }; ``` diff --git a/docs/models/components/donationuser.md b/docs/models/components/donationuser.md index ddf74813..c39d8def 100644 --- a/docs/models/components/donationuser.md +++ b/docs/models/components/donationuser.md @@ -8,7 +8,7 @@ import { DonationUser } from "@polar-sh/sdk/models/components"; let value: DonationUser = { id: "", publicName: "", - avatarUrl: "https://immaculate-catalyst.org/", + avatarUrl: "https://outgoing-skean.name", }; ``` diff --git a/docs/models/components/donor.md b/docs/models/components/donor.md index 7936ed9b..c825833d 100644 --- a/docs/models/components/donor.md +++ b/docs/models/components/donor.md @@ -9,7 +9,7 @@ const value: components.DonationOrganization = { id: "", name: "", - avatarUrl: "https://upbeat-valuable.org", + avatarUrl: "https://great-amnesty.name", isPersonal: false, }; ``` @@ -20,7 +20,7 @@ const value: components.DonationOrganization = { const value: components.DonationUser = { id: "", publicName: "", - avatarUrl: "https://perfumed-vestment.info", + avatarUrl: "https://simplistic-commodity.org/", }; ``` diff --git a/docs/models/components/downloadablefilecreate.md b/docs/models/components/downloadablefilecreate.md index ab865453..9b54e296 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: 450561, + size: 437793, upload: { parts: [ { - number: 459536, - chunkStart: 386185, - chunkEnd: 29923, + number: 396806, + chunkStart: 627838, + chunkEnd: 737008, }, ], }, diff --git a/docs/models/components/downloadablefileread.md b/docs/models/components/downloadablefileread.md index 1cf9c736..bef62b71 100644 --- a/docs/models/components/downloadablefileread.md +++ b/docs/models/components/downloadablefileread.md @@ -11,17 +11,17 @@ let value: DownloadableFileRead = { id: "", organizationId: "", name: "", - path: "/etc/mail", + path: "/bin", mimeType: "", - size: 431813, + size: 935145, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-09-04T23:51:10.342Z"), + lastModifiedAt: new Date("2022-06-25T11:00:30.377Z"), version: "", isUploaded: false, - createdAt: new Date("2022-05-27T16:26:09.723Z"), + createdAt: new Date("2022-02-17T02:28:27.960Z"), sizeReadable: "", }; ``` diff --git a/docs/models/components/downloadableread.md b/docs/models/components/downloadableread.md index 91040536..ab6f7e44 100644 --- a/docs/models/components/downloadableread.md +++ b/docs/models/components/downloadableread.md @@ -12,17 +12,17 @@ let value: DownloadableRead = { id: "", organizationId: "", name: "", - path: "/etc/ppp", + path: "/usr/obj", mimeType: "", - size: 230648, + size: 941683, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-08-26T11:58:09.669Z"), + lastModifiedAt: new Date("2023-03-10T02:54:55.367Z"), download: { - url: "https://white-marketplace.info/", - expiresAt: new Date("2024-11-07T20:33:08.048Z"), + url: "https://great-fen.org", + expiresAt: new Date("2024-11-09T20:12:15.944Z"), }, version: "", isUploaded: false, diff --git a/docs/models/components/externalorganization.md b/docs/models/components/externalorganization.md index 4d2a6623..5fe5841c 100644 --- a/docs/models/components/externalorganization.md +++ b/docs/models/components/externalorganization.md @@ -6,16 +6,16 @@ import { ExternalOrganization } from "@polar-sh/sdk/models/components"; let value: ExternalOrganization = { - id: "d632f183-d3b2-4fa6-af86-2b9333704b9d", + id: "d60615fd-366c-4001-8a6d-47b85282f82b", name: "", - avatarUrl: "https://official-hundred.info/", + avatarUrl: "https://late-ceramics.com", isPersonal: false, bio: "", prettyName: "", - company: "O'Kon, Friesen and Lesch", + company: "Goodwin, Wilderman and Kuvalis", blog: "", location: "", - email: "Nathanial1@gmail.com", + email: "Aubrey.Reynolds-Leannon@yahoo.com", twitterUsername: "", organizationId: "", }; diff --git a/docs/models/components/externalorganizationsortproperty.md b/docs/models/components/externalorganizationsortproperty.md index 53d4d23e..27d7950b 100644 --- a/docs/models/components/externalorganizationsortproperty.md +++ b/docs/models/components/externalorganizationsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { ExternalOrganizationSortProperty } from "@polar-sh/sdk/models/components"; -let value: ExternalOrganizationSortProperty = "name"; +let value: ExternalOrganizationSortProperty = "-created_at"; ``` ## Values diff --git a/docs/models/components/filedownload.md b/docs/models/components/filedownload.md index 00e6f09d..5602efcd 100644 --- a/docs/models/components/filedownload.md +++ b/docs/models/components/filedownload.md @@ -9,17 +9,17 @@ let value: FileDownload = { id: "", organizationId: "", name: "", - path: "/lost+found", + path: "/usr/ports", mimeType: "", - size: 346394, + size: 342458, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-07-24T10:31:58.298Z"), + lastModifiedAt: new Date("2024-12-09T06:01:03.753Z"), download: { - url: "https://frugal-supplier.com", - expiresAt: new Date("2023-06-25T20:09:15.812Z"), + url: "https://unsung-millet.biz", + expiresAt: new Date("2022-08-05T11:41:51.964Z"), }, version: "", isUploaded: false, diff --git a/docs/models/components/fileread.md b/docs/models/components/fileread.md index 99b74dc8..fb3bc779 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: "/lib", mimeType: "", - size: 885050, + size: 448226, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-08-14T05:05:54.788Z"), + lastModifiedAt: new Date("2024-07-02T19:45:41.035Z"), version: "", isUploaded: false, - createdAt: new Date("2023-03-26T01:06:23.500Z"), + createdAt: new Date("2022-10-02T13:18:18.281Z"), sizeReadable: "", }; ``` @@ -32,19 +32,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/etc/mail", + path: "/var", mimeType: "", - size: 747187, + size: 64739, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-05-02T01:05:10.633Z"), + lastModifiedAt: new Date("2022-04-08T22:26:55.472Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-23T12:17:46.590Z"), + createdAt: new Date("2023-10-19T20:37:12.120Z"), sizeReadable: "", - publicUrl: "https://present-stall.com/", + publicUrl: "https://reckless-approach.biz", }; ``` @@ -55,19 +55,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/etc/mail", + path: "/usr/bin", mimeType: "", - size: 817785, + size: 344401, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-30T09:33:54.132Z"), + lastModifiedAt: new Date("2022-11-30T21:38:11.468Z"), version: "", isUploaded: false, - createdAt: new Date("2024-05-29T22:40:34.959Z"), + createdAt: new Date("2024-06-17T11:24:47.637Z"), sizeReadable: "", - publicUrl: "https://clean-fundraising.info/", + publicUrl: "https://silky-order.org", }; ``` diff --git a/docs/models/components/fileservicetypes.md b/docs/models/components/fileservicetypes.md index 3156acaa..a4f5674e 100644 --- a/docs/models/components/fileservicetypes.md +++ b/docs/models/components/fileservicetypes.md @@ -5,7 +5,7 @@ ```typescript import { FileServiceTypes } from "@polar-sh/sdk/models/components"; -let value: FileServiceTypes = "downloadable"; +let value: FileServiceTypes = "organization_avatar"; ``` ## Values diff --git a/docs/models/components/fileupload.md b/docs/models/components/fileupload.md index be23c1db..e2cb2b94 100644 --- a/docs/models/components/fileupload.md +++ b/docs/models/components/fileupload.md @@ -9,29 +9,29 @@ let value: FileUpload = { id: "", organizationId: "", name: "", - path: "/var/log", + path: "/etc/mail", mimeType: "", - size: 437621, + size: 61893, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-11-20T01:54:46.683Z"), + lastModifiedAt: new Date("2022-07-26T20:04:49.437Z"), upload: { id: "", - path: "/boot/defaults", + path: "/home/user/dir", parts: [ { - number: 475314, - chunkStart: 870008, - chunkEnd: 592279, - url: "https://brisk-kiss.org/", - expiresAt: new Date("2022-03-22T23:42:49.599Z"), + number: 179389, + chunkStart: 31712, + chunkEnd: 717659, + url: "https://last-case.info/", + expiresAt: new Date("2023-03-12T14:59:18.289Z"), }, ], }, version: "", - service: "product_media", + service: "organization_avatar", sizeReadable: "", }; ``` diff --git a/docs/models/components/fileuploadcompleted.md b/docs/models/components/fileuploadcompleted.md index b177f439..fc32e1ce 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: "/opt/sbin", + path: "/usr/libdata", parts: [ { - number: 107645, + number: 581098, checksumEtag: "", checksumSha256Base64: "", }, diff --git a/docs/models/components/interval.md b/docs/models/components/interval.md new file mode 100644 index 00000000..9cdaa4b2 --- /dev/null +++ b/docs/models/components/interval.md @@ -0,0 +1,15 @@ +# Interval + +## Example Usage + +```typescript +import { Interval } from "@polar-sh/sdk/models/components"; + +let value: Interval = "week"; +``` + +## Values + +```typescript +"year" | "month" | "week" | "day" | "hour" +``` \ No newline at end of file diff --git a/docs/models/components/introspecttokenresponse.md b/docs/models/components/introspecttokenresponse.md index 3de10f89..0d5e2b54 100644 --- a/docs/models/components/introspecttokenresponse.md +++ b/docs/models/components/introspecttokenresponse.md @@ -8,14 +8,14 @@ import { IntrospectTokenResponse } from "@polar-sh/sdk/models/components"; let value: IntrospectTokenResponse = { active: false, clientId: "", - tokenType: "access_token", + tokenType: "refresh_token", scope: "", - subType: "organization", + subType: "user", sub: "", aud: "", iss: "", - exp: 128926, - iat: 474637, + exp: 948639, + iat: 910767, }; ``` diff --git a/docs/models/components/issue.md b/docs/models/components/issue.md index 163c013b..e5906dc3 100644 --- a/docs/models/components/issue.md +++ b/docs/models/components/issue.md @@ -6,34 +6,33 @@ import { Issue } from "@polar-sh/sdk/models/components"; let value: Issue = { - id: "32d5136a-9e56-441f-b179-b486116000ce", - number: 8123, + id: "8bfe991c-4e3b-4172-ad9f-2db60b1cc3fc", + number: 734952, title: "", - state: "closed", - issueCreatedAt: new Date("2022-11-10T22:07:38.566Z"), + state: "open", + issueCreatedAt: new Date("2022-04-12T18:14:54.281Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "1118422d-0712-473a-86ca-f57a6304d90c", + id: "a6f12e73-51ae-49a4-abe0-3ec13550242d", isPrivate: false, name: "MyOrg", - description: - "incidentally acidly yuck unless longingly pish suddenly drat outfit splosh", + description: "careless queasily huzzah if", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "248980ce-42cb-4ce0-88c8-890e30a82f64", + id: "e0d80cd7-ce9e-46cc-bb67-34a5b95255a0", name: "", - avatarUrl: "https://dark-cheese.net", + avatarUrl: "https://awesome-director.com", isPersonal: false, bio: "", prettyName: "", - company: "Ratke - Bernhard", + company: "Marks Inc", blog: "", location: "", - email: "Brady54@yahoo.com", + email: "Angeline94@hotmail.com", twitterUsername: "", organizationId: "", }, @@ -47,7 +46,7 @@ let value: Issue = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `platform` | [components.Platforms](../../models/components/platforms.md) | :heavy_check_mark: | Issue platform (currently always GitHub) | +| `platform` | [components.Platforms](../../models/components/platforms.md) | :heavy_check_mark: | N/A | | `number` | *number* | :heavy_check_mark: | GitHub #number | | `title` | *string* | :heavy_check_mark: | GitHub issue title | | `body` | *string* | :heavy_minus_sign: | GitHub issue body | @@ -63,7 +62,7 @@ let value: Issue = { | `needsConfirmationSolved` | *boolean* | :heavy_check_mark: | If a maintainer needs to mark this issue as solved | | `confirmedSolvedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | If this issue has been marked as confirmed solved through Polar | | `funding` | [components.Funding](../../models/components/funding.md) | :heavy_check_mark: | N/A | -| `repository` | [components.RepositoryInput](../../models/components/repositoryinput.md) | :heavy_check_mark: | The repository that the issue is in | +| `repository` | [components.RepositoryInput](../../models/components/repositoryinput.md) | :heavy_check_mark: | N/A | | `upfrontSplitToContributors` | *number* | :heavy_minus_sign: | Share of rewrads that will be rewarded to contributors of this issue. A number between 0 and 100 (inclusive). | | `pledgeBadgeCurrentlyEmbedded` | *boolean* | :heavy_check_mark: | If this issue currently has the Polar badge SVG embedded | | `badgeCustomContent` | *string* | :heavy_minus_sign: | Optional custom badge SVG promotional content | \ No newline at end of file diff --git a/docs/models/components/label.md b/docs/models/components/label.md index f052789b..7581b98b 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: "black", + color: "indigo", }; ``` diff --git a/docs/models/components/licensekeyactivationbase.md b/docs/models/components/licensekeyactivationbase.md index dd1cacce..0fa46701 100644 --- a/docs/models/components/licensekeyactivationbase.md +++ b/docs/models/components/licensekeyactivationbase.md @@ -10,8 +10,8 @@ let value: LicenseKeyActivationBase = { licenseKeyId: "", label: "", meta: {}, - createdAt: new Date("2023-10-10T23:45:54.454Z"), - modifiedAt: new Date("2024-01-16T03:45:37.920Z"), + createdAt: new Date("2023-09-03T03:56:53.526Z"), + modifiedAt: new Date("2022-09-15T13:47:48.249Z"), }; ``` diff --git a/docs/models/components/licensekeyactivationread.md b/docs/models/components/licensekeyactivationread.md index 61f5bf53..ac349a1d 100644 --- a/docs/models/components/licensekeyactivationread.md +++ b/docs/models/components/licensekeyactivationread.md @@ -10,22 +10,28 @@ let value: LicenseKeyActivationRead = { licenseKeyId: "", label: "", meta: {}, - createdAt: new Date("2024-12-01T00:56:25.598Z"), - modifiedAt: new Date("2023-10-18T06:30:37.569Z"), + createdAt: new Date("2024-04-16T00:19:55.479Z"), + modifiedAt: new Date("2023-08-16T17:52:27.899Z"), licenseKey: { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Carmel22@hotmail.com", + avatarUrl: "https://expert-finding.name", + }, benefitId: "", key: "", displayKey: "", - status: "granted", - limitActivations: 529529, - usage: 640046, - limitUsage: 666273, - validations: 638042, - lastValidatedAt: new Date("2022-07-27T19:36:21.058Z"), - expiresAt: new Date("2022-08-17T07:24:06.006Z"), + status: "revoked", + limitActivations: 624011, + usage: 496430, + limitUsage: 773652, + validations: 845889, + lastValidatedAt: new Date("2024-08-04T18:06:39.289Z"), + expiresAt: new Date("2023-11-02T05:33:20.321Z"), }, }; ``` diff --git a/docs/models/components/licensekeyread.md b/docs/models/components/licensekeyread.md index 27700276..8930dee5 100644 --- a/docs/models/components/licensekeyread.md +++ b/docs/models/components/licensekeyread.md @@ -9,16 +9,22 @@ let value: LicenseKeyRead = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Robyn.Bergstrom@yahoo.com", + avatarUrl: "https://strange-arcade.com/", + }, benefitId: "", key: "", displayKey: "", - status: "revoked", - limitActivations: 51013, - usage: 408363, - limitUsage: 29848, - validations: 964191, - lastValidatedAt: new Date("2024-04-15T08:28:57.630Z"), - expiresAt: new Date("2023-01-07T20:44:43.574Z"), + status: "granted", + limitActivations: 47401, + usage: 995713, + limitUsage: 691129, + validations: 519586, + lastValidatedAt: new Date("2024-06-01T11:05:48.197Z"), + expiresAt: new Date("2023-12-28T02:03:10.092Z"), }; ``` @@ -29,6 +35,7 @@ let value: LicenseKeyRead = { | `id` | *string* | :heavy_check_mark: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | | `userId` | *string* | :heavy_check_mark: | N/A | +| `user` | [components.LicenseKeyUser](../../models/components/licensekeyuser.md) | :heavy_check_mark: | N/A | | `benefitId` | *string* | :heavy_check_mark: | The benefit ID. | | `key` | *string* | :heavy_check_mark: | N/A | | `displayKey` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/licensekeyuser.md b/docs/models/components/licensekeyuser.md new file mode 100644 index 00000000..b4e7be39 --- /dev/null +++ b/docs/models/components/licensekeyuser.md @@ -0,0 +1,23 @@ +# LicenseKeyUser + +## Example Usage + +```typescript +import { LicenseKeyUser } from "@polar-sh/sdk/models/components"; + +let value: LicenseKeyUser = { + id: "", + publicName: "", + email: "Sandy5@gmail.com", + avatarUrl: "https://regular-duster.info", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *string* | :heavy_check_mark: | N/A | +| `publicName` | *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/licensekeywithactivations.md b/docs/models/components/licensekeywithactivations.md index ae75d200..c4d107eb 100644 --- a/docs/models/components/licensekeywithactivations.md +++ b/docs/models/components/licensekeywithactivations.md @@ -9,24 +9,30 @@ let value: LicenseKeyWithActivations = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Hector_Welch@gmail.com", + avatarUrl: "https://lively-clavicle.name/", + }, benefitId: "", key: "", displayKey: "", - status: "revoked", - limitActivations: 316164, - usage: 370794, - limitUsage: 918715, - validations: 404525, - lastValidatedAt: new Date("2024-03-23T13:46:19.980Z"), - expiresAt: new Date("2022-06-21T20:48:34.925Z"), + status: "disabled", + limitActivations: 946496, + usage: 296853, + limitUsage: 396905, + validations: 182952, + lastValidatedAt: new Date("2024-08-20T05:20:49.819Z"), + expiresAt: new Date("2024-06-22T04:31:38.323Z"), activations: [ { id: "", licenseKeyId: "", label: "", meta: {}, - createdAt: new Date("2023-08-08T21:56:49.330Z"), - modifiedAt: new Date("2023-06-26T03:10:41.430Z"), + createdAt: new Date("2024-04-29T08:32:42.250Z"), + modifiedAt: new Date("2022-03-04T18:57:25.826Z"), }, ], }; @@ -39,6 +45,7 @@ let value: LicenseKeyWithActivations = { | `id` | *string* | :heavy_check_mark: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | | `userId` | *string* | :heavy_check_mark: | N/A | +| `user` | [components.LicenseKeyUser](../../models/components/licensekeyuser.md) | :heavy_check_mark: | N/A | | `benefitId` | *string* | :heavy_check_mark: | The benefit ID. | | `key` | *string* | :heavy_check_mark: | N/A | | `displayKey` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/listresourcearticle.md b/docs/models/components/listresourcearticle.md index 123a87e1..41ed8498 100644 --- a/docs/models/components/listresourcearticle.md +++ b/docs/models/components/listresourcearticle.md @@ -14,46 +14,46 @@ let value: ListResourceArticle = { body: "", byline: { name: "", - avatarUrl: "https://insidious-impostor.com/", + avatarUrl: "https://possible-trick.info/", }, - visibility: "hidden", + visibility: "private", userId: "", organizationId: "", organization: { - createdAt: new Date("2023-05-10T06:11:55.200Z"), - modifiedAt: new Date("2022-01-19T09:36:37.534Z"), + createdAt: new Date("2023-10-18T06:30:37.569Z"), + modifiedAt: new Date("2022-08-20T12:38:00.388Z"), id: "", name: "", slug: "", - avatarUrl: "https://discrete-comestible.net", + avatarUrl: "https://profitable-piglet.name", bio: "", - company: "Moore Group", + company: "Durgan - Flatley", blog: "", location: "", - email: "Albin30@yahoo.com", + email: "Jessyca_Schmidt@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 420757, + pledgeMinimumAmount: 536263, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 862130, + defaultUpfrontSplitToContributors: 149578, donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2023-12-28T09:57:19.018Z"), + publishedAt: new Date("2024-05-11T22:39:45.015Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2022-01-08T18:33:32.882Z"), + paidSubscribersOnlyEndsAt: new Date("2024-09-27T09:13:08.294Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2022-05-03T07:31:56.359Z"), - emailSentToCount: 31345, - ogImageUrl: "https://electric-schnitzel.net/", + notificationsSentAt: new Date("2024-06-09T08:26:59.670Z"), + emailSentToCount: 821896, + ogImageUrl: "https://defensive-yeast.name", ogDescription: "", }, ], pagination: { - totalCount: 244713, - maxPage: 390423, + totalCount: 420927, + maxPage: 888024, }, }; ``` diff --git a/docs/models/components/listresourcebenefit.md b/docs/models/components/listresourcebenefit.md index 6da67770..db5846b3 100644 --- a/docs/models/components/listresourcebenefit.md +++ b/docs/models/components/listresourcebenefit.md @@ -8,23 +8,20 @@ import { ListResourceBenefit } from "@polar-sh/sdk/models/components"; let value: ListResourceBenefit = { items: [ { - createdAt: new Date("2023-06-22T00:09:40.274Z"), - modifiedAt: new Date("2022-07-19T21:06:20.014Z"), + createdAt: new Date("2022-11-02T05:56:05.835Z"), + modifiedAt: new Date("2022-11-12T16:15:27.788Z"), id: "", description: - "huzzah factorise meh elegantly excepting pfft yawningly simple", + "idealistic equally service amidst vainly meh our courteous mid", selectable: false, deletable: false, organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, + properties: {}, }, ], pagination: { - totalCount: 519464, - maxPage: 539450, + totalCount: 854650, + maxPage: 418232, }, }; ``` diff --git a/docs/models/components/listresourcebenefitgrant.md b/docs/models/components/listresourcebenefitgrant.md index 6f75ae94..476e8c12 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("2023-07-01T03:02:39.682Z"), - modifiedAt: new Date("2024-03-06T13:27:13.872Z"), + createdAt: new Date("2022-08-14T23:12:59.369Z"), + modifiedAt: new Date("2024-10-03T19:13:09.978Z"), id: "", isGranted: false, isRevoked: false, @@ -21,8 +21,8 @@ let value: ListResourceBenefitGrant = { }, ], pagination: { - totalCount: 676702, - maxPage: 324393, + totalCount: 337073, + maxPage: 690050, }, }; ``` diff --git a/docs/models/components/listresourcecheckout.md b/docs/models/components/listresourcecheckout.md index 56728598..5cd77e04 100644 --- a/docs/models/components/listresourcecheckout.md +++ b/docs/models/components/listresourcecheckout.md @@ -8,38 +8,38 @@ import { ListResourceCheckout } from "@polar-sh/sdk/models/components"; let value: ListResourceCheckout = { items: [ { - createdAt: new Date("2022-12-12T10:04:21.339Z"), - modifiedAt: new Date("2024-06-03T18:38:58.201Z"), + createdAt: new Date("2023-02-16T01:56:17.223Z"), + modifiedAt: new Date("2024-09-26T12:45:07.280Z"), id: "", - status: "expired", + status: "open", clientSecret: "", - expiresAt: new Date("2022-06-30T14:38:50.223Z"), - successUrl: "https://worthy-haversack.info/", - amount: 757018, - taxAmount: 62739, - currency: "Swiss Franc", - totalAmount: 719880, + expiresAt: new Date("2022-09-08T21:23:39.240Z"), + successUrl: "https://strange-cork.net/", + amount: 561597, + taxAmount: 830216, + currency: "Zimbabwe Dollar", + totalAmount: 154236, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Maybelle_McLaughlin14@gmail.com", + customerEmail: "Lou.Schumm@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Uganda", + country: "Gibraltar", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { "key": "", }, - url: "https://authorized-chops.net", + url: "https://downright-publicity.net/", }, ], pagination: { - totalCount: 476764, - maxPage: 597663, + totalCount: 608103, + maxPage: 236034, }, }; ``` diff --git a/docs/models/components/listresourcedownloadableread.md b/docs/models/components/listresourcedownloadableread.md index d927efc4..1126eb5c 100644 --- a/docs/models/components/listresourcedownloadableread.md +++ b/docs/models/components/listresourcedownloadableread.md @@ -14,17 +14,17 @@ let value: ListResourceDownloadableRead = { id: "", organizationId: "", name: "", - path: "/boot/defaults", + path: "/opt/include", mimeType: "", - size: 984550, + size: 19610, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-12-22T17:04:10.022Z"), + lastModifiedAt: new Date("2024-06-13T17:09:10.644Z"), download: { - url: "https://quiet-sanity.biz", - expiresAt: new Date("2022-10-10T00:40:07.960Z"), + url: "https://reflecting-dusk.com/", + expiresAt: new Date("2024-10-16T14:29:18.954Z"), }, version: "", isUploaded: false, @@ -34,8 +34,8 @@ let value: ListResourceDownloadableRead = { }, ], pagination: { - totalCount: 563154, - maxPage: 505663, + totalCount: 890631, + maxPage: 306599, }, }; ``` diff --git a/docs/models/components/listresourceexternalorganization.md b/docs/models/components/listresourceexternalorganization.md index 58a39a2c..50f140a0 100644 --- a/docs/models/components/listresourceexternalorganization.md +++ b/docs/models/components/listresourceexternalorganization.md @@ -8,23 +8,23 @@ import { ListResourceExternalOrganization } from "@polar-sh/sdk/models/component let value: ListResourceExternalOrganization = { items: [ { - id: "3b7ac976-82ce-4cdd-a2fa-6e9fc5bb5e25", + id: "970417d9-a342-4d48-a215-5595c15a9174", name: "", - avatarUrl: "https://remorseful-yogurt.com/", + avatarUrl: "https://recent-information.biz/", isPersonal: false, bio: "", prettyName: "", - company: "Schumm, Grady and Funk", + company: "Dibbert, Cremin and Armstrong", blog: "", location: "", - email: "Glennie81@yahoo.com", + email: "Jeramie.Buckridge@hotmail.com", twitterUsername: "", organizationId: "", }, ], pagination: { - totalCount: 666762, - maxPage: 288130, + totalCount: 700872, + maxPage: 499270, }, }; ``` diff --git a/docs/models/components/listresourcefileread.md b/docs/models/components/listresourcefileread.md index 58d9faf9..f746d655 100644 --- a/docs/models/components/listresourcefileread.md +++ b/docs/models/components/listresourcefileread.md @@ -11,24 +11,23 @@ let value: ListResourceFileRead = { id: "", organizationId: "", name: "", - path: "/proc", + path: "/etc/periodic", mimeType: "", - size: 917965, + size: 459888, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-11T11:14:54.422Z"), + lastModifiedAt: new Date("2022-11-04T15:15:56.312Z"), version: "", isUploaded: false, - createdAt: new Date("2022-03-15T09:25:01.845Z"), + createdAt: new Date("2022-11-18T12:31:27.009Z"), sizeReadable: "", - publicUrl: "https://inconsequential-marathon.name/", }, ], pagination: { - totalCount: 58904, - maxPage: 617530, + totalCount: 980297, + maxPage: 44220, }, }; ``` diff --git a/docs/models/components/listresourcelicensekeyread.md b/docs/models/components/listresourcelicensekeyread.md index 6b9de84c..1cc237ed 100644 --- a/docs/models/components/listresourcelicensekeyread.md +++ b/docs/models/components/listresourcelicensekeyread.md @@ -11,21 +11,27 @@ let value: ListResourceLicenseKeyRead = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Doug_Dooley@yahoo.com", + avatarUrl: "https://present-dress.org/", + }, benefitId: "", key: "", displayKey: "", - status: "granted", - limitActivations: 14273, - usage: 877613, - limitUsage: 78111, - validations: 292824, - lastValidatedAt: new Date("2023-12-29T19:02:58.240Z"), - expiresAt: new Date("2024-07-14T13:50:40.327Z"), + status: "revoked", + limitActivations: 607407, + usage: 215813, + limitUsage: 861477, + validations: 804333, + lastValidatedAt: new Date("2022-09-27T05:11:28.515Z"), + expiresAt: new Date("2024-09-25T12:13:11.837Z"), }, ], pagination: { - totalCount: 321263, - maxPage: 652069, + totalCount: 40155, + maxPage: 752573, }, }; ``` diff --git a/docs/models/components/listresourceoauth2client.md b/docs/models/components/listresourceoauth2client.md index c6b93fd7..94a431f8 100644 --- a/docs/models/components/listresourceoauth2client.md +++ b/docs/models/components/listresourceoauth2client.md @@ -9,20 +9,20 @@ let value: ListResourceOAuth2Client = { items: [ { redirectUris: [ - "https://noxious-intent.name", + "https://urban-mobility.info/", ], clientName: "", - createdAt: new Date("2022-09-12T10:14:23.290Z"), - modifiedAt: new Date("2023-07-26T10:28:21.576Z"), + createdAt: new Date("2024-05-27T05:53:52.720Z"), + modifiedAt: new Date("2024-10-10T06:09:21.767Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 350037, - clientSecretExpiresAt: 108918, + clientIdIssuedAt: 673493, + clientSecretExpiresAt: 230903, }, ], pagination: { - totalCount: 791499, - maxPage: 360795, + totalCount: 819261, + maxPage: 420526, }, }; ``` diff --git a/docs/models/components/listresourceorder.md b/docs/models/components/listresourceorder.md index 6c7bb4e0..aa6683b5 100644 --- a/docs/models/components/listresourceorder.md +++ b/docs/models/components/listresourceorder.md @@ -8,15 +8,16 @@ import { ListResourceOrder } from "@polar-sh/sdk/models/components"; let value: ListResourceOrder = { items: [ { - createdAt: new Date("2024-04-09T15:43:12.475Z"), - modifiedAt: new Date("2022-11-29T16:28:43.939Z"), + createdAt: new Date("2022-06-03T21:44:38.598Z"), + modifiedAt: new Date("2022-07-08T03:01:51.436Z"), id: "", metadata: { "key": "", }, - amount: 733471, - taxAmount: 366561, - currency: "Yen", + amount: 918413, + taxAmount: 354705, + currency: "Czech Koruna", + billingReason: "subscription_update", userId: "", productId: "", productPriceId: "", @@ -24,46 +25,48 @@ let value: ListResourceOrder = { checkoutId: "", user: { id: "", - email: "Benny.Nienow13@gmail.com", + email: "Lowell.Pfeffer@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://elementary-pomelo.com/", + avatarUrl: "https://frugal-backbone.info", }, product: { - createdAt: new Date("2024-01-24T09:32:26.939Z"), - modifiedAt: new Date("2023-03-21T08:23:26.056Z"), + createdAt: new Date("2022-09-22T09:56:57.217Z"), + modifiedAt: new Date("2022-03-03T10:36:02.199Z"), id: "", name: "", - description: "hence or tighten memorable", + description: "underneath the plus roughly hmph when", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2023-04-11T22:26:51.446Z"), - modifiedAt: new Date("2023-12-25T07:57:58.923Z"), + createdAt: new Date("2023-06-07T21:29:28.096Z"), + modifiedAt: new Date("2022-06-16T23:39:25.441Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 863273, + minimumAmount: 414720, + maximumAmount: 910478, + presetAmount: 468634, recurringInterval: "month", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2024-10-29T06:16:02.069Z"), - modifiedAt: new Date("2024-08-27T16:44:25.827Z"), + createdAt: new Date("2023-08-07T10:32:29.203Z"), + modifiedAt: new Date("2022-03-08T16:23:57.837Z"), id: "", - amount: 873618, - currency: "New Zealand Dollar", - recurringInterval: "month", - status: "canceled", - currentPeriodStart: new Date("2022-08-14T23:12:22.090Z"), - currentPeriodEnd: new Date("2022-11-17T08:26:15.219Z"), + amount: 294268, + currency: "Somali Shilling", + recurringInterval: "year", + status: "incomplete", + currentPeriodStart: new Date("2023-09-17T14:01:05.772Z"), + currentPeriodEnd: new Date("2022-08-27T04:54:48.513Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-07-09T06:31:28.422Z"), - endedAt: new Date("2024-12-29T18:54:48.908Z"), + startedAt: new Date("2024-12-05T10:07:23.360Z"), + endedAt: new Date("2024-05-08T22:06:09.845Z"), userId: "", productId: "", priceId: "", @@ -72,8 +75,8 @@ let value: ListResourceOrder = { }, ], pagination: { - totalCount: 192181, - maxPage: 700751, + totalCount: 127908, + maxPage: 385546, }, }; ``` diff --git a/docs/models/components/listresourceorganization.md b/docs/models/components/listresourceorganization.md index 198c46f5..64fcfe73 100644 --- a/docs/models/components/listresourceorganization.md +++ b/docs/models/components/listresourceorganization.md @@ -8,29 +8,29 @@ import { ListResourceOrganization } from "@polar-sh/sdk/models/components"; let value: ListResourceOrganization = { items: [ { - createdAt: new Date("2024-01-15T09:12:43.486Z"), - modifiedAt: new Date("2024-07-14T14:53:59.208Z"), + createdAt: new Date("2024-06-04T12:08:37.668Z"), + modifiedAt: new Date("2024-03-04T13:10:43.781Z"), id: "", name: "", slug: "", - avatarUrl: "https://mixed-cake.com", + avatarUrl: "https://prime-self-confidence.org", bio: "", - company: "Abernathy, Kuhic and Roob", + company: "Harber, Witting and Beer", blog: "", location: "", - email: "Jaeden92@gmail.com", + email: "Jerome55@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 8636, + pledgeMinimumAmount: 140972, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 628926, + defaultUpfrontSplitToContributors: 325352, donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, ], pagination: { - totalCount: 232112, - maxPage: 267184, + totalCount: 631123, + maxPage: 359301, }, }; ``` diff --git a/docs/models/components/listresourceproduct.md b/docs/models/components/listresourceproduct.md index 20e1e95a..058cd169 100644 --- a/docs/models/components/listresourceproduct.md +++ b/docs/models/components/listresourceproduct.md @@ -8,38 +8,36 @@ import { ListResourceProduct } from "@polar-sh/sdk/models/components"; let value: ListResourceProduct = { items: [ { - createdAt: new Date("2023-07-27T07:33:30.803Z"), - modifiedAt: new Date("2022-08-24T21:54:03.774Z"), + createdAt: new Date("2024-02-03T09:20:15.518Z"), + modifiedAt: new Date("2023-06-15T03:09:20.689Z"), id: "", name: "", - description: - "times decryption redound eminent until license youthfully neglect wherever", + description: "boldly stabilise midwife whereas incidentally", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-07-17T20:00:09.846Z"), - modifiedAt: new Date("2024-05-07T05:20:25.129Z"), + createdAt: new Date("2024-10-16T20:09:04.547Z"), + modifiedAt: new Date("2024-06-28T09:31:01.146Z"), id: "", isArchived: false, - priceCurrency: "", - minimumAmount: 887079, - maximumAmount: 2011, - presetAmount: 973627, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2023-03-14T10:38:44.143Z"), - modifiedAt: new Date("2023-02-07T23:32:20.056Z"), + createdAt: new Date("2023-01-03T09:19:38.124Z"), + modifiedAt: new Date("2023-05-19T06:42:57.063Z"), id: "", - type: "downloadables", description: - "quaver solder savour sleepily kookily delight hmph despite", + "beside smoggy yuck nearly failing ew up decongestant valentine deployment", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -47,26 +45,26 @@ let value: ListResourceProduct = { id: "", organizationId: "", name: "", - path: "/private/var", + path: "/usr/libexec", mimeType: "", - size: 895114, + size: 902216, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-16T04:46:35.940Z"), + lastModifiedAt: new Date("2022-09-13T21:23:26.372Z"), version: "", isUploaded: false, - createdAt: new Date("2024-01-05T12:05:28.621Z"), + createdAt: new Date("2024-04-27T14:10:19.519Z"), sizeReadable: "", - publicUrl: "https://scaly-obedience.info/", + publicUrl: "https://assured-granny.com/", }, ], }, ], pagination: { - totalCount: 549022, - maxPage: 598149, + totalCount: 166138, + maxPage: 627397, }, }; ``` diff --git a/docs/models/components/listresourcerepository.md b/docs/models/components/listresourcerepository.md index 91db7098..5961e3b8 100644 --- a/docs/models/components/listresourcerepository.md +++ b/docs/models/components/listresourcerepository.md @@ -8,33 +8,34 @@ import { ListResourceRepository } from "@polar-sh/sdk/models/components"; let value: ListResourceRepository = { items: [ { - id: "746e1038-01b7-4fe4-86e9-5cea3d6b7f12", + id: "81080060-6336-4156-bde4-49250618af33", isPrivate: false, name: "MyOrg", - description: "hearten sans modulo unhealthy", + description: + "metabolise failing after finally even pish reapply vivid honesty", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "a8123910-5bbc-4b97-839a-1918211e9418", + id: "01893770-29fa-41d6-b193-65a6138c0919", name: "", - avatarUrl: "https://male-quit.info", + avatarUrl: "https://major-sand.biz/", isPersonal: false, bio: "", prettyName: "", - company: "Paucek, MacGyver and Stamm", + company: "Ullrich - Powlowski", blog: "", location: "", - email: "Kody_Waters@yahoo.com", + email: "Rosalind_Kuhn@hotmail.com", twitterUsername: "", organizationId: "", }, }, ], pagination: { - totalCount: 145242, - maxPage: 265125, + totalCount: 95168, + maxPage: 135597, }, }; ``` diff --git a/docs/models/components/listresourcesubscription.md b/docs/models/components/listresourcesubscription.md index 0ce48681..07adf05a 100644 --- a/docs/models/components/listresourcesubscription.md +++ b/docs/models/components/listresourcesubscription.md @@ -8,18 +8,18 @@ import { ListResourceSubscription } from "@polar-sh/sdk/models/components"; let value: ListResourceSubscription = { items: [ { - createdAt: new Date("2022-01-16T11:35:43.531Z"), - modifiedAt: new Date("2023-08-07T19:59:13.240Z"), + createdAt: new Date("2022-05-28T20:04:45.914Z"), + modifiedAt: new Date("2023-08-03T21:22:08.721Z"), id: "", - amount: 885336, - currency: "Jordanian Dinar", - recurringInterval: "month", - status: "active", - currentPeriodStart: new Date("2024-07-26T04:36:15.801Z"), - currentPeriodEnd: new Date("2023-10-31T13:28:06.854Z"), + amount: 132268, + currency: "Netherlands Antillian Guilder", + recurringInterval: "year", + status: "unpaid", + currentPeriodStart: new Date("2023-10-15T13:29:16.655Z"), + currentPeriodEnd: new Date("2022-03-21T09:16:05.859Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-03-30T02:19:05.351Z"), - endedAt: new Date("2024-02-27T02:13:18.268Z"), + startedAt: new Date("2022-03-09T15:41:33.926Z"), + endedAt: new Date("2022-12-11T17:51:13.874Z"), userId: "", productId: "", priceId: "", @@ -28,37 +28,36 @@ let value: ListResourceSubscription = { "key": "", }, user: { - email: "Weston.McClure@gmail.com", + email: "Abel_Koss@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://infinite-minority.org", + avatarUrl: "https://gifted-event.com", }, product: { - createdAt: new Date("2023-05-21T01:41:48.690Z"), - modifiedAt: new Date("2022-07-16T18:23:38.506Z"), + createdAt: new Date("2023-08-21T18:12:26.248Z"), + modifiedAt: new Date("2022-03-31T12:16:51.444Z"), id: "", name: "", - description: "confute uh-huh foolhardy pro fax boo", + description: "oxidize except understanding ascribe upwardly qua", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-12-26T02:48:40.217Z"), - modifiedAt: new Date("2023-04-06T18:20:13.817Z"), + createdAt: new Date("2023-12-14T06:58:44.385Z"), + modifiedAt: new Date("2023-04-09T07:17:04.384Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 648676, - recurringInterval: "year", + priceAmount: 42739, }, ], benefits: [ { - createdAt: new Date("2023-11-08T19:38:58.776Z"), - modifiedAt: new Date("2024-09-20T11:43:37.795Z"), + createdAt: new Date("2023-02-03T14:49:56.249Z"), + modifiedAt: new Date("2022-01-16T01:02:59.626Z"), id: "", - description: "sunbathe whose synthesise seriously", + description: "relieve minus ashamed apricot adjudge fibre", selectable: false, deletable: false, organizationId: "", @@ -72,34 +71,36 @@ let value: ListResourceSubscription = { id: "", organizationId: "", name: "", - path: "/var/mail", + path: "/bin", mimeType: "", - size: 906587, + size: 636019, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-06-03T18:10:10.891Z"), + lastModifiedAt: new Date("2022-02-05T11:00:40.920Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-13T11:33:11.689Z"), + createdAt: new Date("2022-05-01T20:48:13.554Z"), sizeReadable: "", - publicUrl: "https://incomparable-injunction.net", + publicUrl: "https://corrupt-riser.com/", }, ], }, price: { - createdAt: new Date("2023-12-23T01:19:11.714Z"), - modifiedAt: new Date("2022-03-06T01:45:57.066Z"), + createdAt: new Date("2023-05-05T22:17:51.096Z"), + modifiedAt: new Date("2022-06-03T12:45:41.057Z"), id: "", isArchived: false, - recurringInterval: "year", + priceCurrency: "", + priceAmount: 746936, + recurringInterval: "month", }, }, ], pagination: { - totalCount: 25744, - maxPage: 387768, + totalCount: 879644, + maxPage: 38115, }, }; ``` diff --git a/docs/models/components/listresourceuseradvertisementcampaign.md b/docs/models/components/listresourceuseradvertisementcampaign.md index 90488169..c3b0b263 100644 --- a/docs/models/components/listresourceuseradvertisementcampaign.md +++ b/docs/models/components/listresourceuseradvertisementcampaign.md @@ -8,21 +8,21 @@ import { ListResourceUserAdvertisementCampaign } from "@polar-sh/sdk/models/comp let value: ListResourceUserAdvertisementCampaign = { items: [ { - createdAt: new Date("2022-01-31T08:54:12.797Z"), - modifiedAt: new Date("2022-11-30T13:55:43.213Z"), + createdAt: new Date("2023-04-08T07:54:40.301Z"), + modifiedAt: new Date("2024-05-30T02:30:37.371Z"), id: "", userId: "", - views: 520811, - clicks: 650319, - imageUrl: "https://downright-metal.net/", - imageUrlDark: "https://timely-dividend.name", + views: 577297, + clicks: 42783, + imageUrl: "https://striking-polarisation.name/", + imageUrlDark: "https://pessimistic-pants.name", text: "", - linkUrl: "https://gloomy-pocket-watch.com/", + linkUrl: "https://small-futon.info", }, ], pagination: { - totalCount: 805149, - maxPage: 36619, + totalCount: 401449, + maxPage: 209210, }, }; ``` diff --git a/docs/models/components/listresourceuserbenefit.md b/docs/models/components/listresourceuserbenefit.md index 713bb321..bcce9897 100644 --- a/docs/models/components/listresourceuserbenefit.md +++ b/docs/models/components/listresourceuserbenefit.md @@ -8,21 +8,45 @@ import { ListResourceUserBenefit } from "@polar-sh/sdk/models/components"; let value: ListResourceUserBenefit = { items: [ { - createdAt: new Date("2023-10-18T08:30:01.769Z"), - modifiedAt: new Date("2024-07-07T18:17:14.780Z"), + createdAt: new Date("2023-03-25T06:54:06.627Z"), + modifiedAt: new Date("2022-12-31T03:28:31.793Z"), id: "", - description: "lend ew after scoff swiftly ew lender ew geez oxidise", + description: + "delight provided stay appertain so quintessential until enroll upsell pish", selectable: false, deletable: false, organizationId: "", properties: { - paidArticles: false, + prefix: "", + expires: { + ttl: 28256, + timeframe: "year", + }, + activations: { + limit: 102071, + enableUserAdmin: false, + }, + limitUsage: 756936, }, + grants: [ + { + createdAt: new Date("2023-01-08T06:10:49.913Z"), + modifiedAt: new Date("2023-12-01T05:07:28.563Z"), + id: "", + isGranted: false, + isRevoked: false, + subscriptionId: "", + orderId: "", + userId: "", + benefitId: "", + properties: {}, + }, + ], }, ], pagination: { - totalCount: 551410, - maxPage: 813544, + totalCount: 603783, + maxPage: 385828, }, }; ``` diff --git a/docs/models/components/listresourceuserorder.md b/docs/models/components/listresourceuserorder.md index 94acb8a4..bfe3ba93 100644 --- a/docs/models/components/listresourceuserorder.md +++ b/docs/models/components/listresourceuserorder.md @@ -8,42 +8,41 @@ import { ListResourceUserOrder } from "@polar-sh/sdk/models/components"; let value: ListResourceUserOrder = { items: [ { - createdAt: new Date("2024-05-04T05:05:58.982Z"), - modifiedAt: new Date("2024-05-03T14:22:38.068Z"), + createdAt: new Date("2024-08-02T22:25:17.358Z"), + modifiedAt: new Date("2023-07-11T19:35:53.842Z"), id: "", - amount: 975804, - taxAmount: 382718, - currency: "Iraqi Dinar", + amount: 461094, + taxAmount: 965117, + currency: "South Sudanese pound", userId: "", productId: "", productPriceId: "", subscriptionId: "", product: { - createdAt: new Date("2022-01-02T23:51:35.966Z"), - modifiedAt: new Date("2024-06-28T14:08:46.947Z"), + createdAt: new Date("2023-09-05T08:51:35.936Z"), + modifiedAt: new Date("2022-12-29T08:33:05.197Z"), id: "", name: "", description: - "broadly dishearten until duh small helpfully chasuble defiantly", + "numeric positively rosemary shaft barring happily obesity lamp ill-fated", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-12-05T02:02:21.383Z"), - modifiedAt: new Date("2022-01-06T16:56:17.091Z"), + createdAt: new Date("2024-01-09T02:39:07.024Z"), + modifiedAt: new Date("2024-11-10T10:02:57.999Z"), id: "", isArchived: false, - recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2024-01-15T23:14:29.526Z"), - modifiedAt: new Date("2022-02-05T19:26:06.390Z"), + createdAt: new Date("2022-11-16T07:58:25.136Z"), + modifiedAt: new Date("2024-10-03T03:11:16.049Z"), id: "", - type: "ads", - description: "supposing great wrongly", + type: "downloadables", + description: "when co-producer over dearly", selectable: false, deletable: false, organizationId: "", @@ -54,46 +53,42 @@ let value: ListResourceUserOrder = { id: "", organizationId: "", name: "", - path: "/usr/ports", + path: "/lib", mimeType: "", - size: 904920, + size: 592946, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-09-21T17:54:28.966Z"), + lastModifiedAt: new Date("2023-11-03T05:14:01.508Z"), version: "", isUploaded: false, - createdAt: new Date("2022-11-19T09:21:25.817Z"), + createdAt: new Date("2022-09-12T22:21:35.224Z"), sizeReadable: "", - publicUrl: "https://moral-pillow.net/", + publicUrl: "https://long-term-ignorance.net/", }, ], }, productPrice: { - createdAt: new Date("2023-04-23T23:25:57.748Z"), - modifiedAt: new Date("2022-08-17T05:07:46.724Z"), + createdAt: new Date("2022-07-02T11:07:10.887Z"), + modifiedAt: new Date("2023-08-07T00:52:08.467Z"), id: "", isArchived: false, - priceCurrency: "", - minimumAmount: 552962, - maximumAmount: 275913, - presetAmount: 535055, - recurringInterval: "month", + recurringInterval: "year", }, subscription: { - createdAt: new Date("2024-09-13T08:05:18.568Z"), - modifiedAt: new Date("2023-01-06T13:27:24.144Z"), + createdAt: new Date("2022-07-14T18:39:25.284Z"), + modifiedAt: new Date("2023-05-25T13:18:45.811Z"), id: "", - amount: 610335, - currency: "Boliviano boliviano", + amount: 609079, + currency: "Yuan Renminbi", recurringInterval: "year", - status: "incomplete_expired", - currentPeriodStart: new Date("2024-11-14T08:36:25.032Z"), - currentPeriodEnd: new Date("2023-03-08T23:50:01.730Z"), + status: "incomplete", + currentPeriodStart: new Date("2024-11-03T06:30:48.767Z"), + currentPeriodEnd: new Date("2023-05-29T04:05:53.462Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-10-28T17:13:19.444Z"), - endedAt: new Date("2022-08-25T12:45:17.173Z"), + startedAt: new Date("2023-01-04T09:22:53.989Z"), + endedAt: new Date("2022-05-09T00:29:29.459Z"), userId: "", productId: "", priceId: "", @@ -102,8 +97,8 @@ let value: ListResourceUserOrder = { }, ], pagination: { - totalCount: 861477, - maxPage: 804333, + totalCount: 432597, + maxPage: 659804, }, }; ``` diff --git a/docs/models/components/listresourceusersubscription.md b/docs/models/components/listresourceusersubscription.md index 36603a2c..7a978c96 100644 --- a/docs/models/components/listresourceusersubscription.md +++ b/docs/models/components/listresourceusersubscription.md @@ -8,50 +8,54 @@ import { ListResourceUserSubscription } from "@polar-sh/sdk/models/components"; let value: ListResourceUserSubscription = { items: [ { - createdAt: new Date("2024-08-29T10:57:12.925Z"), - modifiedAt: new Date("2024-01-03T01:33:43.374Z"), + createdAt: new Date("2023-04-02T14:53:00.063Z"), + modifiedAt: new Date("2023-08-18T16:34:38.040Z"), id: "", - amount: 422444, - currency: "Ethiopian Birr", - recurringInterval: "month", - status: "past_due", - currentPeriodStart: new Date("2023-03-26T14:55:05.183Z"), - currentPeriodEnd: new Date("2024-03-25T08:28:26.995Z"), + amount: 521914, + currency: "Rupiah", + recurringInterval: "year", + status: "incomplete", + currentPeriodStart: new Date("2022-02-08T22:48:14.333Z"), + currentPeriodEnd: new Date("2023-04-06T14:30:06.008Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-09-20T19:47:52.089Z"), - endedAt: new Date("2022-11-21T00:49:05.762Z"), + startedAt: new Date("2024-09-09T18:38:44.004Z"), + endedAt: new Date("2022-11-01T05:11:03.107Z"), userId: "", productId: "", priceId: "", checkoutId: "", product: { - createdAt: new Date("2023-12-14T06:58:44.385Z"), - modifiedAt: new Date("2023-04-09T07:17:04.384Z"), + createdAt: new Date("2022-07-08T20:25:28.116Z"), + modifiedAt: new Date("2024-10-14T07:35:36.976Z"), id: "", name: "", - description: "into accompany ack", + description: "zowie above vivaciously wonderfully", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-07-05T22:22:10.952Z"), - modifiedAt: new Date("2022-02-17T14:46:59.933Z"), + createdAt: new Date("2022-12-13T15:44:37.740Z"), + modifiedAt: new Date("2024-03-11T19:46:55.808Z"), id: "", isArchived: false, + priceCurrency: "", + priceAmount: 199673, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2023-07-02T02:28:44.314Z"), - modifiedAt: new Date("2023-05-06T20:10:59.426Z"), + createdAt: new Date("2024-11-29T00:32:22.656Z"), + modifiedAt: new Date("2024-12-17T20:16:52.685Z"), id: "", - type: "custom", - description: - "overstay consequently anenst when inasmuch ectoderm where oof", + description: "likely shocked yahoo however", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -59,34 +63,38 @@ let value: ListResourceUserSubscription = { id: "", organizationId: "", name: "", - path: "/usr/libexec", + path: "/usr/local/src", mimeType: "", - size: 565559, + size: 901842, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-03-28T02:30:19.833Z"), + lastModifiedAt: new Date("2023-01-21T06:06:28.878Z"), version: "", isUploaded: false, - createdAt: new Date("2023-05-29T06:59:46.200Z"), + createdAt: new Date("2022-11-19T05:08:45.306Z"), sizeReadable: "", - publicUrl: "https://apt-planula.com/", + publicUrl: "https://hairy-pecan.biz", }, ], }, price: { - createdAt: new Date("2024-09-03T20:35:51.119Z"), - modifiedAt: new Date("2023-10-30T20:42:04.012Z"), + createdAt: new Date("2024-10-08T20:41:24.877Z"), + modifiedAt: new Date("2023-11-10T00:43:35.009Z"), id: "", isArchived: false, + priceCurrency: "", + minimumAmount: 208826, + maximumAmount: 682430, + presetAmount: 768361, recurringInterval: "month", }, }, ], pagination: { - totalCount: 474056, - maxPage: 667620, + totalCount: 559209, + maxPage: 681953, }, }; ``` diff --git a/docs/models/components/loc.md b/docs/models/components/loc.md index b5b8a20b..2b8ca4a8 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 = 505192; +const value: number = 773332; ``` diff --git a/docs/models/components/metric.md b/docs/models/components/metric.md index d75ec96c..0f07a574 100644 --- a/docs/models/components/metric.md +++ b/docs/models/components/metric.md @@ -9,15 +9,15 @@ import { Metric } from "@polar-sh/sdk/models/components"; let value: Metric = { slug: "", - displayName: "Alena_Konopelski", + displayName: "Maximilian.Hodkiewicz", type: "currency", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `slug` | *string* | :heavy_check_mark: | Unique identifier for the metric. | -| `displayName` | *string* | :heavy_check_mark: | Human-readable name for the metric. | -| `type` | [components.MetricType](../../models/components/metrictype.md) | :heavy_check_mark: | Type of the metric, useful to know the unit or format of the value. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `slug` | *string* | :heavy_check_mark: | Unique identifier for the metric. | +| `displayName` | *string* | :heavy_check_mark: | Human-readable name for the metric. | +| `type` | [components.MetricType](../../models/components/metrictype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/metricperiod.md b/docs/models/components/metricperiod.md index 90f47ef5..de399077 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("2022-03-19T21:33:35.937Z"), - orders: 57659, - revenue: 528552, - averageOrderValue: 396772, - oneTimeProducts: 735432, - oneTimeProductsRevenue: 628062, - newSubscriptions: 306, - newSubscriptionsRevenue: 16877, - renewedSubscriptions: 839715, - renewedSubscriptionsRevenue: 164585, - activeSubscriptions: 569596, - monthlyRecurringRevenue: 940497, + timestamp: new Date("2023-05-22T07:36:17.577Z"), + orders: 574923, + revenue: 138094, + averageOrderValue: 306970, + oneTimeProducts: 552212, + oneTimeProductsRevenue: 401260, + newSubscriptions: 715995, + newSubscriptionsRevenue: 231322, + renewedSubscriptions: 470724, + renewedSubscriptionsRevenue: 821046, + activeSubscriptions: 142769, + monthlyRecurringRevenue: 894928, }; ``` diff --git a/docs/models/components/metrics.md b/docs/models/components/metrics.md index b99c9194..4d1cf701 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: "Zula.Daniel", + displayName: "Cruz79", type: "currency", }, revenue: { slug: "", - displayName: "Arjun_Kuhn", + displayName: "Zena72", type: "currency", }, averageOrderValue: { slug: "", - displayName: "Karlie80", + displayName: "Gisselle_Swift", type: "currency", }, oneTimeProducts: { slug: "", - displayName: "Colten.Tromp49", + displayName: "Abelardo.Reilly", type: "scalar", }, oneTimeProductsRevenue: { slug: "", - displayName: "Laila_Kassulke", - type: "scalar", + displayName: "Katheryn_Parker", + type: "currency", }, newSubscriptions: { slug: "", - displayName: "Clay_Hirthe", + displayName: "Davonte_Bernhard17", type: "currency", }, newSubscriptionsRevenue: { slug: "", - displayName: "Xzavier.Larson1", + displayName: "Gerda.OReilly72", type: "currency", }, renewedSubscriptions: { slug: "", - displayName: "Wava_Mitchell64", + displayName: "Enrique.Conroy", type: "scalar", }, renewedSubscriptionsRevenue: { slug: "", - displayName: "Ernestina.Abbott-Rippin", + displayName: "Nichole4", type: "scalar", }, activeSubscriptions: { slug: "", - displayName: "Alia.Bailey42", + displayName: "Rory.Erdman", type: "scalar", }, monthlyRecurringRevenue: { slug: "", - displayName: "Freddy64", + displayName: "Danial.Corwin6", type: "scalar", }, }; diff --git a/docs/models/components/metricsintervallimit.md b/docs/models/components/metricsintervallimit.md index cf1d7c8c..2d23db7f 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: 467579, + maxDays: 832596, }; ``` diff --git a/docs/models/components/metricsintervalslimits.md b/docs/models/components/metricsintervalslimits.md index 7fd60ebb..aad33ea7 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: 415732, + maxDays: 263484, }, day: { - maxDays: 42665, + maxDays: 997814, }, week: { - maxDays: 533171, + maxDays: 98864, }, month: { - maxDays: 116704, + maxDays: 530452, }, year: { - maxDays: 79114, + maxDays: 773381, }, }; ``` @@ -30,8 +30,8 @@ let value: MetricsIntervalsLimits = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `hour` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Limits for the hour interval. | -| `day` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Limits for the day interval. | -| `week` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Limits for the week interval. | -| `month` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Limits for the month interval. | -| `year` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Limits for the year interval. | \ No newline at end of file +| `hour` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Date interval limit to get metrics for a given interval. | +| `day` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Date interval limit to get metrics for a given interval. | +| `week` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Date interval limit to get metrics for a given interval. | +| `month` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Date interval limit to get metrics for a given interval. | +| `year` | [components.MetricsIntervalLimit](../../models/components/metricsintervallimit.md) | :heavy_check_mark: | Date interval limit to get metrics for a given interval. | \ No newline at end of file diff --git a/docs/models/components/metricslimits.md b/docs/models/components/metricslimits.md index fe22d057..74021ee7 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("2024-11-25"), + minDate: new RFCDate("2023-06-10"), intervals: { hour: { - maxDays: 844253, + maxDays: 635909, }, day: { - maxDays: 888924, + maxDays: 541834, }, week: { - maxDays: 905059, + maxDays: 823250, }, month: { - maxDays: 76555, + maxDays: 186640, }, year: { - maxDays: 857243, + maxDays: 129904, }, }, }; @@ -35,4 +35,4 @@ let value: MetricsLimits = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `minDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | Minimum date to get metrics. | -| `intervals` | [components.MetricsIntervalsLimits](../../models/components/metricsintervalslimits.md) | :heavy_check_mark: | Limits for each interval. | \ No newline at end of file +| `intervals` | [components.MetricsIntervalsLimits](../../models/components/metricsintervalslimits.md) | :heavy_check_mark: | Date interval limits to get metrics for each interval. | \ No newline at end of file diff --git a/docs/models/components/metricsresponse.md b/docs/models/components/metricsresponse.md index 932bdc98..6ab47d0d 100644 --- a/docs/models/components/metricsresponse.md +++ b/docs/models/components/metricsresponse.md @@ -10,74 +10,74 @@ import { MetricsResponse } from "@polar-sh/sdk/models/components"; let value: MetricsResponse = { periods: [ { - timestamp: new Date("2024-01-14T18:49:36.050Z"), - orders: 953960, - revenue: 151023, - averageOrderValue: 794154, - oneTimeProducts: 420626, - oneTimeProductsRevenue: 929687, - newSubscriptions: 686991, - newSubscriptionsRevenue: 147165, - renewedSubscriptions: 32474, - renewedSubscriptionsRevenue: 125622, - activeSubscriptions: 712690, - monthlyRecurringRevenue: 10541, + timestamp: new Date("2024-01-17T21:04:26.038Z"), + orders: 240101, + revenue: 349551, + averageOrderValue: 71631, + oneTimeProducts: 816230, + oneTimeProductsRevenue: 70999, + newSubscriptions: 298797, + newSubscriptionsRevenue: 925633, + renewedSubscriptions: 559410, + renewedSubscriptionsRevenue: 217880, + activeSubscriptions: 992888, + monthlyRecurringRevenue: 880730, }, ], metrics: { orders: { slug: "", - displayName: "Javier.Schulist0", - type: "scalar", + displayName: "Anne.Nitzsche53", + type: "currency", }, revenue: { slug: "", - displayName: "Willa22", - type: "scalar", + displayName: "Justus.Collier-Lemke61", + type: "currency", }, averageOrderValue: { slug: "", - displayName: "Joaquin.Toy76", + displayName: "Hyman49", type: "scalar", }, oneTimeProducts: { slug: "", - displayName: "Westley_OKon2", - type: "currency", + displayName: "Dena13", + type: "scalar", }, oneTimeProductsRevenue: { slug: "", - displayName: "Jackeline.Klein90", + displayName: "Ally.Fahey", type: "currency", }, newSubscriptions: { slug: "", - displayName: "Addison_DuBuque39", - type: "currency", + displayName: "Danny.Swift99", + type: "scalar", }, newSubscriptionsRevenue: { slug: "", - displayName: "Emil26", + displayName: "Kenya_Krajcik41", type: "scalar", }, renewedSubscriptions: { slug: "", - displayName: "Aliya.Kuphal", - type: "scalar", + displayName: "Tatum.Crooks", + type: "currency", }, renewedSubscriptionsRevenue: { slug: "", - displayName: "Nels_Kuhn", + displayName: "Ada_Marvin10", type: "currency", }, activeSubscriptions: { slug: "", - displayName: "Jolie38", - type: "currency", + displayName: "Kaelyn_Schumm", + type: "scalar", }, monthlyRecurringRevenue: { slug: "", - displayName: "Arnold39", + displayName: "Donnell88", type: "currency", }, }, @@ -89,4 +89,4 @@ let value: MetricsResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `periods` | [components.MetricPeriod](../../models/components/metricperiod.md)[] | :heavy_check_mark: | List of data for each timestamp. | -| `metrics` | [components.Metrics](../../models/components/metrics.md) | :heavy_check_mark: | Information about the returned metrics. | \ No newline at end of file +| `metrics` | [components.Metrics](../../models/components/metrics.md) | :heavy_check_mark: | N/A | \ No newline at end of file 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 e61e2ff0..f368abc6 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://failing-filter.net/", + "https://black-clavicle.biz", ], clientName: "", - createdAt: new Date("2023-02-08T19:52:05.749Z"), - modifiedAt: new Date("2024-05-22T23:47:26.346Z"), + createdAt: new Date("2022-08-31T05:11:50.378Z"), + modifiedAt: new Date("2022-09-16T00:41:17.064Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 587166, - clientSecretExpiresAt: 350567, + clientIdIssuedAt: 152850, + clientSecretExpiresAt: 692918, }; ``` diff --git a/docs/models/components/oauth2clientconfiguration.md b/docs/models/components/oauth2clientconfiguration.md index 1d327624..68a0d4e3 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://improbable-freezing.net/", + "https://impeccable-velocity.info/", ], clientName: "", }; diff --git a/docs/models/components/oauth2clientconfigurationupdate.md b/docs/models/components/oauth2clientconfigurationupdate.md index 75be9da1..ad54deb8 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://metallic-quinoa.org/", + "https://entire-roadway.com/", ], clientName: "", clientId: "", diff --git a/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md b/docs/models/components/onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.md index 15a863c5..1d610299 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://coarse-license.com/", + redirectUri: "https://ecstatic-legislature.com/", }; ``` diff --git a/docs/models/components/order.md b/docs/models/components/order.md index d512b26f..3b068460 100644 --- a/docs/models/components/order.md +++ b/docs/models/components/order.md @@ -6,15 +6,16 @@ import { Order } from "@polar-sh/sdk/models/components"; let value: Order = { - createdAt: new Date("2023-05-22T10:20:56.336Z"), - modifiedAt: new Date("2022-02-06T11:47:57.029Z"), + createdAt: new Date("2023-06-22T00:09:40.274Z"), + modifiedAt: new Date("2022-07-19T21:06:20.014Z"), id: "", metadata: { "key": "", }, - amount: 81263, - taxAmount: 929429, - currency: "Seychelles Rupee", + amount: 704284, + taxAmount: 841379, + currency: "UAE Dirham", + billingReason: "purchase", userId: "", productId: "", productPriceId: "", @@ -22,44 +23,46 @@ let value: Order = { checkoutId: "", user: { id: "", - email: "Corine.Rutherford21@yahoo.com", + email: "Wilton90@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://political-pants.org", + avatarUrl: "https://natural-sarong.biz", }, product: { - createdAt: new Date("2024-09-04T09:52:55.353Z"), - modifiedAt: new Date("2024-01-16T18:51:08.358Z"), + createdAt: new Date("2023-12-03T06:44:12.845Z"), + modifiedAt: new Date("2024-03-18T13:58:56.966Z"), id: "", name: "", - description: - "ew quarrelsomely materialise blah lost wherever oh inasmuch paltry scholarship", + description: "lavish psst ew strange why well-documented poppy", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2022-08-15T15:59:22.837Z"), - modifiedAt: new Date("2024-10-25T03:21:56.772Z"), + createdAt: new Date("2022-03-27T05:19:48.158Z"), + modifiedAt: new Date("2024-07-16T11:44:37.294Z"), id: "", isArchived: false, + priceCurrency: "", + priceAmount: 241190, + recurringInterval: "month", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2023-09-26T16:34:12.626Z"), - modifiedAt: new Date("2022-03-24T22:50:12.488Z"), + createdAt: new Date("2023-03-05T09:01:12.508Z"), + modifiedAt: new Date("2023-11-21T22:00:18.063Z"), id: "", - amount: 313717, - currency: "Namibia Dollar", + amount: 586260, + currency: "Vatu", recurringInterval: "year", - status: "trialing", - currentPeriodStart: new Date("2024-09-30T14:20:49.162Z"), - currentPeriodEnd: new Date("2023-01-31T23:13:50.155Z"), + status: "active", + currentPeriodStart: new Date("2024-02-19T21:52:41.487Z"), + currentPeriodEnd: new Date("2023-12-29T10:34:57.471Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-03-29T20:55:19.511Z"), - endedAt: new Date("2022-06-10T07:21:24.112Z"), + startedAt: new Date("2024-04-21T03:44:58.953Z"), + endedAt: new Date("2023-09-20T09:06:06.239Z"), userId: "", productId: "", priceId: "", @@ -79,6 +82,7 @@ let value: Order = { | `amount` | *number* | :heavy_check_mark: | N/A | | `taxAmount` | *number* | :heavy_check_mark: | N/A | | `currency` | *string* | :heavy_check_mark: | N/A | +| `billingReason` | [components.OrderBillingReason](../../models/components/orderbillingreason.md) | :heavy_check_mark: | N/A | | `userId` | *string* | :heavy_check_mark: | N/A | | `productId` | *string* | :heavy_check_mark: | N/A | | `productPriceId` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/orderbillingreason.md b/docs/models/components/orderbillingreason.md new file mode 100644 index 00000000..1ade1a7b --- /dev/null +++ b/docs/models/components/orderbillingreason.md @@ -0,0 +1,15 @@ +# OrderBillingReason + +## Example Usage + +```typescript +import { OrderBillingReason } from "@polar-sh/sdk/models/components"; + +let value: OrderBillingReason = "subscription_create"; +``` + +## Values + +```typescript +"purchase" | "subscription_create" | "subscription_cycle" | "subscription_update" +``` \ No newline at end of file diff --git a/docs/models/components/orderinvoice.md b/docs/models/components/orderinvoice.md index 709f40da..036a1c51 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://quixotic-flu.biz", + url: "https://velvety-oil.com/", }; ``` diff --git a/docs/models/components/orderproduct.md b/docs/models/components/orderproduct.md index 2e500166..17b4ff2e 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("2024-09-24T18:40:19.566Z"), - modifiedAt: new Date("2023-04-26T06:13:22.417Z"), + createdAt: new Date("2022-03-01T17:18:33.209Z"), + modifiedAt: new Date("2022-06-17T21:45:07.040Z"), id: "", name: "", - description: "keel tune-up think taxicab international ill-fated", + description: "what motivate how plastic snappy until eek suspiciously", isRecurring: false, isArchived: false, organizationId: "", diff --git a/docs/models/components/ordersortproperty.md b/docs/models/components/ordersortproperty.md index 79300027..813ad683 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 = "product"; +let value: OrderSortProperty = "subscription"; ``` ## Values diff --git a/docs/models/components/ordersubscription.md b/docs/models/components/ordersubscription.md index abdec820..25395d0c 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-02-04T02:05:19.101Z"), - modifiedAt: new Date("2023-06-23T14:49:51.984Z"), + createdAt: new Date("2024-06-03T18:58:37.464Z"), + modifiedAt: new Date("2024-09-13T11:06:26.457Z"), id: "", - amount: 424629, - currency: "Danish Krone", - recurringInterval: "year", - status: "incomplete", - currentPeriodStart: new Date("2022-08-12T00:39:03.344Z"), - currentPeriodEnd: new Date("2023-02-18T15:25:39.111Z"), + amount: 696477, + currency: "Forint", + recurringInterval: "month", + status: "past_due", + currentPeriodStart: new Date("2023-11-24T01:06:43.392Z"), + currentPeriodEnd: new Date("2022-01-27T04:56:36.497Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-05-24T16:59:25.156Z"), - endedAt: new Date("2024-10-22T02:46:29.890Z"), + startedAt: new Date("2024-03-29T19:57:55.385Z"), + endedAt: new Date("2022-09-01T04:11:11.405Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/orderuser.md b/docs/models/components/orderuser.md index b4727ac5..49407060 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: "Bessie.Sawayn91@gmail.com", + email: "Johathan.Dooley@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://proper-metal.org/", + avatarUrl: "https://insecure-ownership.info", }; ``` diff --git a/docs/models/components/organization.md b/docs/models/components/organization.md index 4004a867..b2e4da89 100644 --- a/docs/models/components/organization.md +++ b/docs/models/components/organization.md @@ -6,21 +6,21 @@ import { Organization } from "@polar-sh/sdk/models/components"; let value: Organization = { - createdAt: new Date("2022-07-21T10:46:45.227Z"), - modifiedAt: new Date("2023-09-20T08:42:36.771Z"), + createdAt: new Date("2023-03-31T20:14:22.654Z"), + modifiedAt: new Date("2023-01-06T22:36:44.731Z"), id: "", name: "", slug: "", - avatarUrl: "https://diligent-tribe.biz/", + avatarUrl: "https://hopeful-chasuble.biz/", bio: "", - company: "Bailey, Deckow and Schuppe", + company: "Koss - Sporer", blog: "", location: "", - email: "Lupe17@yahoo.com", + email: "Mafalda.Swaniawski@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 457632, + pledgeMinimumAmount: 541948, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 472455, + defaultUpfrontSplitToContributors: 774946, donationsEnabled: false, profileSettings: {}, featureSettings: {}, diff --git a/docs/models/components/organizationavatarfilecreate.md b/docs/models/components/organizationavatarfilecreate.md index a2115987..098ac5a3 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: 615665, + size: 771024, upload: { parts: [ { - number: 619689, - chunkStart: 281326, - chunkEnd: 588513, + number: 392658, + chunkStart: 600106, + chunkEnd: 609454, }, ], }, diff --git a/docs/models/components/organizationavatarfileread.md b/docs/models/components/organizationavatarfileread.md index 753eb6fc..77f969fb 100644 --- a/docs/models/components/organizationavatarfileread.md +++ b/docs/models/components/organizationavatarfileread.md @@ -11,19 +11,19 @@ let value: OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/home/user", + path: "/private", mimeType: "", - size: 423019, + size: 881891, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-03-08T04:36:01.401Z"), + lastModifiedAt: new Date("2022-12-02T10:43:36.676Z"), version: "", isUploaded: false, - createdAt: new Date("2022-11-10T18:13:12.189Z"), + createdAt: new Date("2024-10-18T17:56:31.756Z"), sizeReadable: "", - publicUrl: "https://lively-millet.net/", + publicUrl: "https://flowery-hubris.org", }; ``` diff --git a/docs/models/components/organizationsortproperty.md b/docs/models/components/organizationsortproperty.md index 6fbb5d61..091e49ef 100644 --- a/docs/models/components/organizationsortproperty.md +++ b/docs/models/components/organizationsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { OrganizationSortProperty } from "@polar-sh/sdk/models/components"; -let value: OrganizationSortProperty = "name"; +let value: OrganizationSortProperty = "-name"; ``` ## Values diff --git a/docs/models/components/pagination.md b/docs/models/components/pagination.md index 8ba58bf8..c3de3850 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: 39783, - maxPage: 13836, + totalCount: 531568, + maxPage: 645139, }; ``` diff --git a/docs/models/components/permission.md b/docs/models/components/permission.md index 66fabd49..7e6acd5d 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 = "pull"; +let value: Permission = "admin"; ``` ## Values diff --git a/docs/models/components/pledge.md b/docs/models/components/pledge.md index e10a1114..65a1f095 100644 --- a/docs/models/components/pledge.md +++ b/docs/models/components/pledge.md @@ -6,41 +6,42 @@ import { Pledge } from "@polar-sh/sdk/models/components"; let value: Pledge = { - createdAt: new Date("2023-08-25T04:33:12.523Z"), - modifiedAt: new Date("2022-07-08T11:58:21.169Z"), + createdAt: new Date("2023-06-09T03:01:47.083Z"), + modifiedAt: new Date("2022-05-16T08:17:04.872Z"), id: "", - amount: 963970, - currency: "Bulgarian Lev", - state: "created", - type: "pay_directly", + amount: 853228, + currency: "Ethiopian Birr", + state: "pending", + type: "pay_upfront", issue: { - id: "cd764005-3a2e-4f70-b24e-ef42856705b7", - number: 672340, + id: "205c9d2a-b51b-487d-974b-4431cb6bf778", + number: 248004, title: "", - state: "closed", - issueCreatedAt: new Date("2024-01-27T14:58:29.591Z"), + state: "open", + issueCreatedAt: new Date("2023-07-03T19:12:50.569Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "82efd115-bd2a-4217-8daa-64e6811ceaec", + id: "49cb2a06-7ceb-4ce7-a456-54ffacba22e0", isPrivate: false, name: "MyOrg", - description: "until hence cafe", + description: + "galoshes kinase considering although foretell upbeat gift wherever than", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "f04d42cb-18e6-43b3-8e67-b5f4f6cc9c99", + id: "d38d904a-9eec-425f-a75f-bb61f1a000f7", name: "", - avatarUrl: "https://cruel-labourer.biz", + avatarUrl: "https://lucky-legend.com/", isPersonal: false, bio: "", prettyName: "", - company: "Dach - Lowe", + company: "Torphy LLC", blog: "", location: "", - email: "Jerry48@hotmail.com", + email: "Verdie56@gmail.com", twitterUsername: "", organizationId: "", }, @@ -59,11 +60,11 @@ let value: Pledge = { | `id` | *string* | :heavy_check_mark: | The ID of the object. | | `amount` | *number* | :heavy_check_mark: | Amount pledged towards the issue | | `currency` | *string* | :heavy_check_mark: | N/A | -| `state` | [components.PledgeState](../../models/components/pledgestate.md) | :heavy_check_mark: | Current state of the pledge | -| `type` | [components.PledgeType](../../models/components/pledgetype.md) | :heavy_check_mark: | Type of pledge | +| `state` | [components.PledgeState](../../models/components/pledgestate.md) | :heavy_check_mark: | N/A | +| `type` | [components.PledgeType](../../models/components/pledgetype.md) | :heavy_check_mark: | N/A | | `refundedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | If and when the pledge was refunded to the pledger | | `scheduledPayoutAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | When the payout is scheduled to be made to the maintainers behind the issue. Disputes must be made before this date. | -| `issue` | [components.Issue](../../models/components/issue.md) | :heavy_check_mark: | The issue that the pledge was made towards | +| `issue` | [components.Issue](../../models/components/issue.md) | :heavy_check_mark: | N/A | | `pledger` | [components.Pledger](../../models/components/pledger.md) | :heavy_minus_sign: | The user or organization that made this pledge | | `hostedInvoiceUrl` | *string* | :heavy_minus_sign: | URL of invoice for this pledge | | `authedCanAdminSender` | *boolean* | :heavy_minus_sign: | If the currently authenticated subject can perform admin actions on behalf of the maker of the peldge | diff --git a/docs/models/components/pledger.md b/docs/models/components/pledger.md index 2d04e875..04889a07 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://vast-cantaloupe.name", + avatarUrl: "https://accurate-caption.com", }; ``` diff --git a/docs/models/components/pledgestate.md b/docs/models/components/pledgestate.md index 72500b1b..eb701241 100644 --- a/docs/models/components/pledgestate.md +++ b/docs/models/components/pledgestate.md @@ -5,7 +5,7 @@ ```typescript import { PledgeState } from "@polar-sh/sdk/models/components"; -let value: PledgeState = "pending"; +let value: PledgeState = "charge_disputed"; ``` ## Values diff --git a/docs/models/components/pledgetype.md b/docs/models/components/pledgetype.md index bb9fbb67..9585b0b4 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_on_completion"; +let value: PledgeType = "pay_upfront"; ``` ## Values diff --git a/docs/models/components/polarcheckoutlegacyschemascheckout.md b/docs/models/components/polarcheckoutlegacyschemascheckout.md index a1f40c10..100aa276 100644 --- a/docs/models/components/polarcheckoutlegacyschemascheckout.md +++ b/docs/models/components/polarcheckoutlegacyschemascheckout.md @@ -12,32 +12,32 @@ let value: PolarCheckoutLegacySchemasCheckout = { customerEmail: "", customerName: "", product: { - createdAt: new Date("2023-01-19T13:22:59.390Z"), - modifiedAt: new Date("2023-03-24T08:43:04.460Z"), + createdAt: new Date("2022-03-16T12:13:21.445Z"), + modifiedAt: new Date("2024-12-12T14:47:34.950Z"), id: "", name: "", - description: - "glittering parched now fashion judgementally yak through excitedly steep", + description: "like astride apologise um handy into", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-09-14T07:43:31.648Z"), - modifiedAt: new Date("2023-09-10T05:55:09.703Z"), + createdAt: new Date("2022-08-31T13:02:18.053Z"), + modifiedAt: new Date("2023-06-16T13:05:35.278Z"), id: "", isArchived: false, - recurringInterval: "month", + priceCurrency: "", + priceAmount: 494136, }, ], benefits: [ { - createdAt: new Date("2022-07-09T15:57:29.739Z"), - modifiedAt: new Date("2022-03-05T03:05:50.686Z"), + createdAt: new Date("2023-09-30T19:30:59.394Z"), + modifiedAt: new Date("2023-04-03T20:16:14.287Z"), id: "", - type: "downloadables", + type: "github_repository", description: - "zowie vibration abaft grizzled despite quarrelsomely mesh cuckoo", + "worth near likewise freckle offensively duh yet rarely dally woot", selectable: false, deletable: false, organizationId: "", @@ -48,28 +48,31 @@ let value: PolarCheckoutLegacySchemasCheckout = { id: "", organizationId: "", name: "", - path: "/lost+found", + path: "/boot", mimeType: "", - size: 766004, + size: 40256, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-03-28T13:18:59.699Z"), + lastModifiedAt: new Date("2022-12-06T04:06:39.697Z"), version: "", isUploaded: false, - createdAt: new Date("2024-09-07T06:13:39.585Z"), + createdAt: new Date("2023-06-21T02:24:58.276Z"), sizeReadable: "", - publicUrl: "https://secret-rim.org/", + publicUrl: "https://smart-guide.net", }, ], }, productPrice: { - createdAt: new Date("2023-01-22T23:18:37.610Z"), - modifiedAt: new Date("2023-03-02T13:30:13.678Z"), + createdAt: new Date("2022-06-05T05:25:45.254Z"), + modifiedAt: new Date("2022-11-11T19:39:57.152Z"), id: "", isArchived: false, - recurringInterval: "year", + priceCurrency: "", + minimumAmount: 533877, + maximumAmount: 813932, + presetAmount: 403314, }, }; ``` diff --git a/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md b/docs/models/components/polarcheckoutlegacyschemascheckoutcreate.md index d8809d05..25dbcc7f 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://hasty-tusk.biz/", + successUrl: "https://rapid-extent.name", }; ``` diff --git a/docs/models/components/polarcheckoutschemascheckout.md b/docs/models/components/polarcheckoutschemascheckout.md index 93a322cd..3b32eb47 100644 --- a/docs/models/components/polarcheckoutschemascheckout.md +++ b/docs/models/components/polarcheckoutschemascheckout.md @@ -8,33 +8,33 @@ Checkout session data retrieved using an access token. import { PolarCheckoutSchemasCheckout } from "@polar-sh/sdk/models/components"; let value: PolarCheckoutSchemasCheckout = { - createdAt: new Date("2023-05-18T06:28:04.134Z"), - modifiedAt: new Date("2024-10-11T08:44:45.015Z"), + createdAt: new Date("2024-02-01T10:56:21.274Z"), + modifiedAt: new Date("2022-06-23T00:19:14.402Z"), id: "", status: "failed", clientSecret: "", - expiresAt: new Date("2024-12-10T05:43:15.244Z"), - successUrl: "https://shadowy-attraction.org", - amount: 473319, - taxAmount: 60997, - currency: "Zambian Kwacha", - totalAmount: 570377, + expiresAt: new Date("2023-05-05T04:09:38.309Z"), + successUrl: "https://downright-object.org/", + amount: 589101, + taxAmount: 652345, + currency: "Pound Sterling", + totalAmount: 325851, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Aisha_Deckow@yahoo.com", + customerEmail: "Jordi.Mosciski62@gmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Argentina", + country: "Thailand", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { "key": "", }, - url: "https://well-lit-approach.com", + url: "https://dramatic-knickers.org/", }; ``` @@ -45,8 +45,8 @@ let value: PolarCheckoutSchemasCheckout = { | `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. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | Payment processor used. | -| `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | Status of the checkout session. | +| `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. | | `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. | diff --git a/docs/models/components/polarcheckoutschemascheckoutinput.md b/docs/models/components/polarcheckoutschemascheckoutinput.md index 4ed4cb9a..c4aee2ec 100644 --- a/docs/models/components/polarcheckoutschemascheckoutinput.md +++ b/docs/models/components/polarcheckoutschemascheckoutinput.md @@ -8,26 +8,26 @@ Checkout session data retrieved using an access token. import { PolarCheckoutSchemasCheckoutInput } from "@polar-sh/sdk/models/components"; let value: PolarCheckoutSchemasCheckoutInput = { - createdAt: new Date("2023-10-05T05:47:27.023Z"), - modifiedAt: new Date("2022-04-14T13:04:44.229Z"), + createdAt: new Date("2024-07-14T10:08:03.967Z"), + modifiedAt: new Date("2024-03-18T12:35:36.869Z"), id: "", - status: "failed", + status: "open", clientSecret: "", - expiresAt: new Date("2023-07-25T15:46:43.780Z"), - successUrl: "https://perky-printer.info/", - amount: 641831, - taxAmount: 108040, - currency: "Tanzanian Shilling", - totalAmount: 680725, + expiresAt: new Date("2023-03-24T06:29:34.406Z"), + successUrl: "https://stormy-derby.com/", + amount: 660769, + taxAmount: 219095, + currency: "Kyat", + totalAmount: 161205, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Bessie_Pouros9@hotmail.com", + customerEmail: "Willie.Spencer@hotmail.com", customerIpAddress: "", customerBillingAddress: { - country: "Namibia", + country: "Republic of Korea", }, customerTaxId: "", paymentProcessorMetadata: {}, @@ -44,8 +44,8 @@ let value: PolarCheckoutSchemasCheckoutInput = { | `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. | -| `paymentProcessor` | [components.PolarEnumsPaymentProcessor](../../models/components/polarenumspaymentprocessor.md) | :heavy_check_mark: | Payment processor used. | -| `status` | [components.CheckoutStatus](../../models/components/checkoutstatus.md) | :heavy_check_mark: | Status of the checkout session. | +| `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. | | `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. | diff --git a/docs/models/components/prices.md b/docs/models/components/prices.md index 8a184eae..211f570a 100644 --- a/docs/models/components/prices.md +++ b/docs/models/components/prices.md @@ -7,7 +7,7 @@ ```typescript const value: components.ProductPriceOneTimeFixedCreate = { - priceAmount: 228555, + priceAmount: 150525, }; ``` diff --git a/docs/models/components/product.md b/docs/models/components/product.md index 285266d3..38f1c54b 100644 --- a/docs/models/components/product.md +++ b/docs/models/components/product.md @@ -8,35 +8,38 @@ A product. import { Product } from "@polar-sh/sdk/models/components"; let value: Product = { - createdAt: new Date("2022-07-12T08:26:30.494Z"), - modifiedAt: new Date("2023-10-25T07:42:42.569Z"), + createdAt: new Date("2023-10-30T06:49:47.105Z"), + modifiedAt: new Date("2024-04-24T16:23:33.210Z"), id: "", name: "", - description: "victorious plus wilderness all the hence instead overburden", + description: "why rarely splurge electrify fooey now punctually", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-03-09T01:30:44.677Z"), - modifiedAt: new Date("2023-12-14T12:08:21.329Z"), + createdAt: new Date("2022-02-12T12:36:40.948Z"), + modifiedAt: new Date("2024-08-08T09:47:23.975Z"), id: "", isArchived: false, + priceCurrency: "", + minimumAmount: 77657, + maximumAmount: 287746, + presetAmount: 293369, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2023-10-21T15:06:03.630Z"), - modifiedAt: new Date("2024-05-19T11:50:21.965Z"), + createdAt: new Date("2024-07-22T15:57:17.539Z"), + modifiedAt: new Date("2024-04-30T07:02:01.520Z"), id: "", + type: "downloadables", description: - "shoulder whereas around generously from intensely underneath what yippee forenenst", + "across substitution measly intrepid beside foolishly bidet baa", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -44,19 +47,19 @@ let value: Product = { id: "", organizationId: "", name: "", - path: "/opt/include", + path: "/opt/lib", mimeType: "", - size: 60627, + size: 29848, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-09-09T04:28:09.469Z"), + lastModifiedAt: new Date("2024-11-22T18:03:41.709Z"), version: "", isUploaded: false, - createdAt: new Date("2023-07-02T23:56:35.113Z"), + createdAt: new Date("2024-04-15T08:28:57.630Z"), sizeReadable: "", - publicUrl: "https://livid-freezing.net", + publicUrl: "https://essential-guidance.biz/", }, ], }; diff --git a/docs/models/components/productbenefits.md b/docs/models/components/productbenefits.md index 66256e0b..0643faf4 100644 --- a/docs/models/components/productbenefits.md +++ b/docs/models/components/productbenefits.md @@ -7,11 +7,12 @@ ```typescript const value: components.BenefitBase = { - createdAt: new Date("2024-06-23T08:41:15.007Z"), - modifiedAt: new Date("2022-03-24T21:20:51.391Z"), + createdAt: new Date("2024-10-13T01:07:10.723Z"), + modifiedAt: new Date("2023-06-11T19:54:13.878Z"), id: "", - type: "articles", - description: "mmm madly acceptable impassioned pine once till how gadzooks", + type: "ads", + description: + "hollow receptor aboard hence who which incidentally fully behind midwife", selectable: false, deletable: false, organizationId: "", @@ -22,10 +23,10 @@ const value: components.BenefitBase = { ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2024-03-06T05:57:12.023Z"), - modifiedAt: new Date("2022-11-21T02:46:43.586Z"), + createdAt: new Date("2022-12-29T18:51:15.843Z"), + modifiedAt: new Date("2022-06-29T15:55:54.718Z"), id: "", - description: "quietly stake gaseous", + description: "noisily thorn peter behind huzzah now", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/productinput.md b/docs/models/components/productinput.md index 063de2b0..e6d3145a 100644 --- a/docs/models/components/productinput.md +++ b/docs/models/components/productinput.md @@ -8,31 +8,29 @@ A product. import { ProductInput } from "@polar-sh/sdk/models/components"; let value: ProductInput = { - createdAt: new Date("2023-08-19T15:30:07.630Z"), - modifiedAt: new Date("2024-06-17T19:03:37.149Z"), + createdAt: new Date("2023-04-04T17:15:03.449Z"), + modifiedAt: new Date("2023-09-29T08:26:20.213Z"), id: "", name: "", - description: "abnormally gee convalesce from ouch", + description: "rejigger openly handsome within bowler plus", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-03-18T03:00:38.903Z"), - modifiedAt: new Date("2022-10-21T14:08:24.521Z"), + createdAt: new Date("2022-08-16T11:06:13.409Z"), + modifiedAt: new Date("2024-03-03T16:49:58.761Z"), id: "", isArchived: false, - priceCurrency: "", - priceAmount: 973264, }, ], benefits: [ { - createdAt: new Date("2023-08-13T15:17:55.507Z"), - modifiedAt: new Date("2024-10-06T06:16:48.745Z"), + createdAt: new Date("2023-03-02T13:30:13.678Z"), + modifiedAt: new Date("2023-07-12T02:38:25.234Z"), id: "", type: "custom", - description: "quaintly populist outlandish ack", + description: "cope pulse whoa powerfully aware", selectable: false, deletable: false, organizationId: "", @@ -43,17 +41,17 @@ let value: ProductInput = { id: "", organizationId: "", name: "", - path: "/opt/include", + path: "/var/yp", mimeType: "", - size: 717730, + size: 473319, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-11-17T05:21:02.494Z"), + lastModifiedAt: new Date("2022-03-08T20:27:57.691Z"), version: "", isUploaded: false, - createdAt: new Date("2023-12-22T21:21:58.162Z"), + createdAt: new Date("2024-12-22T14:23:55.535Z"), }, ], }; diff --git a/docs/models/components/productmediafilecreate.md b/docs/models/components/productmediafilecreate.md index 62b77bea..61243ed3 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: 99113, + size: 80904, upload: { parts: [ { - number: 764666, - chunkStart: 883379, - chunkEnd: 118794, + number: 656811, + chunkStart: 673487, + chunkEnd: 973823, }, ], }, diff --git a/docs/models/components/productmediafileread.md b/docs/models/components/productmediafileread.md index 201b5632..62ba6003 100644 --- a/docs/models/components/productmediafileread.md +++ b/docs/models/components/productmediafileread.md @@ -11,19 +11,19 @@ let value: ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/private/var", + path: "/lib", mimeType: "", - size: 433431, + size: 997858, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-04-22T23:54:32.580Z"), + lastModifiedAt: new Date("2024-01-31T14:39:50.524Z"), version: "", isUploaded: false, - createdAt: new Date("2024-04-18T17:21:11.819Z"), + createdAt: new Date("2023-06-08T00:51:36.478Z"), sizeReadable: "", - publicUrl: "https://prime-vein.biz", + publicUrl: "https://pitiful-video.com", }; ``` diff --git a/docs/models/components/productmediafilereadinput.md b/docs/models/components/productmediafilereadinput.md index 00ec4d72..810307bb 100644 --- a/docs/models/components/productmediafilereadinput.md +++ b/docs/models/components/productmediafilereadinput.md @@ -11,17 +11,17 @@ let value: ProductMediaFileReadInput = { id: "", organizationId: "", name: "", - path: "/rescue", + path: "/selinux", mimeType: "", - size: 662228, + size: 459004, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-03-30T13:32:11.830Z"), + lastModifiedAt: new Date("2022-01-22T16:32:28.279Z"), version: "", isUploaded: false, - createdAt: new Date("2022-06-18T23:13:24.033Z"), + createdAt: new Date("2023-04-15T12:39:51.701Z"), }; ``` diff --git a/docs/models/components/productonetimecreate.md b/docs/models/components/productonetimecreate.md index 877db4fa..10f09a55 100644 --- a/docs/models/components/productonetimecreate.md +++ b/docs/models/components/productonetimecreate.md @@ -10,7 +10,9 @@ import { ProductOneTimeCreate } from "@polar-sh/sdk/models/components"; let value: ProductOneTimeCreate = { name: "", prices: [ - {}, + { + priceAmount: 526773, + }, ], }; ``` diff --git a/docs/models/components/productprice.md b/docs/models/components/productprice.md index 0df38e40..180e97e7 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("2024-01-05T22:33:57.738Z"), - modifiedAt: new Date("2023-05-24T08:39:03.249Z"), + createdAt: new Date("2024-08-02T02:25:14.445Z"), + modifiedAt: new Date("2024-05-16T16:29:20.566Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 274890, - recurringInterval: "year", + priceAmount: 194042, + recurringInterval: "month", }; ``` @@ -21,12 +21,10 @@ const value: components.ProductPriceRecurring = { ```typescript const value: components.ProductPriceOneTime = { - createdAt: new Date("2022-06-16T20:28:00.249Z"), - modifiedAt: new Date("2022-01-17T19:55:21.199Z"), + createdAt: new Date("2022-09-25T08:32:22.615Z"), + modifiedAt: new Date("2022-12-30T10:27:46.222Z"), id: "", isArchived: false, - priceCurrency: "", - priceAmount: 861301, }; ``` diff --git a/docs/models/components/productpriceonetime.md b/docs/models/components/productpriceonetime.md index 61a411fc..e29829bd 100644 --- a/docs/models/components/productpriceonetime.md +++ b/docs/models/components/productpriceonetime.md @@ -7,12 +7,12 @@ ```typescript const value: components.ProductPriceOneTimeFixed = { - createdAt: new Date("2022-11-08T07:51:31.480Z"), - modifiedAt: new Date("2023-06-21T05:17:07.412Z"), + createdAt: new Date("2022-02-15T09:56:09.632Z"), + modifiedAt: new Date("2023-03-16T07:41:57.893Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 706786, + priceAmount: 790341, }; ``` @@ -20,14 +20,14 @@ const value: components.ProductPriceOneTimeFixed = { ```typescript const value: components.ProductPriceOneTimeCustom = { - createdAt: new Date("2023-08-21T12:58:20.245Z"), - modifiedAt: new Date("2022-12-14T05:06:23.814Z"), + createdAt: new Date("2023-12-12T17:18:42.085Z"), + modifiedAt: new Date("2024-11-20T12:56:24.282Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 152542, - maximumAmount: 540603, - presetAmount: 142156, + minimumAmount: 106201, + maximumAmount: 911547, + presetAmount: 368849, }; ``` @@ -35,8 +35,8 @@ const value: components.ProductPriceOneTimeCustom = { ```typescript const value: components.ProductPriceOneTimeFree = { - createdAt: new Date("2024-10-26T11:27:52.228Z"), - modifiedAt: new Date("2023-08-15T17:16:57.437Z"), + createdAt: new Date("2023-06-04T12:09:50.425Z"), + modifiedAt: new Date("2023-04-15T14:47:40.530Z"), id: "", isArchived: false, }; diff --git a/docs/models/components/productpriceonetimecustom.md b/docs/models/components/productpriceonetimecustom.md index 1e9c4f22..faa4cd59 100644 --- a/docs/models/components/productpriceonetimecustom.md +++ b/docs/models/components/productpriceonetimecustom.md @@ -8,14 +8,14 @@ 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("2024-04-25T17:20:40.400Z"), - modifiedAt: new Date("2023-05-17T04:31:58.000Z"), + createdAt: new Date("2022-01-26T05:11:25.370Z"), + modifiedAt: new Date("2022-05-27T17:47:02.462Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 132662, - maximumAmount: 37211, - presetAmount: 993378, + minimumAmount: 25210, + maximumAmount: 857388, + presetAmount: 617325, }; ``` diff --git a/docs/models/components/productpriceonetimefixed.md b/docs/models/components/productpriceonetimefixed.md index 211fe840..9d8fe756 100644 --- a/docs/models/components/productpriceonetimefixed.md +++ b/docs/models/components/productpriceonetimefixed.md @@ -8,12 +8,12 @@ A one-time price for a product. import { ProductPriceOneTimeFixed } from "@polar-sh/sdk/models/components"; let value: ProductPriceOneTimeFixed = { - createdAt: new Date("2022-07-11T16:58:19.844Z"), - modifiedAt: new Date("2024-02-29T19:46:53.595Z"), + createdAt: new Date("2022-05-08T15:09:38.886Z"), + modifiedAt: new Date("2022-09-29T14:02:16.697Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 103547, + priceAmount: 742272, }; ``` diff --git a/docs/models/components/productpriceonetimefixedcreate.md b/docs/models/components/productpriceonetimefixedcreate.md index 8ec84726..d2dfd41b 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: 117761, + priceAmount: 676639, }; ``` diff --git a/docs/models/components/productpriceonetimefree.md b/docs/models/components/productpriceonetimefree.md index faf65cb9..96659724 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("2022-10-28T16:59:00.609Z"), - modifiedAt: new Date("2024-11-09T15:56:51.918Z"), + createdAt: new Date("2022-07-06T05:48:12.702Z"), + modifiedAt: new Date("2024-04-22T13:47:04.399Z"), id: "", isArchived: false, }; diff --git a/docs/models/components/productpricerecurring.md b/docs/models/components/productpricerecurring.md index 107a989d..fa5db1bc 100644 --- a/docs/models/components/productpricerecurring.md +++ b/docs/models/components/productpricerecurring.md @@ -7,12 +7,12 @@ ```typescript const value: components.ProductPriceRecurringFixed = { - createdAt: new Date("2023-06-24T15:10:59.459Z"), - modifiedAt: new Date("2023-07-21T07:41:14.595Z"), + createdAt: new Date("2023-01-12T00:01:57.325Z"), + modifiedAt: new Date("2024-05-27T22:36:34.200Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 114762, + priceAmount: 37030, recurringInterval: "month", }; ``` @@ -21,15 +21,15 @@ const value: components.ProductPriceRecurringFixed = { ```typescript const value: components.ProductPriceRecurringCustom = { - createdAt: new Date("2023-01-01T19:50:19.256Z"), - modifiedAt: new Date("2023-07-20T18:55:51.097Z"), + createdAt: new Date("2023-09-26T23:35:22.282Z"), + modifiedAt: new Date("2023-03-12T05:38:01.720Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 700872, - maximumAmount: 499270, - presetAmount: 831559, - recurringInterval: "month", + minimumAmount: 632885, + maximumAmount: 266461, + presetAmount: 909583, + recurringInterval: "year", }; ``` @@ -37,11 +37,11 @@ const value: components.ProductPriceRecurringCustom = { ```typescript const value: components.ProductPriceRecurringFree = { - createdAt: new Date("2022-01-31T18:49:35.545Z"), - modifiedAt: new Date("2023-04-13T01:30:33.992Z"), + createdAt: new Date("2022-03-16T05:59:47.707Z"), + modifiedAt: new Date("2024-05-09T03:50:58.829Z"), id: "", isArchived: false, - recurringInterval: "month", + recurringInterval: "year", }; ``` diff --git a/docs/models/components/productpricerecurringcustom.md b/docs/models/components/productpricerecurringcustom.md index f5a02ba3..a4221067 100644 --- a/docs/models/components/productpricerecurringcustom.md +++ b/docs/models/components/productpricerecurringcustom.md @@ -8,14 +8,14 @@ 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-02-17T01:18:56.856Z"), - modifiedAt: new Date("2023-04-18T13:22:03.376Z"), + createdAt: new Date("2022-11-08T12:27:27.718Z"), + modifiedAt: new Date("2024-11-29T08:28:52.570Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 763869, - maximumAmount: 33457, - presetAmount: 38622, + minimumAmount: 717486, + maximumAmount: 610766, + presetAmount: 695088, recurringInterval: "month", }; ``` @@ -34,4 +34,4 @@ let value: ProductPriceRecurringCustom = { | `maximumAmount` | *number* | :heavy_check_mark: | The maximum amount the customer can pay. | | `presetAmount` | *number* | :heavy_check_mark: | The initial amount shown to the customer. | | `type` | [components.ProductPriceRecurringCustomType](../../models/components/productpricerecurringcustomtype.md) | :heavy_check_mark: | The type of the price. | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | The recurring interval of the price. | \ No newline at end of file +| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productpricerecurringfixed.md b/docs/models/components/productpricerecurringfixed.md index 5473ecb7..cedcdca4 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("2022-12-19T23:19:10.766Z"), - modifiedAt: new Date("2024-12-15T17:30:31.626Z"), + createdAt: new Date("2024-10-29T21:49:35.631Z"), + modifiedAt: new Date("2024-03-17T02:09:56.964Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 857355, - recurringInterval: "month", + priceAmount: 123593, + recurringInterval: "year", }; ``` @@ -30,4 +30,4 @@ let value: ProductPriceRecurringFixed = { | `priceCurrency` | *string* | :heavy_check_mark: | The currency. | | `priceAmount` | *number* | :heavy_check_mark: | The price in cents. | | `type` | [components.ProductPriceRecurringFixedType](../../models/components/productpricerecurringfixedtype.md) | :heavy_check_mark: | The type of the price. | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | The recurring interval of the price. | \ No newline at end of file +| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productpricerecurringfixedcreate.md b/docs/models/components/productpricerecurringfixedcreate.md index f3ecffd1..ded79fe5 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: 187613, + priceAmount: 524212, recurringInterval: "month", }; ``` @@ -21,4 +21,4 @@ let value: ProductPriceRecurringFixedCreate = { | `amountType` | [components.ProductPriceRecurringFixedCreateAmountType](../../models/components/productpricerecurringfixedcreateamounttype.md) | :heavy_check_mark: | N/A | | `priceAmount` | *number* | :heavy_check_mark: | The price in cents. | | `priceCurrency` | *string* | :heavy_minus_sign: | The currency. Currently, only `usd` is supported. | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | The recurring interval of the price. | \ No newline at end of file +| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productpricerecurringfree.md b/docs/models/components/productpricerecurringfree.md index 8dc8e71e..b2dd7fa5 100644 --- a/docs/models/components/productpricerecurringfree.md +++ b/docs/models/components/productpricerecurringfree.md @@ -8,11 +8,11 @@ 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("2023-11-20T15:27:37.231Z"), - modifiedAt: new Date("2023-03-31T08:14:03.192Z"), + createdAt: new Date("2023-02-13T12:28:03.035Z"), + modifiedAt: new Date("2024-10-22T15:16:19.696Z"), id: "", isArchived: false, - recurringInterval: "year", + recurringInterval: "month", }; ``` @@ -26,4 +26,4 @@ let value: ProductPriceRecurringFree = { | `amountType` | [components.ProductPriceRecurringFreeAmountType](../../models/components/productpricerecurringfreeamounttype.md) | :heavy_check_mark: | N/A | | `isArchived` | *boolean* | :heavy_check_mark: | Whether the price is archived and no longer available. | | `type` | [components.ProductPriceRecurringFreeType](../../models/components/productpricerecurringfreetype.md) | :heavy_check_mark: | The type of the price. | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | The recurring interval of the price. | \ No newline at end of file +| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productpricerecurringfreecreate.md b/docs/models/components/productpricerecurringfreecreate.md index 7a26c5ea..64711f7a 100644 --- a/docs/models/components/productpricerecurringfreecreate.md +++ b/docs/models/components/productpricerecurringfreecreate.md @@ -8,7 +8,7 @@ Schema to create a free recurring product price, i.e. a subscription. import { ProductPriceRecurringFreeCreate } from "@polar-sh/sdk/models/components"; let value: ProductPriceRecurringFreeCreate = { - recurringInterval: "year", + recurringInterval: "month", }; ``` @@ -18,4 +18,4 @@ let value: ProductPriceRecurringFreeCreate = { | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `type` | [components.ProductPriceRecurringFreeCreateType](../../models/components/productpricerecurringfreecreatetype.md) | :heavy_check_mark: | N/A | | `amountType` | [components.ProductPriceRecurringFreeCreateAmountType](../../models/components/productpricerecurringfreecreateamounttype.md) | :heavy_check_mark: | N/A | -| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | The recurring interval of the price. | \ No newline at end of file +| `recurringInterval` | [components.SubscriptionRecurringInterval](../../models/components/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/productrecurringcreate.md b/docs/models/components/productrecurringcreate.md index c0a29107..55163edb 100644 --- a/docs/models/components/productrecurringcreate.md +++ b/docs/models/components/productrecurringcreate.md @@ -11,7 +11,7 @@ let value: ProductRecurringCreate = { name: "", prices: [ { - recurringInterval: "month", + recurringInterval: "year", }, ], }; diff --git a/docs/models/components/productrecurringcreateprices.md b/docs/models/components/productrecurringcreateprices.md index 99f93de4..1e519d2e 100644 --- a/docs/models/components/productrecurringcreateprices.md +++ b/docs/models/components/productrecurringcreateprices.md @@ -10,7 +10,7 @@ List of available prices for this product. ```typescript const value: components.ProductPriceRecurringFixedCreate[] = [ { - priceAmount: 879059, + priceAmount: 858165, recurringInterval: "year", }, ]; @@ -21,7 +21,7 @@ const value: components.ProductPriceRecurringFixedCreate[] = [ ```typescript const value: components.ProductPriceRecurringFreeCreate[] = [ { - recurringInterval: "year", + recurringInterval: "month", }, ]; ``` diff --git a/docs/models/components/productupdateprices.md b/docs/models/components/productupdateprices.md index 4a38013d..dcbecdb9 100644 --- a/docs/models/components/productupdateprices.md +++ b/docs/models/components/productupdateprices.md @@ -15,8 +15,8 @@ const value: components.ExistingProductPrice = { ```typescript const value: components.ProductPriceRecurringFixedCreate = { - priceAmount: 270667, - recurringInterval: "month", + priceAmount: 618782, + recurringInterval: "year", }; ``` @@ -32,7 +32,7 @@ const value: components.ProductPriceRecurringFreeCreate = { ```typescript const value: components.ProductPriceOneTimeFixedCreate = { - priceAmount: 108829, + priceAmount: 829708, }; ``` diff --git a/docs/models/components/reactions.md b/docs/models/components/reactions.md index 13e75bcf..74ec003f 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: 763730, - plusOne: 258996, - minusOne: 72968, - laugh: 210919, - hooray: 619566, - confused: 548887, - heart: 507825, - rocket: 73181, - eyes: 410869, + totalCount: 393166, + plusOne: 266880, + minusOne: 932097, + laugh: 411408, + hooray: 513405, + confused: 72222, + heart: 69151, + rocket: 758064, + eyes: 932006, }; ``` diff --git a/docs/models/components/repositoryinput.md b/docs/models/components/repositoryinput.md index 118440b1..52dc90df 100644 --- a/docs/models/components/repositoryinput.md +++ b/docs/models/components/repositoryinput.md @@ -6,26 +6,26 @@ import { RepositoryInput } from "@polar-sh/sdk/models/components"; let value: RepositoryInput = { - id: "7b541f6d-9a75-47ce-b78b-fad62b3e176d", + id: "ec13d0ba-7949-4b62-9ff1-05f63f3a1a24", isPrivate: false, name: "MyOrg", description: - "testify cod invite unhealthy athwart yowza reiterate till ick attest", + "along spotless clamour consequently jet untidy wherever veto considering", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "217db36b-ee86-4aaf-9787-b5084b2dc62d", + id: "40053a2e-f702-44ee-af42-856705b7cafb", name: "", - avatarUrl: "https://medium-anticodon.com/", + avatarUrl: "https://utilized-yin.org/", isPersonal: false, bio: "", prettyName: "", - company: "Kutch - Harber", + company: "Brown - Hickle", blog: "", location: "", - email: "Bernadine_Gusikowski@hotmail.com", + email: "Reyna.Muller@hotmail.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/repositoryoutput.md b/docs/models/components/repositoryoutput.md index 5367155f..c8ab4515 100644 --- a/docs/models/components/repositoryoutput.md +++ b/docs/models/components/repositoryoutput.md @@ -6,25 +6,25 @@ import { RepositoryOutput } from "@polar-sh/sdk/models/components"; let value: RepositoryOutput = { - id: "48b428d6-74c1-42fa-98cf-3c5bbf10b9bc", + id: "f0bf2b43-de5a-42ce-a5ae-0d968db87e31", isPrivate: false, name: "MyOrg", - description: "foolishly quantify phooey as opera", + description: "finer square vice indolent stir-fry psst custom vestment", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "407ee2d0-1f61-4700-8839-52f304445c05", + id: "842e5766-ceaf-439a-abc5-e24794e71df5", name: "", - avatarUrl: "https://corrupt-invite.info", + avatarUrl: "https://stiff-cinema.org", isPersonal: false, bio: "", prettyName: "", - company: "Goldner, Rippin and Balistreri", + company: "Barton, Mante and Barrows", blog: "", location: "", - email: "Aylin.Daniel64@hotmail.com", + email: "Lawrence.Walter@yahoo.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/repositorysortproperty.md b/docs/models/components/repositorysortproperty.md index c925a1bc..26975510 100644 --- a/docs/models/components/repositorysortproperty.md +++ b/docs/models/components/repositorysortproperty.md @@ -5,7 +5,7 @@ ```typescript import { RepositorySortProperty } from "@polar-sh/sdk/models/components"; -let value: RepositorySortProperty = "-created_at"; +let value: RepositorySortProperty = "stars"; ``` ## Values diff --git a/docs/models/components/s3downloadurl.md b/docs/models/components/s3downloadurl.md index fc0c07a3..af9c6626 100644 --- a/docs/models/components/s3downloadurl.md +++ b/docs/models/components/s3downloadurl.md @@ -6,8 +6,8 @@ import { S3DownloadURL } from "@polar-sh/sdk/models/components"; let value: S3DownloadURL = { - url: "https://far-jazz.biz/", - expiresAt: new Date("2023-04-01T13:49:57.045Z"), + url: "https://dearest-lox.info", + expiresAt: new Date("2022-08-17T05:07:46.724Z"), }; ``` diff --git a/docs/models/components/s3filecreatemultipart.md b/docs/models/components/s3filecreatemultipart.md index 704e4589..5b6da5a1 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: 199345, - chunkStart: 136514, - chunkEnd: 12738, + number: 937461, + chunkStart: 836546, + chunkEnd: 960693, }, ], }; diff --git a/docs/models/components/s3filecreatepart.md b/docs/models/components/s3filecreatepart.md index 3fc6a7ef..e22f1890 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: 619134, - chunkStart: 98946, - chunkEnd: 148389, + number: 115886, + chunkStart: 989474, + chunkEnd: 200301, }; ``` diff --git a/docs/models/components/s3fileuploadcompletedpart.md b/docs/models/components/s3fileuploadcompletedpart.md index 3292be63..90278c8c 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: 958248, + number: 386441, checksumEtag: "", checksumSha256Base64: "", }; diff --git a/docs/models/components/s3fileuploadmultipart.md b/docs/models/components/s3fileuploadmultipart.md index 9a6d06f2..833f322f 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: "/opt/sbin", + path: "/usr/bin", parts: [ { - number: 759464, - chunkStart: 151150, - chunkEnd: 171195, - url: "https://repentant-league.com", - expiresAt: new Date("2024-07-26T19:24:22.566Z"), + number: 906143, + chunkStart: 489096, + chunkEnd: 169341, + url: "https://paltry-maintainer.org/", + expiresAt: new Date("2023-10-12T05:54:19.987Z"), }, ], }; diff --git a/docs/models/components/s3fileuploadpart.md b/docs/models/components/s3fileuploadpart.md index fd7c63e3..e1744d01 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: 987398, - chunkStart: 667444, - chunkEnd: 933228, - url: "https://right-footrest.com", - expiresAt: new Date("2022-02-05T06:13:23.209Z"), + number: 256631, + chunkStart: 952587, + chunkEnd: 173926, + url: "https://unhappy-produce.name/", + expiresAt: new Date("2024-01-24T20:37:44.789Z"), }; ``` diff --git a/docs/models/components/subscription.md b/docs/models/components/subscription.md index 40703869..79534dad 100644 --- a/docs/models/components/subscription.md +++ b/docs/models/components/subscription.md @@ -6,18 +6,18 @@ import { Subscription } from "@polar-sh/sdk/models/components"; let value: Subscription = { - createdAt: new Date("2023-05-02T19:22:49.014Z"), - modifiedAt: new Date("2023-07-09T16:37:49.740Z"), + createdAt: new Date("2024-07-26T07:08:18.260Z"), + modifiedAt: new Date("2022-06-18T13:50:36.049Z"), id: "", - amount: 255953, - currency: "Jordanian Dinar", + amount: 925635, + currency: "Quetzal", recurringInterval: "year", - status: "incomplete_expired", - currentPeriodStart: new Date("2024-06-10T07:44:52.955Z"), - currentPeriodEnd: new Date("2022-01-14T18:47:42.652Z"), + status: "incomplete", + currentPeriodStart: new Date("2024-03-10T03:16:11.634Z"), + currentPeriodEnd: new Date("2022-08-23T07:02:23.610Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-06-06T12:10:53.022Z"), - endedAt: new Date("2024-10-11T03:06:32.161Z"), + startedAt: new Date("2024-10-01T14:41:12.462Z"), + endedAt: new Date("2023-12-27T07:38:47.221Z"), userId: "", productId: "", priceId: "", @@ -26,45 +26,40 @@ let value: Subscription = { "key": "", }, user: { - email: "Ambrose.Klocko@yahoo.com", + email: "Devin27@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://unfortunate-jury.com", + avatarUrl: "https://outrageous-sesame.com", }, product: { - createdAt: new Date("2022-05-05T10:54:03.342Z"), - modifiedAt: new Date("2023-04-02T19:35:39.049Z"), + createdAt: new Date("2024-01-07T16:35:45.521Z"), + modifiedAt: new Date("2022-12-22T06:28:58.898Z"), id: "", name: "", - description: "eek fine and stigmatize", + description: "oh aside toward outnumber steel woot ouch unaccountably", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-01-18T05:10:09.456Z"), - modifiedAt: new Date("2023-02-16T10:14:16.859Z"), + createdAt: new Date("2023-11-27T20:20:53.456Z"), + modifiedAt: new Date("2022-01-23T17:25:21.826Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 129469, - maximumAmount: 15406, - presetAmount: 386742, - recurringInterval: "year", + priceAmount: 534204, }, ], benefits: [ { - createdAt: new Date("2023-05-23T12:39:44.257Z"), - modifiedAt: new Date("2022-11-20T05:30:05.170Z"), + createdAt: new Date("2024-07-24T09:12:37.931Z"), + modifiedAt: new Date("2023-11-05T20:05:58.553Z"), id: "", - description: "pick creature with where that", + type: "custom", + description: "than athwart legging zowie pace exalt vanadyl bank", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -72,29 +67,31 @@ let value: Subscription = { id: "", organizationId: "", name: "", - path: "/usr/lib", + path: "/opt/sbin", mimeType: "", - size: 670961, + size: 924275, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-03-05T10:39:39.567Z"), + lastModifiedAt: new Date("2023-05-23T00:02:25.198Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-01T20:06:37.720Z"), + createdAt: new Date("2024-06-15T02:44:52.819Z"), sizeReadable: "", - publicUrl: "https://narrow-toothpick.net/", + publicUrl: "https://forsaken-receptor.name/", }, ], }, price: { - createdAt: new Date("2024-05-01T17:51:17.309Z"), - modifiedAt: new Date("2024-09-15T06:04:46.672Z"), + createdAt: new Date("2024-01-04T03:06:49.905Z"), + modifiedAt: new Date("2024-04-24T23:33:00.904Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 825389, + minimumAmount: 897509, + maximumAmount: 440355, + presetAmount: 642610, recurringInterval: "month", }, }; diff --git a/docs/models/components/subscriptioninput.md b/docs/models/components/subscriptioninput.md index b2b28ef7..874db8ec 100644 --- a/docs/models/components/subscriptioninput.md +++ b/docs/models/components/subscriptioninput.md @@ -6,18 +6,18 @@ import { SubscriptionInput } from "@polar-sh/sdk/models/components"; let value: SubscriptionInput = { - createdAt: new Date("2022-02-01T12:16:57.588Z"), - modifiedAt: new Date("2022-09-25T11:24:04.477Z"), + createdAt: new Date("2023-05-23T13:04:23.905Z"), + modifiedAt: new Date("2024-09-24T17:09:33.132Z"), id: "", - amount: 452831, - currency: "Venezuelan bolívar", + amount: 295960, + currency: "Vatu", recurringInterval: "year", - status: "unpaid", - currentPeriodStart: new Date("2023-10-14T01:17:52.314Z"), - currentPeriodEnd: new Date("2023-05-01T17:04:34.452Z"), + status: "past_due", + currentPeriodStart: new Date("2023-02-05T22:42:58.048Z"), + currentPeriodEnd: new Date("2024-11-14T18:55:07.158Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-12-27T03:00:57.232Z"), - endedAt: new Date("2024-11-29T05:19:54.648Z"), + startedAt: new Date("2023-04-17T22:55:39.869Z"), + endedAt: new Date("2023-11-27T06:53:44.342Z"), userId: "", productId: "", priceId: "", @@ -26,36 +26,35 @@ let value: SubscriptionInput = { "key": "", }, user: { - email: "Flossie_Schulist@yahoo.com", + email: "Luella_Streich38@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://roasted-ghost.com/", + avatarUrl: "https://pitiful-scarification.info/", }, product: { - createdAt: new Date("2024-03-06T18:10:07.671Z"), - modifiedAt: new Date("2022-05-22T17:17:29.962Z"), + createdAt: new Date("2024-09-30T13:32:34.699Z"), + modifiedAt: new Date("2022-05-18T14:05:23.081Z"), id: "", name: "", - description: "with pilot whenever discrete ha juvenile dispense crest yum", + description: "grown valuable rotating happily till since", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-03-12T13:26:41.356Z"), - modifiedAt: new Date("2023-04-23T09:01:31.581Z"), + createdAt: new Date("2022-05-16T00:21:03.093Z"), + modifiedAt: new Date("2023-03-11T21:00:22.844Z"), id: "", isArchived: false, - recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2024-10-22T16:13:49.873Z"), - modifiedAt: new Date("2023-07-03T20:33:44.163Z"), + createdAt: new Date("2023-11-28T18:36:35.061Z"), + modifiedAt: new Date("2024-08-30T21:15:41.084Z"), id: "", - type: "custom", - description: "conceal gadzooks sleepily ostrich at sit", + type: "github_repository", + description: "hence suffice thorny beyond presume gee", selectable: false, deletable: false, organizationId: "", @@ -66,30 +65,26 @@ let value: SubscriptionInput = { id: "", organizationId: "", name: "", - path: "/opt/lib", + path: "/opt/sbin", mimeType: "", - size: 372703, + size: 237924, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-01-09T01:33:23.856Z"), + lastModifiedAt: new Date("2022-04-17T23:17:03.220Z"), version: "", isUploaded: false, - createdAt: new Date("2023-05-02T01:12:09.041Z"), + createdAt: new Date("2024-06-02T09:00:38.951Z"), }, ], }, price: { - createdAt: new Date("2023-09-09T10:27:51.086Z"), - modifiedAt: new Date("2023-01-31T21:56:48.413Z"), + createdAt: new Date("2022-01-16T09:19:29.234Z"), + modifiedAt: new Date("2023-06-10T09:07:09.454Z"), id: "", isArchived: false, - priceCurrency: "", - minimumAmount: 753637, - maximumAmount: 758285, - presetAmount: 755041, - recurringInterval: "year", + recurringInterval: "month", }, }; ``` diff --git a/docs/models/components/subscriptionsortproperty.md b/docs/models/components/subscriptionsortproperty.md index 01ba76af..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 = "-status"; +let value: SubscriptionSortProperty = "started_at"; ``` ## Values diff --git a/docs/models/components/subscriptionuser.md b/docs/models/components/subscriptionuser.md index 4e59877f..77124479 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: "Tyrese29@hotmail.com", + email: "Terry.Robel@yahoo.com", publicName: "", githubUsername: "", - avatarUrl: "https://quixotic-guard.com", + avatarUrl: "https://repentant-straw.biz", }; ``` 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 92cfd4cb..dfedea20 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: 840873, + expiresIn: 121299, refreshToken: "", scope: "", idToken: "", diff --git a/docs/models/components/useradvertisementcampaign.md b/docs/models/components/useradvertisementcampaign.md index e819a50e..b0344ac6 100644 --- a/docs/models/components/useradvertisementcampaign.md +++ b/docs/models/components/useradvertisementcampaign.md @@ -6,16 +6,16 @@ import { UserAdvertisementCampaign } from "@polar-sh/sdk/models/components"; let value: UserAdvertisementCampaign = { - createdAt: new Date("2023-03-02T10:40:57.891Z"), - modifiedAt: new Date("2023-10-28T14:57:15.731Z"), + createdAt: new Date("2022-12-19T18:58:02.170Z"), + modifiedAt: new Date("2022-03-02T07:06:59.765Z"), id: "", userId: "", - views: 424364, - clicks: 655692, - imageUrl: "https://trim-bid.biz/", - imageUrlDark: "https://advanced-bowler.org/", + views: 325527, + clicks: 390583, + imageUrl: "https://electric-digit.biz/", + imageUrlDark: "https://courageous-rawhide.info/", text: "", - linkUrl: "https://short-polyester.com", + linkUrl: "https://paltry-confusion.com/", }; ``` diff --git a/docs/models/components/useradvertisementcampaigncreate.md b/docs/models/components/useradvertisementcampaigncreate.md index e1e438e1..5c8c0664 100644 --- a/docs/models/components/useradvertisementcampaigncreate.md +++ b/docs/models/components/useradvertisementcampaigncreate.md @@ -6,9 +6,9 @@ import { UserAdvertisementCampaignCreate } from "@polar-sh/sdk/models/components"; let value: UserAdvertisementCampaignCreate = { - imageUrl: "https://basic-angle.biz/", + imageUrl: "https://round-pants.com/", text: "", - linkUrl: "https://aggressive-developing.net/", + linkUrl: "https://great-platter.com", }; ``` diff --git a/docs/models/components/useradvertisementsortproperty.md b/docs/models/components/useradvertisementsortproperty.md index 3e411ac0..cd6612a1 100644 --- a/docs/models/components/useradvertisementsortproperty.md +++ b/docs/models/components/useradvertisementsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { UserAdvertisementSortProperty } from "@polar-sh/sdk/models/components"; -let value: UserAdvertisementSortProperty = "-created_at"; +let value: UserAdvertisementSortProperty = "created_at"; ``` ## Values diff --git a/docs/models/components/userbenefit.md b/docs/models/components/userbenefit.md index dec4885c..13530628 100644 --- a/docs/models/components/userbenefit.md +++ b/docs/models/components/userbenefit.md @@ -7,18 +7,18 @@ ```typescript const value: components.BenefitAdsSubscriber = { - createdAt: new Date("2023-12-22T15:24:11.981Z"), - modifiedAt: new Date("2022-08-05T20:49:45.334Z"), + createdAt: new Date("2024-11-16T13:14:05.219Z"), + modifiedAt: new Date("2022-08-16T10:24:53.845Z"), id: "", - description: "hmph reckon drat", + description: "ha scamper safe excitedly gee beneath since phony daintily", selectable: false, deletable: false, organizationId: "", properties: {}, grants: [ { - createdAt: new Date("2024-04-04T10:09:12.794Z"), - modifiedAt: new Date("2024-11-07T02:32:41.560Z"), + createdAt: new Date("2024-05-09T07:52:40.062Z"), + modifiedAt: new Date("2024-03-26T08:32:25.562Z"), id: "", isGranted: false, isRevoked: false, @@ -36,10 +36,10 @@ const value: components.BenefitAdsSubscriber = { ```typescript const value: components.BenefitArticlesSubscriber = { - createdAt: new Date("2024-06-14T11:52:00.847Z"), - modifiedAt: new Date("2024-10-17T07:28:48.905Z"), + createdAt: new Date("2024-11-25T21:11:55.739Z"), + modifiedAt: new Date("2024-08-16T19:51:12.559Z"), id: "", - description: "hmph flood doorpost qua recount serialize", + description: "gosh vision early apropos merrily minty above", selectable: false, deletable: false, organizationId: "", @@ -53,17 +53,17 @@ const value: components.BenefitArticlesSubscriber = { ```typescript const value: components.BenefitCustomSubscriber = { - createdAt: new Date("2023-12-12T17:18:42.085Z"), - modifiedAt: new Date("2024-11-20T12:56:24.282Z"), + createdAt: new Date("2022-06-09T20:12:21.697Z"), + modifiedAt: new Date("2023-10-20T19:15:03.918Z"), id: "", - description: "ouch whenever since", + description: "clonk scaly wherever pointless", selectable: false, deletable: false, organizationId: "", grants: [ { - createdAt: new Date("2022-12-15T13:28:07.414Z"), - modifiedAt: new Date("2022-06-18T10:02:41.068Z"), + createdAt: new Date("2024-08-31T01:35:36.933Z"), + modifiedAt: new Date("2024-02-08T13:51:36.415Z"), id: "", isGranted: false, isRevoked: false, @@ -83,11 +83,10 @@ const value: components.BenefitCustomSubscriber = { ```typescript const value: components.BenefitDiscordSubscriber = { - createdAt: new Date("2023-05-03T03:57:46.437Z"), - modifiedAt: new Date("2023-06-27T15:00:49.644Z"), + createdAt: new Date("2022-03-16T21:31:12.259Z"), + modifiedAt: new Date("2023-07-03T21:47:04.955Z"), id: "", - description: - "scamper vamoose from amid battle ew mummify airman however other", + description: "celsius along upward than acidly", selectable: false, deletable: false, organizationId: "", @@ -101,11 +100,10 @@ const value: components.BenefitDiscordSubscriber = { ```typescript const value: components.BenefitDownloadablesSubscriber = { - createdAt: new Date("2024-05-03T07:52:49.732Z"), - modifiedAt: new Date("2024-07-22T07:22:34.395Z"), + createdAt: new Date("2023-08-07T04:09:31.431Z"), + modifiedAt: new Date("2024-10-30T06:52:10.521Z"), id: "", - description: - "supposing gee unwritten afore readmit now versus yowza inconsequential", + description: "um mid bloom redound grounded about mature minority", selectable: false, deletable: false, organizationId: "", @@ -121,10 +119,10 @@ const value: components.BenefitDownloadablesSubscriber = { ```typescript const value: components.BenefitGitHubRepositorySubscriber = { - createdAt: new Date("2024-03-30T08:14:55.210Z"), - modifiedAt: new Date("2023-03-24T17:25:25.814Z"), + createdAt: new Date("2022-07-05T23:12:47.347Z"), + modifiedAt: new Date("2022-06-24T18:40:30.017Z"), id: "", - description: "considering hungrily than", + description: "for perfectly midwife loyalty descent and", selectable: false, deletable: false, organizationId: "", @@ -139,30 +137,30 @@ const value: components.BenefitGitHubRepositorySubscriber = { ```typescript const value: components.BenefitLicenseKeysSubscriber = { - createdAt: new Date("2023-12-30T11:42:32.904Z"), - modifiedAt: new Date("2024-12-08T03:20:01.695Z"), + createdAt: new Date("2024-10-20T01:37:25.539Z"), + modifiedAt: new Date("2022-10-05T03:04:06.241Z"), id: "", description: - "than wiggly apropos besmirch consequently outside enormously obvious past", + "concerning whereas healthily to indeed monasticism ugh and slide", selectable: false, deletable: false, organizationId: "", properties: { prefix: "", expires: { - ttl: 621428, - timeframe: "day", + ttl: 230774, + timeframe: "year", }, activations: { - limit: 646456, + limit: 708360, enableUserAdmin: false, }, - limitUsage: 141314, + limitUsage: 392759, }, grants: [ { - createdAt: new Date("2022-06-26T16:41:01.976Z"), - modifiedAt: new Date("2022-04-13T00:02:16.989Z"), + createdAt: new Date("2022-02-02T01:56:34.110Z"), + modifiedAt: new Date("2023-04-22T17:03:43.493Z"), id: "", isGranted: false, isRevoked: false, diff --git a/docs/models/components/userbenefitsortproperty.md b/docs/models/components/userbenefitsortproperty.md index 667e578b..ed8ed5a8 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 = "organization"; ``` ## Values diff --git a/docs/models/components/userorder.md b/docs/models/components/userorder.md index e3a5dbfc..226f26e6 100644 --- a/docs/models/components/userorder.md +++ b/docs/models/components/userorder.md @@ -6,43 +6,44 @@ import { UserOrder } from "@polar-sh/sdk/models/components"; let value: UserOrder = { - createdAt: new Date("2022-09-27T05:11:28.515Z"), - modifiedAt: new Date("2024-09-25T12:13:11.837Z"), + createdAt: new Date("2022-04-14T13:23:36.206Z"), + modifiedAt: new Date("2022-12-02T16:06:08.205Z"), id: "", - amount: 40155, - taxAmount: 752573, - currency: "North Korean Won", + amount: 836018, + taxAmount: 646181, + currency: "Cuban Peso", userId: "", productId: "", productPriceId: "", subscriptionId: "", product: { - createdAt: new Date("2024-07-04T15:55:26.085Z"), - modifiedAt: new Date("2023-05-26T04:08:34.395Z"), + createdAt: new Date("2022-06-26T08:34:16.566Z"), + modifiedAt: new Date("2024-09-18T07:34:26.865Z"), id: "", name: "", - description: "basket out and", + description: "whoever supposing however for suckle", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-01-12T01:11:19.363Z"), - modifiedAt: new Date("2022-11-01T22:35:54.505Z"), + createdAt: new Date("2023-07-19T00:42:36.357Z"), + modifiedAt: new Date("2022-05-31T22:42:51.636Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 406914, - maximumAmount: 192649, - presetAmount: 419683, + minimumAmount: 649070, + maximumAmount: 856035, + presetAmount: 93212, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2024-11-01T09:06:02.132Z"), - modifiedAt: new Date("2023-12-29T03:34:41.469Z"), + createdAt: new Date("2024-08-07T20:38:23.153Z"), + modifiedAt: new Date("2022-04-25T02:02:03.058Z"), id: "", - description: "ick backbone or tankful sans fairly than", + description: "however indeed flash far somber", selectable: false, deletable: false, organizationId: "", @@ -56,44 +57,44 @@ let value: UserOrder = { id: "", organizationId: "", name: "", - path: "/private/var", + path: "/opt", mimeType: "", - size: 773652, + size: 17747, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-07-16T02:15:17.887Z"), + lastModifiedAt: new Date("2023-12-22T15:24:11.981Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-04T18:06:39.289Z"), + createdAt: new Date("2022-08-05T20:49:45.334Z"), sizeReadable: "", - publicUrl: "https://pleasant-hyphenation.com", + publicUrl: "https://victorious-zen.biz/", }, ], }, productPrice: { - createdAt: new Date("2023-04-25T19:30:11.470Z"), - modifiedAt: new Date("2024-07-20T00:51:35.962Z"), + createdAt: new Date("2023-05-17T14:56:25.246Z"), + modifiedAt: new Date("2024-08-06T23:09:15.332Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 596802, + priceAmount: 701506, recurringInterval: "year", }, subscription: { - createdAt: new Date("2022-07-26T01:21:42.082Z"), - modifiedAt: new Date("2022-10-15T02:24:56.339Z"), + createdAt: new Date("2022-09-08T09:58:53.295Z"), + modifiedAt: new Date("2024-03-11T13:54:59.030Z"), id: "", - amount: 163132, - currency: "Tunisian Dinar", - recurringInterval: "month", - status: "active", - currentPeriodStart: new Date("2022-06-04T16:14:49.332Z"), - currentPeriodEnd: new Date("2022-05-16T21:24:15.280Z"), + amount: 918527, + currency: "Falkland Islands Pound", + recurringInterval: "year", + status: "trialing", + currentPeriodStart: new Date("2022-11-15T02:07:18.027Z"), + currentPeriodEnd: new Date("2024-11-28T16:58:32.600Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-01-16T22:49:58.030Z"), - endedAt: new Date("2022-12-29T01:36:34.090Z"), + startedAt: new Date("2023-01-18T02:26:54.532Z"), + endedAt: new Date("2022-04-29T04:52:40.857Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/userorderinvoice.md b/docs/models/components/userorderinvoice.md index ca8d62cb..0ef91f48 100644 --- a/docs/models/components/userorderinvoice.md +++ b/docs/models/components/userorderinvoice.md @@ -8,7 +8,7 @@ Order's invoice data. import { UserOrderInvoice } from "@polar-sh/sdk/models/components"; let value: UserOrderInvoice = { - url: "https://devoted-remark.com", + url: "https://quintessential-cauliflower.info/", }; ``` diff --git a/docs/models/components/userorderproduct.md b/docs/models/components/userorderproduct.md index 8f0f655e..fc2a5e19 100644 --- a/docs/models/components/userorderproduct.md +++ b/docs/models/components/userorderproduct.md @@ -6,32 +6,31 @@ import { UserOrderProduct } from "@polar-sh/sdk/models/components"; let value: UserOrderProduct = { - createdAt: new Date("2022-02-12T18:37:20.813Z"), - modifiedAt: new Date("2022-04-14T03:03:06.965Z"), + createdAt: new Date("2024-01-26T00:48:07.635Z"), + modifiedAt: new Date("2022-09-14T18:48:26.866Z"), id: "", name: "", - description: "gee supposing fooey snow pace illustrious whoa", + description: "generously ha tremendously likewise vanadyl broadly daily fess", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-09-17T17:07:40.230Z"), - modifiedAt: new Date("2024-07-23T11:23:06.312Z"), + createdAt: new Date("2022-10-13T13:26:42.286Z"), + modifiedAt: new Date("2023-09-06T16:51:24.096Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 909354, + priceAmount: 478216, }, ], benefits: [ { - createdAt: new Date("2023-11-25T09:09:38.900Z"), - modifiedAt: new Date("2022-07-12T19:51:48.720Z"), + createdAt: new Date("2022-06-20T17:47:05.715Z"), + modifiedAt: new Date("2023-07-08T02:12:48.329Z"), id: "", - type: "downloadables", - description: - "except entire queasily reasoning embody until barring per fen through", + type: "articles", + description: "inexperienced pike investigate whether and wonderful", selectable: false, deletable: false, organizationId: "", @@ -42,19 +41,19 @@ let value: UserOrderProduct = { id: "", organizationId: "", name: "", - path: "/etc/ppp", + path: "/usr/local/src", mimeType: "", - size: 797304, + size: 274844, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-11-20T20:44:10.098Z"), + lastModifiedAt: new Date("2024-05-14T18:13:50.638Z"), version: "", isUploaded: false, - createdAt: new Date("2023-07-21T15:47:00.097Z"), + createdAt: new Date("2024-01-30T03:46:18.998Z"), sizeReadable: "", - publicUrl: "https://cute-tomb.biz/", + publicUrl: "https://blushing-cutlet.net/", }, ], }; diff --git a/docs/models/components/userordersortproperty.md b/docs/models/components/userordersortproperty.md index 4b32e9ed..5e7a16cd 100644 --- a/docs/models/components/userordersortproperty.md +++ b/docs/models/components/userordersortproperty.md @@ -5,7 +5,7 @@ ```typescript import { UserOrderSortProperty } from "@polar-sh/sdk/models/components"; -let value: UserOrderSortProperty = "organization"; +let value: UserOrderSortProperty = "-organization"; ``` ## Values diff --git a/docs/models/components/userordersubscription.md b/docs/models/components/userordersubscription.md index d8fa1a03..e1a52962 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("2022-12-27T10:09:19.664Z"), - modifiedAt: new Date("2023-10-21T14:56:09.707Z"), + createdAt: new Date("2023-03-02T21:27:02.051Z"), + modifiedAt: new Date("2023-05-06T15:43:47.155Z"), id: "", - amount: 315990, - currency: "Saint Helena Pound", - recurringInterval: "month", - status: "trialing", - currentPeriodStart: new Date("2024-01-04T10:27:21.788Z"), - currentPeriodEnd: new Date("2023-10-23T19:31:34.443Z"), + amount: 752211, + currency: "CFA Franc BCEAO", + recurringInterval: "year", + status: "unpaid", + currentPeriodStart: new Date("2023-06-05T15:58:53.972Z"), + currentPeriodEnd: new Date("2024-02-28T08:54:10.839Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-05-11T23:44:19.772Z"), - endedAt: new Date("2023-04-27T15:54:38.748Z"), + startedAt: new Date("2022-12-05T17:14:25.023Z"), + endedAt: new Date("2022-03-18T06:25:09.489Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/usersubscription.md b/docs/models/components/usersubscription.md index 05af8466..d82971f5 100644 --- a/docs/models/components/usersubscription.md +++ b/docs/models/components/usersubscription.md @@ -6,50 +6,45 @@ import { UserSubscription } from "@polar-sh/sdk/models/components"; let value: UserSubscription = { - createdAt: new Date("2022-08-03T01:37:55.590Z"), - modifiedAt: new Date("2024-03-13T11:02:48.884Z"), + createdAt: new Date("2022-06-25T17:55:44.890Z"), + modifiedAt: new Date("2024-11-22T15:42:40.032Z"), id: "", - amount: 763825, - currency: "Moroccan Dirham", - recurringInterval: "year", - status: "incomplete_expired", - currentPeriodStart: new Date("2023-08-13T08:38:49.313Z"), - currentPeriodEnd: new Date("2024-09-07T00:05:40.883Z"), + amount: 451252, + currency: "Lesotho Loti", + recurringInterval: "month", + status: "active", + currentPeriodStart: new Date("2022-07-01T18:36:52.222Z"), + currentPeriodEnd: new Date("2022-01-12T03:47:46.867Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-02-11T18:00:04.831Z"), - endedAt: new Date("2024-06-03T08:01:18.999Z"), + startedAt: new Date("2022-09-18T17:04:06.742Z"), + endedAt: new Date("2023-03-18T21:26:22.971Z"), userId: "", productId: "", priceId: "", checkoutId: "", product: { - createdAt: new Date("2022-09-01T09:56:05.492Z"), - modifiedAt: new Date("2023-09-20T18:25:13.476Z"), + createdAt: new Date("2023-04-18T12:27:46.530Z"), + modifiedAt: new Date("2024-08-29T14:37:53.760Z"), id: "", name: "", - description: "beloved powerfully squeaky rim of", + description: "swine talkative meh even yum greedy boo happy", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-09-04T20:22:54.281Z"), - modifiedAt: new Date("2024-03-15T03:24:47.536Z"), + createdAt: new Date("2024-06-07T12:33:24.067Z"), + modifiedAt: new Date("2024-02-22T19:22:05.875Z"), id: "", isArchived: false, - priceCurrency: "", - minimumAmount: 115202, - maximumAmount: 665093, - presetAmount: 610703, - recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2022-11-30T15:26:27.741Z"), - modifiedAt: new Date("2023-01-25T14:14:38.916Z"), + createdAt: new Date("2024-01-08T21:27:35.981Z"), + modifiedAt: new Date("2022-04-06T05:17:56.944Z"), id: "", - description: "apud upward inside during", + description: "because weatherize airbrush happily short-term galoshes", selectable: false, deletable: false, organizationId: "", @@ -63,31 +58,28 @@ let value: UserSubscription = { id: "", organizationId: "", name: "", - path: "/usr/local/bin", + path: "/Network", mimeType: "", - size: 16303, + size: 515854, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-12-31T18:47:07.582Z"), + lastModifiedAt: new Date("2024-01-21T16:36:26.954Z"), version: "", isUploaded: false, - createdAt: new Date("2022-12-04T02:57:45.647Z"), + createdAt: new Date("2023-09-13T08:41:21.960Z"), sizeReadable: "", - publicUrl: "https://unlawful-anticodon.org", + publicUrl: "https://hurtful-stump.biz", }, ], }, price: { - createdAt: new Date("2024-11-14T20:01:26.789Z"), - modifiedAt: new Date("2022-05-21T14:21:31.794Z"), + createdAt: new Date("2023-01-03T21:31:22.687Z"), + modifiedAt: new Date("2024-01-03T07:08:19.179Z"), id: "", isArchived: false, - priceCurrency: "", - minimumAmount: 276643, - maximumAmount: 230052, - presetAmount: 468840, + recurringInterval: "month", }, }; ``` diff --git a/docs/models/components/usersubscriptionproduct.md b/docs/models/components/usersubscriptionproduct.md index 1d3b62db..73df5c0c 100644 --- a/docs/models/components/usersubscriptionproduct.md +++ b/docs/models/components/usersubscriptionproduct.md @@ -6,30 +6,34 @@ import { UserSubscriptionProduct } from "@polar-sh/sdk/models/components"; let value: UserSubscriptionProduct = { - createdAt: new Date("2023-09-19T09:47:10.778Z"), - modifiedAt: new Date("2022-12-29T18:51:15.843Z"), + createdAt: new Date("2024-04-30T17:28:03.068Z"), + modifiedAt: new Date("2024-09-27T19:30:45.650Z"), id: "", name: "", - description: "chiffonier mould atop drat", + description: "outsource frivolous coexist suddenly gee drat phew", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-01-08T18:45:06.828Z"), - modifiedAt: new Date("2022-03-12T08:18:21.576Z"), + createdAt: new Date("2023-09-13T13:08:24.678Z"), + modifiedAt: new Date("2024-02-20T13:19:29.819Z"), id: "", isArchived: false, - recurringInterval: "year", + priceCurrency: "", + minimumAmount: 94105, + maximumAmount: 377621, + presetAmount: 167089, }, ], benefits: [ { - createdAt: new Date("2024-10-05T14:29:25.570Z"), - modifiedAt: new Date("2022-06-18T11:45:58.503Z"), + createdAt: new Date("2022-08-09T02:28:54.372Z"), + modifiedAt: new Date("2023-07-06T15:23:23.139Z"), id: "", - type: "github_repository", - description: "phew since woot drat", + type: "custom", + description: + "for sedately over anenst hungrily mothball yowza after captain er", selectable: false, deletable: false, organizationId: "", @@ -40,19 +44,19 @@ let value: UserSubscriptionProduct = { id: "", organizationId: "", name: "", - path: "/usr/sbin", + path: "/usr/obj", mimeType: "", - size: 269391, + size: 248430, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-11-07T01:27:54.679Z"), + lastModifiedAt: new Date("2022-04-09T06:29:36.990Z"), version: "", isUploaded: false, - createdAt: new Date("2024-07-15T23:08:55.418Z"), + createdAt: new Date("2024-11-07T09:51:45.663Z"), sizeReadable: "", - publicUrl: "https://every-atrium.biz", + publicUrl: "https://hospitable-incandescence.com", }, ], }; diff --git a/docs/models/components/usersubscriptionproductbenefits.md b/docs/models/components/usersubscriptionproductbenefits.md index 4251fe3a..dc1891c4 100644 --- a/docs/models/components/usersubscriptionproductbenefits.md +++ b/docs/models/components/usersubscriptionproductbenefits.md @@ -7,11 +7,11 @@ ```typescript const value: components.BenefitBase = { - createdAt: new Date("2023-09-28T11:50:40.696Z"), - modifiedAt: new Date("2024-03-08T17:42:27.657Z"), + createdAt: new Date("2022-07-25T01:35:33.444Z"), + modifiedAt: new Date("2022-11-26T14:28:09.704Z"), id: "", - type: "custom", - description: "of husky truthfully extract allocation pish", + type: "license_keys", + description: "although psst superficial enthusiastically but jealously", selectable: false, deletable: false, organizationId: "", @@ -22,10 +22,10 @@ const value: components.BenefitBase = { ```typescript const value: components.BenefitArticles = { - createdAt: new Date("2024-09-11T21:27:25.626Z"), - modifiedAt: new Date("2023-08-01T22:57:03.783Z"), + createdAt: new Date("2022-08-11T14:00:17.759Z"), + modifiedAt: new Date("2024-02-28T15:41:38.993Z"), id: "", - description: "redound obnoxiously deeply amidst fen ick", + description: "hm thorn vague promise fisherman unethically onto indeed yum", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/usersubscriptionsortproperty.md b/docs/models/components/usersubscriptionsortproperty.md index e9789fe8..0d17ec66 100644 --- a/docs/models/components/usersubscriptionsortproperty.md +++ b/docs/models/components/usersubscriptionsortproperty.md @@ -5,7 +5,7 @@ ```typescript import { UserSubscriptionSortProperty } from "@polar-sh/sdk/models/components"; -let value: UserSubscriptionSortProperty = "-started_at"; +let value: UserSubscriptionSortProperty = "-organization"; ``` ## Values diff --git a/docs/models/components/validatedlicensekey.md b/docs/models/components/validatedlicensekey.md index b30dc06b..b6344b6c 100644 --- a/docs/models/components/validatedlicensekey.md +++ b/docs/models/components/validatedlicensekey.md @@ -9,16 +9,22 @@ let value: ValidatedLicenseKey = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Oswald_Kutch@gmail.com", + avatarUrl: "https://abandoned-swim.info/", + }, benefitId: "", key: "", displayKey: "", status: "disabled", - limitActivations: 229967, - usage: 381534, - limitUsage: 57182, - validations: 624181, - lastValidatedAt: new Date("2024-10-21T11:55:29.233Z"), - expiresAt: new Date("2023-03-11T05:34:07.493Z"), + limitActivations: 496307, + usage: 431108, + limitUsage: 295912, + validations: 81689, + lastValidatedAt: new Date("2022-12-06T10:12:28.995Z"), + expiresAt: new Date("2023-10-29T21:12:06.679Z"), }; ``` @@ -29,6 +35,7 @@ let value: ValidatedLicenseKey = { | `id` | *string* | :heavy_check_mark: | N/A | | `organizationId` | *string* | :heavy_check_mark: | N/A | | `userId` | *string* | :heavy_check_mark: | N/A | +| `user` | [components.LicenseKeyUser](../../models/components/licensekeyuser.md) | :heavy_check_mark: | N/A | | `benefitId` | *string* | :heavy_check_mark: | The benefit ID. | | `key` | *string* | :heavy_check_mark: | N/A | | `displayKey` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/components/webhookbenefitcreatedpayload.md b/docs/models/components/webhookbenefitcreatedpayload.md index 75eb88da..0f042b5b 100644 --- a/docs/models/components/webhookbenefitcreatedpayload.md +++ b/docs/models/components/webhookbenefitcreatedpayload.md @@ -11,14 +11,17 @@ import { WebhookBenefitCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookBenefitCreatedPayload = { data: { - createdAt: new Date("2023-09-05T11:02:41.111Z"), - modifiedAt: new Date("2023-11-06T00:23:38.763Z"), + createdAt: new Date("2024-05-09T20:55:16.513Z"), + modifiedAt: new Date("2022-02-23T20:30:51.266Z"), id: "", - description: "suspiciously phooey gah amongst", + description: "unto defensive rosin whose dishonor because wherever since", selectable: false, deletable: false, organizationId: "", - properties: {}, + properties: { + guildId: "", + roleId: "", + }, }, }; ``` @@ -28,4 +31,4 @@ let value: WebhookBenefitCreatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookBenefitCreatedPayloadType](../../models/components/webhookbenefitcreatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | *components.WebhookBenefitCreatedPayloadBenefit* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *components.BenefitInput* | :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 d0132b5a..1366ea54 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("2022-09-02T17:34:26.813Z"), - modifiedAt: new Date("2024-01-05T04:06:45.165Z"), + createdAt: new Date("2023-06-05T14:45:08.272Z"), + modifiedAt: new Date("2023-06-10T10:11:52.695Z"), id: "", isGranted: false, isRevoked: false, @@ -22,17 +22,14 @@ let value: WebhookBenefitGrantCreatedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2022-12-16T02:34:06.572Z"), - modifiedAt: new Date("2024-03-12T05:09:38.589Z"), + createdAt: new Date("2022-07-05T03:19:41.489Z"), + modifiedAt: new Date("2023-04-01T07:57:32.210Z"), id: "", - description: "ah whenever darn given pace", + description: "pace plus beyond yahoo incidentally profuse fun", selectable: false, deletable: false, organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, + properties: {}, }, }, }; diff --git a/docs/models/components/webhookbenefitgrantrevokedpayload.md b/docs/models/components/webhookbenefitgrantrevokedpayload.md index 717de0c5..77ce6e9c 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-03-13T09:26:03.260Z"), - modifiedAt: new Date("2024-05-23T10:01:33.368Z"), + createdAt: new Date("2023-02-19T22:48:10.683Z"), + modifiedAt: new Date("2022-01-22T04:05:57.848Z"), id: "", isGranted: false, isRevoked: false, @@ -22,10 +22,10 @@ let value: WebhookBenefitGrantRevokedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2023-10-18T17:39:42.400Z"), - modifiedAt: new Date("2024-07-06T11:14:34.931Z"), + createdAt: new Date("2022-07-02T07:43:41.839Z"), + modifiedAt: new Date("2024-06-20T23:42:15.718Z"), id: "", - description: "now even rundown forgo unless retention pish brr though", + description: "too fervently toward among hot rebel per oof so drat", selectable: false, deletable: false, organizationId: "", diff --git a/docs/models/components/webhookbenefitgrantupdatedpayload.md b/docs/models/components/webhookbenefitgrantupdatedpayload.md index 23e660f6..5b015fe1 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("2024-01-10T14:23:44.216Z"), - modifiedAt: new Date("2024-12-04T03:13:51.971Z"), + createdAt: new Date("2024-05-19T07:19:58.851Z"), + modifiedAt: new Date("2022-04-22T08:22:38.865Z"), id: "", isGranted: false, isRevoked: false, @@ -22,18 +22,15 @@ let value: WebhookBenefitGrantUpdatedPayload = { benefitId: "", properties: {}, benefit: { - createdAt: new Date("2023-04-27T16:23:16.148Z"), - modifiedAt: new Date("2024-03-24T19:56:47.262Z"), + createdAt: new Date("2022-07-04T19:51:44.949Z"), + modifiedAt: new Date("2024-04-24T16:46:58.230Z"), id: "", - description: "across following gee", + description: "before monthly daintily synergy", selectable: false, deletable: false, organizationId: "", properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "triage", + paidArticles: false, }, }, }, diff --git a/docs/models/components/webhookbenefitupdatedpayload.md b/docs/models/components/webhookbenefitupdatedpayload.md index 3e26e2d8..66865fcb 100644 --- a/docs/models/components/webhookbenefitupdatedpayload.md +++ b/docs/models/components/webhookbenefitupdatedpayload.md @@ -11,19 +11,17 @@ import { WebhookBenefitUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookBenefitUpdatedPayload = { data: { - createdAt: new Date("2022-04-16T16:44:01.041Z"), - modifiedAt: new Date("2024-03-09T22:22:29.868Z"), + createdAt: new Date("2024-07-07T23:20:26.961Z"), + modifiedAt: new Date("2024-06-04T06:03:49.709Z"), id: "", - description: "mostly cassava below", + description: "second-hand despite disarm bogus", selectable: false, deletable: false, organizationId: "", properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "triage", + note: "", }, + isTaxApplicable: false, }, }; ``` @@ -33,4 +31,4 @@ let value: WebhookBenefitUpdatedPayload = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `type` | [components.WebhookBenefitUpdatedPayloadType](../../models/components/webhookbenefitupdatedpayloadtype.md) | :heavy_check_mark: | N/A | -| `data` | *components.WebhookBenefitUpdatedPayloadBenefit* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *components.BenefitInput* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webhookbenefitupdatedpayloadbenefit.md b/docs/models/components/webhookbenefitupdatedpayloadbenefit.md deleted file mode 100644 index c694344e..00000000 --- a/docs/models/components/webhookbenefitupdatedpayloadbenefit.md +++ /dev/null @@ -1,141 +0,0 @@ -# WebhookBenefitUpdatedPayloadBenefit - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2023-10-05T18:49:29.270Z"), - modifiedAt: new Date("2022-08-03T12:20:45.785Z"), - id: "", - description: "anti aha insecure", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2022-09-27T02:40:17.105Z"), - modifiedAt: new Date("2023-08-09T23:08:17.211Z"), - id: "", - description: "aw coal authorized easily duh enraged proofread blah", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2022-05-15T08:58:24.746Z"), - modifiedAt: new Date("2023-09-23T02:19:05.190Z"), - id: "", - description: "trick home yet", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscordInput` - -```typescript -const value: components.BenefitDiscordInput = { - createdAt: new Date("2023-03-06T12:55:25.684Z"), - modifiedAt: new Date("2024-04-17T01:22:49.265Z"), - id: "", - description: "physically intently briefly tough reboot terribly astride next", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2023-09-29T03:10:30.785Z"), - modifiedAt: new Date("2024-07-04T11:41:05.814Z"), - id: "", - description: "insist ah meh provision lively dishonor off twine brr", - selectable: false, - deletable: false, - organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "pull", - }, -}; -``` - -### `components.BenefitDownloadables` - -```typescript -const value: components.BenefitDownloadables = { - createdAt: new Date("2022-03-07T05:39:05.938Z"), - modifiedAt: new Date("2023-12-25T08:53:12.327Z"), - id: "", - description: "stoop that form hospitable consequently", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2024-07-13T10:03:43.619Z"), - modifiedAt: new Date("2024-08-01T05:59:09.495Z"), - id: "", - description: "last extent embed antique at offset extremely", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 483090, - timeframe: "year", - }, - activations: { - limit: 100544, - enableUserAdmin: false, - }, - limitUsage: 518508, - }, -}; -``` - diff --git a/docs/models/components/webhookcheckoutcreatedpayload.md b/docs/models/components/webhookcheckoutcreatedpayload.md index eabbb4fb..c846d0ad 100644 --- a/docs/models/components/webhookcheckoutcreatedpayload.md +++ b/docs/models/components/webhookcheckoutcreatedpayload.md @@ -11,26 +11,26 @@ import { WebhookCheckoutCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookCheckoutCreatedPayload = { data: { - createdAt: new Date("2022-12-11T23:41:00.245Z"), - modifiedAt: new Date("2024-08-23T22:10:48.974Z"), + createdAt: new Date("2024-11-15T08:05:56.849Z"), + modifiedAt: new Date("2024-12-26T16:52:12.542Z"), id: "", - status: "expired", + status: "confirmed", clientSecret: "", - expiresAt: new Date("2024-06-20T13:02:49.294Z"), - successUrl: "https://weighty-avalanche.biz/", - amount: 24886, - taxAmount: 959355, - currency: "Australian Dollar", - totalAmount: 349003, + expiresAt: new Date("2022-09-21T21:39:25.434Z"), + successUrl: "https://shoddy-interior.biz", + amount: 822093, + taxAmount: 829115, + currency: "Kyat", + totalAmount: 601560, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Emory37@yahoo.com", + customerEmail: "Otha_Abbott@yahoo.com", customerIpAddress: "", customerBillingAddress: { - country: "Rwanda", + country: "Guatemala", }, customerTaxId: "", paymentProcessorMetadata: {}, diff --git a/docs/models/components/webhookcheckoutupdatedpayload.md b/docs/models/components/webhookcheckoutupdatedpayload.md index e6b42556..180f0c47 100644 --- a/docs/models/components/webhookcheckoutupdatedpayload.md +++ b/docs/models/components/webhookcheckoutupdatedpayload.md @@ -11,26 +11,26 @@ import { WebhookCheckoutUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookCheckoutUpdatedPayload = { data: { - createdAt: new Date("2024-05-23T09:25:40.012Z"), - modifiedAt: new Date("2024-12-28T07:19:49.051Z"), + createdAt: new Date("2024-09-03T23:43:39.465Z"), + modifiedAt: new Date("2023-01-09T01:39:56.054Z"), id: "", - status: "confirmed", + status: "succeeded", clientSecret: "", - expiresAt: new Date("2022-09-09T12:41:53.591Z"), - successUrl: "https://cavernous-haversack.org/", - amount: 390200, - taxAmount: 51733, - currency: "Congolese Franc", - totalAmount: 669678, + expiresAt: new Date("2022-05-26T00:10:38.237Z"), + successUrl: "https://natural-conservative.biz/", + amount: 245341, + taxAmount: 742797, + currency: "East Caribbean Dollar", + totalAmount: 127155, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Clotilde30@hotmail.com", + customerEmail: "Caitlyn.Batz@yahoo.com", customerIpAddress: "", customerBillingAddress: { - country: "Guinea", + country: "Heard Island and McDonald Islands", }, customerTaxId: "", paymentProcessorMetadata: {}, diff --git a/docs/models/components/webhookdonationcreatedpayload.md b/docs/models/components/webhookdonationcreatedpayload.md index 875cc8be..3059ea5f 100644 --- a/docs/models/components/webhookdonationcreatedpayload.md +++ b/docs/models/components/webhookdonationcreatedpayload.md @@ -11,46 +11,47 @@ import { WebhookDonationCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookDonationCreatedPayload = { data: { - createdAt: new Date("2024-08-01T23:51:21.213Z"), - modifiedAt: new Date("2022-05-16T19:43:37.122Z"), + createdAt: new Date("2024-04-22T05:43:29.394Z"), + modifiedAt: new Date("2024-03-11T02:46:48.262Z"), id: "", - amount: 294711, - currency: "Rupiah", + amount: 793049, + currency: "Dong", message: "", donor: { id: "", - publicName: "", - avatarUrl: "https://pointed-cow.biz/", + name: "", + avatarUrl: "https://square-knight.name", + isPersonal: false, }, - email: "Kassandra_Mertz40@yahoo.com", + email: "Adell.Ebert@yahoo.com", issue: { - id: "51b05e38-2fd5-4c93-b23a-fce3e1f2555b", - number: 570473, + id: "2f641822-b1b1-461f-9353-8e7b541f6d9a", + number: 327245, title: "", - state: "closed", - issueCreatedAt: new Date("2022-10-14T09:26:39.208Z"), + state: "open", + issueCreatedAt: new Date("2024-04-19T22:51:54.283Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "e96811e3-4878-4562-876f-29f1bd59153a", + id: "e78bfad6-2b3e-4176-adff-0fa46ee12065", isPrivate: false, name: "MyOrg", - description: "provided monstrous unnaturally when er fat", + description: "invite unhealthy athwart yowza", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "4ac0986c-5867-472c-8484-ddf5ed92bfd1", + id: "06c5dab8-92e6-47ae-9b77-40f14f9db021", name: "", - avatarUrl: "https://unwilling-puppet.org/", + avatarUrl: "https://secret-crocodile.info", isPersonal: false, bio: "", prettyName: "", - company: "Tillman and Sons", + company: "Tremblay, Von and Labadie", blog: "", location: "", - email: "Athena.Schultz60@yahoo.com", + email: "Macie.Wiza@yahoo.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/webhookordercreatedpayload.md b/docs/models/components/webhookordercreatedpayload.md index f1fbe0d5..ebfa365d 100644 --- a/docs/models/components/webhookordercreatedpayload.md +++ b/docs/models/components/webhookordercreatedpayload.md @@ -11,15 +11,16 @@ import { WebhookOrderCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookOrderCreatedPayload = { data: { - createdAt: new Date("2024-04-14T22:34:09.472Z"), - modifiedAt: new Date("2023-06-14T20:02:24.167Z"), + createdAt: new Date("2022-09-09T18:27:38.526Z"), + modifiedAt: new Date("2022-04-16T13:09:43.732Z"), id: "", metadata: { "key": "", }, - amount: 640270, - taxAmount: 926054, - currency: "Som", + amount: 571158, + taxAmount: 217338, + currency: "Bhutanese Ngultrum", + billingReason: "purchase", userId: "", productId: "", productPriceId: "", @@ -27,45 +28,47 @@ let value: WebhookOrderCreatedPayload = { checkoutId: "", user: { id: "", - email: "Claire92@yahoo.com", + email: "Macey_Olson86@gmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://natural-spirit.info", + avatarUrl: "https://unlawful-rationale.org/", }, product: { - createdAt: new Date("2023-02-18T02:26:35.615Z"), - modifiedAt: new Date("2024-02-09T18:13:23.683Z"), + createdAt: new Date("2023-03-01T00:50:01.666Z"), + modifiedAt: new Date("2023-07-01T22:01:44.842Z"), id: "", name: "", - description: "oh like um clonk", + description: + "navigate easily dulcimer impact annually amongst hence or tighten memorable", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2023-08-13T14:34:33.232Z"), - modifiedAt: new Date("2023-08-29T16:35:03.394Z"), + createdAt: new Date("2023-04-11T22:26:51.446Z"), + modifiedAt: new Date("2023-12-25T07:57:58.923Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 201848, + priceAmount: 863273, + recurringInterval: "month", }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2024-04-02T11:09:31.783Z"), - modifiedAt: new Date("2024-09-09T05:02:05.909Z"), + createdAt: new Date("2024-10-29T06:16:02.069Z"), + modifiedAt: new Date("2024-08-27T16:44:25.827Z"), id: "", - amount: 979068, - currency: "Netherlands Antillian Guilder", + amount: 873618, + currency: "New Zealand Dollar", recurringInterval: "month", - status: "unpaid", - currentPeriodStart: new Date("2022-02-25T08:29:39.215Z"), - currentPeriodEnd: new Date("2022-10-26T03:21:02.491Z"), + status: "canceled", + currentPeriodStart: new Date("2022-08-14T23:12:22.090Z"), + currentPeriodEnd: new Date("2022-11-17T08:26:15.219Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-08-08T14:15:09.120Z"), - endedAt: new Date("2024-03-22T06:08:43.995Z"), + startedAt: new Date("2022-07-09T06:31:28.422Z"), + endedAt: new Date("2024-12-29T18:54:48.908Z"), userId: "", productId: "", priceId: "", diff --git a/docs/models/components/webhookorganizationupdatedpayload.md b/docs/models/components/webhookorganizationupdatedpayload.md index 16a5d746..32e48d37 100644 --- a/docs/models/components/webhookorganizationupdatedpayload.md +++ b/docs/models/components/webhookorganizationupdatedpayload.md @@ -11,21 +11,21 @@ import { WebhookOrganizationUpdatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookOrganizationUpdatedPayload = { data: { - createdAt: new Date("2024-08-05T00:25:50.473Z"), - modifiedAt: new Date("2024-03-22T22:29:10.462Z"), + createdAt: new Date("2022-08-30T19:42:05.316Z"), + modifiedAt: new Date("2022-11-20T04:52:08.177Z"), id: "", name: "", slug: "", - avatarUrl: "https://fatherly-cornet.net/", + avatarUrl: "https://soggy-term.com/", bio: "", - company: "Corwin Group", + company: "Kulas, Cole and Mann", blog: "", location: "", - email: "Webster.Veum@gmail.com", + email: "Amara22@yahoo.com", twitterUsername: "", - pledgeMinimumAmount: 455498, + pledgeMinimumAmount: 267625, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 221139, + defaultUpfrontSplitToContributors: 915191, donationsEnabled: false, profileSettings: {}, featureSettings: {}, diff --git a/docs/models/components/webhookpledgecreatedpayload.md b/docs/models/components/webhookpledgecreatedpayload.md index 7706cf15..ac22fd43 100644 --- a/docs/models/components/webhookpledgecreatedpayload.md +++ b/docs/models/components/webhookpledgecreatedpayload.md @@ -11,42 +11,42 @@ import { WebhookPledgeCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookPledgeCreatedPayload = { data: { - createdAt: new Date("2022-12-16T22:37:33.668Z"), - modifiedAt: new Date("2022-02-26T04:32:55.349Z"), + createdAt: new Date("2024-02-18T20:22:17.576Z"), + modifiedAt: new Date("2023-04-04T10:21:32.909Z"), id: "", - amount: 170716, - currency: "Falkland Islands Pound", + amount: 363121, + currency: "Cuban Peso", state: "created", - type: "pay_directly", + type: "pay_on_completion", issue: { - id: "83dc6da9-1616-4037-b921-d19c2abb0a24", - number: 52231, + id: "5042c722-d887-4b81-b14f-18e1390e1039", + number: 479075, title: "", state: "closed", - issueCreatedAt: new Date("2023-08-28T03:29:22.689Z"), + issueCreatedAt: new Date("2023-05-01T14:47:06.099Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "0cd7ce9e-6ccb-4673-84a5-b95255a0da04", + id: "84bb8da7-d91c-4d0c-8fc6-b4a8a6267a4a", isPrivate: false, name: "MyOrg", description: - "convection unbearably supposing bleakly plumber marten dishonor", + "afterwards beside gah fatal waft supposing equally versus markup", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "4aaddc91-b4c5-429e-a244-c276c73173a3", + id: "8364acc6-3489-4cb2-9b1e-b1dab7969c3e", name: "", - avatarUrl: "https://unruly-testimonial.net", + avatarUrl: "https://prickly-lieu.biz/", isPersonal: false, bio: "", prettyName: "", - company: "Beier - Rolfson", + company: "Ratke Inc", blog: "", location: "", - email: "Blaze57@yahoo.com", + email: "Johnathon.Hane73@gmail.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/webhookpledgeupdatedpayload.md b/docs/models/components/webhookpledgeupdatedpayload.md index 32713024..c41c14d5 100644 --- a/docs/models/components/webhookpledgeupdatedpayload.md +++ b/docs/models/components/webhookpledgeupdatedpayload.md @@ -11,41 +11,42 @@ import { WebhookPledgeUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookPledgeUpdatedPayload = { data: { - createdAt: new Date("2022-07-06T20:36:46.094Z"), - modifiedAt: new Date("2022-12-20T03:37:12.994Z"), + createdAt: new Date("2024-03-06T08:55:14.766Z"), + modifiedAt: new Date("2022-04-29T02:51:23.335Z"), id: "", - amount: 44137, - currency: "Won", - state: "refunded", - type: "pay_on_completion", + amount: 501792, + currency: "US Dollar", + state: "pending", + type: "pay_upfront", issue: { - id: "21cb4afd-4208-47cc-b1f4-590b3e363a63", - number: 702945, + id: "b3e67b5f-4f6c-4c9c-9992-e285428d75e2", + number: 761411, title: "", - state: "open", - issueCreatedAt: new Date("2022-11-10T09:14:40.659Z"), + state: "closed", + issueCreatedAt: new Date("2024-10-13T20:20:07.426Z"), needsConfirmationSolved: false, funding: {}, repository: { - id: "d673d8a6-0400-4f17-9d63-6d0730c0682e", + id: "1832d513-6a9e-4564-b1f1-79b486116000", isPrivate: false, name: "MyOrg", - description: "consequently improbable quarterly testify", + description: + "basket given schedule geez yuck easily gah mythology tectonics delicious", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "cd64e544-e2d7-4494-9899-d9346ce0f729", + id: "7c7fb3ce-8f8c-453c-b345-95577057379d", name: "", - avatarUrl: "https://orderly-trench.info/", + avatarUrl: "https://comfortable-suv.info/", isPersonal: false, bio: "", prettyName: "", - company: "Osinski - Gleichner", + company: "Crooks, Grant and Littel", blog: "", location: "", - email: "Jasmin_Beatty14@hotmail.com", + email: "Kassandra_Russel25@yahoo.com", twitterUsername: "", organizationId: "", }, diff --git a/docs/models/components/webhookproductcreatedpayload.md b/docs/models/components/webhookproductcreatedpayload.md index 20fbaaa6..4a178c7a 100644 --- a/docs/models/components/webhookproductcreatedpayload.md +++ b/docs/models/components/webhookproductcreatedpayload.md @@ -11,34 +11,34 @@ import { WebhookProductCreatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookProductCreatedPayload = { data: { - createdAt: new Date("2024-11-19T12:36:32.087Z"), - modifiedAt: new Date("2023-05-27T00:12:10.957Z"), + createdAt: new Date("2022-12-28T14:16:16.603Z"), + modifiedAt: new Date("2024-10-04T14:30:45.103Z"), id: "", name: "", - description: "so loudly fully proper after nor", + description: "seldom kindheartedly smug furthermore", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2023-07-21T21:38:04.131Z"), - modifiedAt: new Date("2024-11-03T20:41:32.976Z"), + createdAt: new Date("2022-07-08T15:03:29.279Z"), + modifiedAt: new Date("2022-03-09T15:07:56.359Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 310389, - maximumAmount: 175010, - presetAmount: 907566, + minimumAmount: 933771, + maximumAmount: 148478, + presetAmount: 520049, + recurringInterval: "month", }, ], benefits: [ { - createdAt: new Date("2023-06-29T00:09:50.341Z"), - modifiedAt: new Date("2024-11-11T02:30:37.629Z"), + createdAt: new Date("2022-12-11T12:45:41.520Z"), + modifiedAt: new Date("2023-01-20T02:46:22.982Z"), id: "", - type: "articles", - description: - "pro stealthily liquid or schedule famously inside technician brr", + type: "discord", + description: "minus oh juicy oval reschedule drat when lovingly", selectable: false, deletable: false, organizationId: "", @@ -49,17 +49,17 @@ let value: WebhookProductCreatedPayload = { id: "", organizationId: "", name: "", - path: "/var/spool", + path: "/Network", mimeType: "", - size: 699519, + size: 783061, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-02-03T07:13:27.840Z"), + lastModifiedAt: new Date("2024-01-11T02:22:51.707Z"), version: "", isUploaded: false, - createdAt: new Date("2023-03-28T22:50:15.785Z"), + createdAt: new Date("2022-12-08T08:55:00.413Z"), }, ], }, diff --git a/docs/models/components/webhookproductupdatedpayload.md b/docs/models/components/webhookproductupdatedpayload.md index 99495dc2..9197c2ea 100644 --- a/docs/models/components/webhookproductupdatedpayload.md +++ b/docs/models/components/webhookproductupdatedpayload.md @@ -11,37 +11,33 @@ import { WebhookProductUpdatedPayload } from "@polar-sh/sdk/models/components"; let value: WebhookProductUpdatedPayload = { data: { - createdAt: new Date("2022-04-13T11:45:19.275Z"), - modifiedAt: new Date("2024-12-13T21:51:57.448Z"), + createdAt: new Date("2024-11-08T09:27:04.733Z"), + modifiedAt: new Date("2023-12-08T02:08:23.563Z"), id: "", name: "", - description: "promptly yippee soulful", + description: "or responsible pish round whoa past amendment entry twine", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-05-08T10:41:06.101Z"), - modifiedAt: new Date("2022-05-01T01:29:19.161Z"), + createdAt: new Date("2022-03-31T05:08:04.982Z"), + modifiedAt: new Date("2022-12-10T11:19:22.816Z"), id: "", isArchived: false, - priceCurrency: "", - priceAmount: 553863, + recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2024-10-26T12:43:46.379Z"), - modifiedAt: new Date("2024-09-14T17:53:29.108Z"), + createdAt: new Date("2022-03-03T22:35:13.208Z"), + modifiedAt: new Date("2024-03-25T14:19:00.405Z"), id: "", - description: - "possession characterization showboat likely usually outflank versus", + type: "discord", + description: "dally gym yahoo neat although an", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -49,17 +45,17 @@ let value: WebhookProductUpdatedPayload = { id: "", organizationId: "", name: "", - path: "/usr/local/src", + path: "/usr/ports", mimeType: "", - size: 70257, + size: 621066, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-09-13T07:02:39.035Z"), + lastModifiedAt: new Date("2023-01-22T04:38:29.238Z"), version: "", isUploaded: false, - createdAt: new Date("2023-02-05T06:03:44.421Z"), + createdAt: new Date("2024-07-27T11:49:44.190Z"), }, ], }, diff --git a/docs/models/components/webhooksubscriptionactivepayload.md b/docs/models/components/webhooksubscriptionactivepayload.md new file mode 100644 index 00000000..886375ff --- /dev/null +++ b/docs/models/components/webhooksubscriptionactivepayload.md @@ -0,0 +1,115 @@ +# WebhookSubscriptionActivePayload + +Sent when a subscription becomes active, +whether because it's a new paid subscription or because payment was recovered. + +**Discord & Slack support:** Full + +## Example Usage + +```typescript +import { WebhookSubscriptionActivePayload } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionActivePayload = { + data: { + createdAt: new Date("2022-03-15T09:25:01.845Z"), + modifiedAt: new Date("2023-05-17T22:14:01.048Z"), + id: "", + amount: 411009, + currency: "Kyat", + recurringInterval: "year", + status: "incomplete", + currentPeriodStart: new Date("2023-11-08T19:29:39.108Z"), + currentPeriodEnd: new Date("2022-05-25T23:19:35.845Z"), + cancelAtPeriodEnd: false, + startedAt: new Date("2023-04-19T06:24:50.359Z"), + endedAt: new Date("2024-09-04T23:51:10.342Z"), + userId: "", + productId: "", + priceId: "", + checkoutId: "", + metadata: { + "key": "", + }, + user: { + email: "Cordie.Beier@gmail.com", + publicName: "", + githubUsername: "", + avatarUrl: "https://sinful-traditionalism.info", + }, + product: { + createdAt: new Date("2023-11-20T01:54:46.683Z"), + modifiedAt: new Date("2022-03-07T20:02:10.765Z"), + id: "", + name: "", + description: "after over round despite consequently ew", + isRecurring: false, + isArchived: false, + organizationId: "", + prices: [ + { + createdAt: new Date("2022-04-28T23:30:02.301Z"), + modifiedAt: new Date("2024-11-16T05:43:50.992Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 678636, + maximumAmount: 953960, + presetAmount: 151023, + }, + ], + benefits: [ + { + createdAt: new Date("2023-04-07T00:08:29.443Z"), + modifiedAt: new Date("2024-10-15T22:27:51.866Z"), + id: "", + description: + "norm procrastinate under on ick lovingly paintwork versus", + selectable: false, + deletable: false, + organizationId: "", + properties: { + paidArticles: false, + }, + }, + ], + medias: [ + { + id: "", + organizationId: "", + name: "", + path: "/private/var", + mimeType: "", + size: 485972, + storageVersion: "", + checksumEtag: "", + checksumSha256Base64: "", + checksumSha256Hex: "", + lastModifiedAt: new Date("2023-01-15T17:02:16.943Z"), + version: "", + isUploaded: false, + createdAt: new Date("2023-11-28T02:55:43.193Z"), + }, + ], + }, + price: { + createdAt: new Date("2024-04-01T10:18:17.294Z"), + modifiedAt: new Date("2024-08-18T17:37:40.864Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 489731, + maximumAmount: 652552, + presetAmount: 295537, + recurringInterval: "year", + }, + }, +}; +``` + +## Fields + +| 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 diff --git a/docs/models/components/webhooksubscriptionactivepayloadtype.md b/docs/models/components/webhooksubscriptionactivepayloadtype.md new file mode 100644 index 00000000..9186713c --- /dev/null +++ b/docs/models/components/webhooksubscriptionactivepayloadtype.md @@ -0,0 +1,15 @@ +# WebhookSubscriptionActivePayloadType + +## Example Usage + +```typescript +import { WebhookSubscriptionActivePayloadType } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionActivePayloadType = "subscription.active"; +``` + +## Values + +```typescript +"subscription.active" +``` \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptioncanceledpayload.md b/docs/models/components/webhooksubscriptioncanceledpayload.md new file mode 100644 index 00000000..c08d3a1c --- /dev/null +++ b/docs/models/components/webhooksubscriptioncanceledpayload.md @@ -0,0 +1,114 @@ +# WebhookSubscriptionCanceledPayload + +Sent when a subscription is canceled by the user. +They might still have access until the end of the current period. + +**Discord & Slack support:** Full + +## Example Usage + +```typescript +import { WebhookSubscriptionCanceledPayload } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionCanceledPayload = { + data: { + createdAt: new Date("2023-11-28T05:20:13.228Z"), + modifiedAt: new Date("2023-07-16T02:59:18.334Z"), + id: "", + amount: 159846, + currency: "Rwanda Franc", + recurringInterval: "month", + status: "trialing", + currentPeriodStart: new Date("2024-07-22T07:00:34.163Z"), + currentPeriodEnd: new Date("2024-01-17T12:18:48.322Z"), + cancelAtPeriodEnd: false, + startedAt: new Date("2022-04-01T14:34:31.000Z"), + endedAt: new Date("2023-09-12T15:43:53.558Z"), + userId: "", + productId: "", + priceId: "", + checkoutId: "", + metadata: { + "key": "", + }, + user: { + email: "Lulu_Schulist99@gmail.com", + publicName: "", + githubUsername: "", + avatarUrl: "https://dependent-negotiation.info/", + }, + product: { + createdAt: new Date("2024-09-20T21:54:34.005Z"), + modifiedAt: new Date("2022-03-28T23:23:12.546Z"), + id: "", + name: "", + description: "utter hungrily gripper jut underneath reel why above hm", + isRecurring: false, + isArchived: false, + organizationId: "", + prices: [ + { + createdAt: new Date("2023-12-14T02:17:32.598Z"), + modifiedAt: new Date("2023-12-08T13:36:27.254Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 864630, + maximumAmount: 6773, + presetAmount: 27735, + recurringInterval: "year", + }, + ], + benefits: [ + { + createdAt: new Date("2024-12-21T15:53:12.734Z"), + modifiedAt: new Date("2023-01-27T20:37:43.594Z"), + id: "", + type: "ads", + description: + "prejudge oof awkwardly inasmuch wholly providence inside which along", + selectable: false, + deletable: false, + organizationId: "", + }, + ], + medias: [ + { + id: "", + organizationId: "", + name: "", + path: "/boot/defaults", + mimeType: "", + size: 616016, + storageVersion: "", + checksumEtag: "", + checksumSha256Base64: "", + checksumSha256Hex: "", + lastModifiedAt: new Date("2024-05-23T09:25:40.012Z"), + version: "", + isUploaded: false, + createdAt: new Date("2024-12-28T07:19:49.051Z"), + }, + ], + }, + price: { + createdAt: new Date("2022-09-09T12:41:53.591Z"), + modifiedAt: new Date("2023-03-20T23:08:02.167Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 106639, + maximumAmount: 413871, + presetAmount: 840168, + recurringInterval: "month", + }, + }, +}; +``` + +## Fields + +| 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 diff --git a/docs/models/components/webhooksubscriptioncanceledpayloadtype.md b/docs/models/components/webhooksubscriptioncanceledpayloadtype.md new file mode 100644 index 00000000..990d1bb2 --- /dev/null +++ b/docs/models/components/webhooksubscriptioncanceledpayloadtype.md @@ -0,0 +1,15 @@ +# WebhookSubscriptionCanceledPayloadType + +## Example Usage + +```typescript +import { WebhookSubscriptionCanceledPayloadType } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionCanceledPayloadType = "subscription.canceled"; +``` + +## Values + +```typescript +"subscription.canceled" +``` \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptioncreatedpayload.md b/docs/models/components/webhooksubscriptioncreatedpayload.md index 83fcc617..d87b0294 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("2022-09-07T22:47:45.911Z"), - modifiedAt: new Date("2022-11-26T04:15:12.658Z"), + createdAt: new Date("2022-07-30T15:08:11.357Z"), + modifiedAt: new Date("2024-02-08T00:33:07.789Z"), id: "", - amount: 194538, - currency: "Riel", - recurringInterval: "year", + amount: 462072, + currency: "Kwanza", + recurringInterval: "month", status: "unpaid", - currentPeriodStart: new Date("2024-04-24T17:55:23.603Z"), - currentPeriodEnd: new Date("2024-02-24T00:26:10.360Z"), + currentPeriodStart: new Date("2024-03-27T00:27:03.075Z"), + currentPeriodEnd: new Date("2023-08-22T10:14:28.976Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2023-09-20T15:30:19.147Z"), - endedAt: new Date("2022-12-27T02:58:25.134Z"), + startedAt: new Date("2022-08-18T13:45:43.796Z"), + endedAt: new Date("2022-01-07T23:11:30.811Z"), userId: "", productId: "", priceId: "", @@ -31,42 +31,45 @@ let value: WebhookSubscriptionCreatedPayload = { "key": "", }, user: { - email: "Destinee.Farrell@gmail.com", + email: "Elwin_DAmore@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://unconscious-cow.com/", + avatarUrl: "https://unique-platypus.org", }, product: { - createdAt: new Date("2022-03-25T07:10:48.505Z"), - modifiedAt: new Date("2024-10-10T15:31:17.507Z"), + createdAt: new Date("2022-09-08T22:35:25.287Z"), + modifiedAt: new Date("2022-01-22T11:37:01.698Z"), id: "", name: "", - description: "good-natured furthermore incidentally pacemaker", + description: + "busy quarrelsomely wry zowie inasmuch politely covenant precious mozzarella cricket", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-05-20T04:35:09.735Z"), - modifiedAt: new Date("2024-05-14T06:50:38.439Z"), + createdAt: new Date("2022-03-24T22:50:12.488Z"), + modifiedAt: new Date("2022-12-10T20:01:46.580Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 774664, - maximumAmount: 404610, - presetAmount: 539394, + minimumAmount: 982685, + maximumAmount: 613334, + presetAmount: 419747, }, ], benefits: [ { - createdAt: new Date("2022-09-03T18:31:34.012Z"), - modifiedAt: new Date("2024-04-16T03:53:33.652Z"), + createdAt: new Date("2023-01-31T23:13:50.155Z"), + modifiedAt: new Date("2024-03-29T20:55:19.511Z"), id: "", - type: "downloadables", - description: "aggravating blah minor fishery really even yum moral", + description: "especially bestride how exacerbate", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -74,27 +77,29 @@ let value: WebhookSubscriptionCreatedPayload = { id: "", organizationId: "", name: "", - path: "/srv", + path: "/boot", mimeType: "", - size: 139067, + size: 72285, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-09-18T15:00:06.389Z"), + lastModifiedAt: new Date("2022-07-07T13:31:28.655Z"), version: "", isUploaded: false, - createdAt: new Date("2022-10-13T13:49:23.922Z"), + createdAt: new Date("2023-11-27T00:51:00.470Z"), }, ], }, price: { - createdAt: new Date("2023-04-21T12:43:04.324Z"), - modifiedAt: new Date("2023-12-18T11:55:53.035Z"), + createdAt: new Date("2024-10-02T08:39:37.015Z"), + modifiedAt: new Date("2024-05-19T10:16:04.212Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 617330, + minimumAmount: 320837, + maximumAmount: 986116, + presetAmount: 666499, recurringInterval: "month", }, }, diff --git a/docs/models/components/webhooksubscriptionrevokedpayload.md b/docs/models/components/webhooksubscriptionrevokedpayload.md new file mode 100644 index 00000000..f8a0157a --- /dev/null +++ b/docs/models/components/webhooksubscriptionrevokedpayload.md @@ -0,0 +1,115 @@ +# WebhookSubscriptionRevokedPayload + +Sent when a subscription is revoked, the user looses access immediately. +Happens when the subscription is canceled, or payment is past due. + +**Discord & Slack support:** Full + +## Example Usage + +```typescript +import { WebhookSubscriptionRevokedPayload } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionRevokedPayload = { + data: { + createdAt: new Date("2022-02-26T16:47:59.921Z"), + modifiedAt: new Date("2022-07-01T20:08:02.445Z"), + id: "", + amount: 669678, + currency: "Guarani", + recurringInterval: "month", + status: "canceled", + currentPeriodStart: new Date("2022-11-04T19:37:35.548Z"), + currentPeriodEnd: new Date("2023-09-02T01:32:00.618Z"), + cancelAtPeriodEnd: false, + startedAt: new Date("2022-12-04T05:53:21.167Z"), + endedAt: new Date("2024-01-30T15:45:00.257Z"), + userId: "", + productId: "", + priceId: "", + checkoutId: "", + metadata: { + "key": "", + }, + user: { + email: "Nolan_Nikolaus@yahoo.com", + publicName: "", + githubUsername: "", + avatarUrl: "https://round-custody.net/", + }, + product: { + createdAt: new Date("2024-10-08T19:25:01.027Z"), + modifiedAt: new Date("2024-10-28T15:58:42.928Z"), + id: "", + name: "", + description: "bliss oddly orderly awful mmm within what rust deduction", + isRecurring: false, + isArchived: false, + organizationId: "", + prices: [ + { + createdAt: new Date("2023-02-22T06:19:27.101Z"), + modifiedAt: new Date("2023-01-05T09:40:40.960Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 881238, + maximumAmount: 202737, + presetAmount: 163653, + recurringInterval: "month", + }, + ], + benefits: [ + { + createdAt: new Date("2022-08-02T00:05:06.700Z"), + modifiedAt: new Date("2023-09-20T04:56:13.484Z"), + id: "", + description: "punctually sheepishly graffiti minus furthermore", + selectable: false, + deletable: false, + organizationId: "", + properties: { + paidArticles: false, + }, + }, + ], + medias: [ + { + id: "", + organizationId: "", + name: "", + path: "/usr/libdata", + mimeType: "", + size: 744435, + storageVersion: "", + checksumEtag: "", + checksumSha256Base64: "", + checksumSha256Hex: "", + lastModifiedAt: new Date("2023-12-11T04:09:29.451Z"), + version: "", + isUploaded: false, + createdAt: new Date("2023-05-15T09:10:02.869Z"), + }, + ], + }, + price: { + createdAt: new Date("2022-11-24T02:16:01.160Z"), + modifiedAt: new Date("2022-10-19T05:37:10.667Z"), + id: "", + isArchived: false, + priceCurrency: "", + minimumAmount: 848972, + maximumAmount: 859375, + presetAmount: 15344, + recurringInterval: "year", + }, + }, +}; +``` + +## Fields + +| 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 diff --git a/docs/models/components/webhooksubscriptionrevokedpayloadtype.md b/docs/models/components/webhooksubscriptionrevokedpayloadtype.md new file mode 100644 index 00000000..49ff0aa5 --- /dev/null +++ b/docs/models/components/webhooksubscriptionrevokedpayloadtype.md @@ -0,0 +1,15 @@ +# WebhookSubscriptionRevokedPayloadType + +## Example Usage + +```typescript +import { WebhookSubscriptionRevokedPayloadType } from "@polar-sh/sdk/models/components"; + +let value: WebhookSubscriptionRevokedPayloadType = "subscription.revoked"; +``` + +## Values + +```typescript +"subscription.revoked" +``` \ No newline at end of file diff --git a/docs/models/components/webhooksubscriptionupdatedpayload.md b/docs/models/components/webhooksubscriptionupdatedpayload.md index 23adc8cb..b5639988 100644 --- a/docs/models/components/webhooksubscriptionupdatedpayload.md +++ b/docs/models/components/webhooksubscriptionupdatedpayload.md @@ -1,8 +1,12 @@ # WebhookSubscriptionUpdatedPayload -Sent when a new subscription is updated. This event fires if the subscription is cancelled, both immediately and if the subscription is cancelled at the end of the current period. +Sent when a subscription is updated. This event fires for all changes to the subscription, including renewals. -**Discord & Slack support:** On cancellation +If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, and `subscription.revoked`. + +To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field. + +**Discord & Slack support:** On cancellation and revocation. Renewals are skipped. ## Example Usage @@ -11,18 +15,18 @@ import { WebhookSubscriptionUpdatedPayload } from "@polar-sh/sdk/models/componen let value: WebhookSubscriptionUpdatedPayload = { data: { - createdAt: new Date("2023-04-07T11:06:58.417Z"), - modifiedAt: new Date("2023-06-08T05:46:10.028Z"), + createdAt: new Date("2022-07-20T20:45:13.442Z"), + modifiedAt: new Date("2024-02-27T23:14:03.443Z"), id: "", - amount: 677862, - currency: "Falkland Islands Pound", - recurringInterval: "year", - status: "incomplete_expired", - currentPeriodStart: new Date("2024-04-18T08:09:28.288Z"), - currentPeriodEnd: new Date("2024-03-02T10:25:24.644Z"), + amount: 7866, + currency: "Malagasy Ariary", + recurringInterval: "month", + status: "canceled", + currentPeriodStart: new Date("2024-11-10T12:13:29.060Z"), + currentPeriodEnd: new Date("2022-02-17T11:30:13.324Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2022-05-10T01:15:05.305Z"), - endedAt: new Date("2023-10-12T13:11:40.528Z"), + startedAt: new Date("2022-04-23T23:31:32.791Z"), + endedAt: new Date("2023-07-20T02:09:27.293Z"), userId: "", productId: "", priceId: "", @@ -31,37 +35,40 @@ let value: WebhookSubscriptionUpdatedPayload = { "key": "", }, user: { - email: "Vladimir_Aufderhar@gmail.com", + email: "Hannah17@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://tired-tabletop.biz", + avatarUrl: "https://strange-encouragement.name", }, product: { - createdAt: new Date("2023-01-28T02:30:44.160Z"), - modifiedAt: new Date("2024-12-04T00:32:06.141Z"), + createdAt: new Date("2022-08-18T00:27:45.134Z"), + modifiedAt: new Date("2024-07-25T15:30:25.665Z"), id: "", name: "", - description: "hubris ack attribute underneath taxicab quirkily", + description: "exasperation why blah per", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2022-01-22T13:47:16.368Z"), - modifiedAt: new Date("2023-09-01T01:11:59.221Z"), + createdAt: new Date("2024-09-22T14:10:48.963Z"), + modifiedAt: new Date("2023-10-07T14:09:54.362Z"), id: "", isArchived: false, - recurringInterval: "year", + priceCurrency: "", + minimumAmount: 137209, + maximumAmount: 164967, + presetAmount: 921974, }, ], benefits: [ { - createdAt: new Date("2023-04-15T05:58:11.260Z"), - modifiedAt: new Date("2022-11-22T09:26:52.208Z"), + createdAt: new Date("2022-06-01T03:41:33.937Z"), + modifiedAt: new Date("2023-12-17T19:30:08.420Z"), id: "", - type: "github_repository", + type: "articles", description: - "seal cannon since or emphasise toward shrill closely republican", + "rapidly and loyalty oh outside made-up underneath husband tenderly", selectable: false, deletable: false, organizationId: "", @@ -72,26 +79,26 @@ let value: WebhookSubscriptionUpdatedPayload = { id: "", organizationId: "", name: "", - path: "/lost+found", + path: "/Applications", mimeType: "", - size: 276285, + size: 115028, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-08-17T18:33:35.647Z"), + lastModifiedAt: new Date("2023-02-08T16:54:04.413Z"), version: "", isUploaded: false, - createdAt: new Date("2022-04-24T07:30:00.599Z"), + createdAt: new Date("2023-03-12T19:58:30.016Z"), }, ], }, price: { - createdAt: new Date("2024-02-07T22:48:59.434Z"), - modifiedAt: new Date("2023-02-25T00:02:22.663Z"), + createdAt: new Date("2023-07-13T17:19:07.810Z"), + modifiedAt: new Date("2024-10-03T02:08:20.774Z"), id: "", isArchived: false, - recurringInterval: "year", + recurringInterval: "month", }, }, }; diff --git a/docs/models/operations/advertisementslistresponse.md b/docs/models/operations/advertisementslistresponse.md index 729f0a85..ee216287 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-04-28T20:28:23.222Z"), - modifiedAt: new Date("2022-06-04T11:44:43.665Z"), + createdAt: new Date("2022-05-21T07:27:39.514Z"), + modifiedAt: new Date("2023-10-02T04:18:15.215Z"), id: "", - imageUrl: "https://total-ocelot.com", - imageUrlDark: "https://unwilling-lieu.info", + imageUrl: "https://disloyal-vanadyl.biz/", + imageUrlDark: "https://flowery-understanding.net", text: "", - linkUrl: "https://slimy-swordfish.com/", + linkUrl: "https://squiggly-cafe.info/", }, ], pagination: { - totalCount: 758985, - maxPage: 17060, + totalCount: 221218, + maxPage: 683727, }, dimensions: [ - 967055, + 102446, ], }, }; diff --git a/docs/models/operations/articlesexportrequest.md b/docs/models/operations/articlesexportrequest.md new file mode 100644 index 00000000..78da867e --- /dev/null +++ b/docs/models/operations/articlesexportrequest.md @@ -0,0 +1,17 @@ +# ArticlesExportRequest + +## Example Usage + +```typescript +import { ArticlesExportRequest } from "@polar-sh/sdk/models/operations"; + +let value: ArticlesExportRequest = { + organizationId: "51ce1c0f-984e-44df-ac81-7736527480ed", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `organizationId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/articleslistresponse.md b/docs/models/operations/articleslistresponse.md index 7e2c6633..15ff8f58 100644 --- a/docs/models/operations/articleslistresponse.md +++ b/docs/models/operations/articleslistresponse.md @@ -15,46 +15,46 @@ let value: ArticlesListResponse = { body: "", byline: { name: "", - avatarUrl: "https://powerful-railway.com/", + avatarUrl: "https://squiggly-provider.name/", }, - visibility: "hidden", + visibility: "private", userId: "", organizationId: "", organization: { - createdAt: new Date("2023-12-16T17:29:07.234Z"), - modifiedAt: new Date("2024-07-24T03:46:55.765Z"), + createdAt: new Date("2023-04-04T19:49:26.614Z"), + modifiedAt: new Date("2022-01-06T19:40:31.772Z"), id: "", name: "", slug: "", - avatarUrl: "https://willing-doing.com/", + avatarUrl: "https://merry-blight.com/", bio: "", - company: "Gerhold and Sons", + company: "Stokes, Corwin and Abbott", blog: "", location: "", - email: "Elton_Rau@gmail.com", + email: "Dudley26@hotmail.com", twitterUsername: "", - pledgeMinimumAmount: 5310, + pledgeMinimumAmount: 639463, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 11355, + defaultUpfrontSplitToContributors: 520678, donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, - publishedAt: new Date("2023-07-15T07:10:40.441Z"), + publishedAt: new Date("2023-03-13T02:51:04.481Z"), paidSubscribersOnly: false, - paidSubscribersOnlyEndsAt: new Date("2022-04-02T06:53:09.349Z"), + paidSubscribersOnlyEndsAt: new Date("2024-04-28T20:28:23.222Z"), isPreview: false, isPinned: false, notifySubscribers: false, - notificationsSentAt: new Date("2022-02-25T23:29:21.949Z"), - emailSentToCount: 965517, - ogImageUrl: "https://crooked-cd.org", + notificationsSentAt: new Date("2022-06-04T11:44:43.665Z"), + emailSentToCount: 967338, + ogImageUrl: "https://pointless-appliance.net", ogDescription: "", }, ], pagination: { - totalCount: 278325, - maxPage: 185897, + totalCount: 913285, + maxPage: 524577, }, }, }; diff --git a/docs/models/operations/articlespreviewrequest.md b/docs/models/operations/articlespreviewrequest.md index 6a22d489..b4dc078b 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: "Bernardo_Wolf@hotmail.com", + email: "Vilma_Murray@hotmail.com", }, }; ``` diff --git a/docs/models/operations/articlevisibilityfilter.md b/docs/models/operations/articlevisibilityfilter.md index 299f3396..fbb77cb9 100644 --- a/docs/models/operations/articlevisibilityfilter.md +++ b/docs/models/operations/articlevisibilityfilter.md @@ -8,7 +8,7 @@ Filter by visibility. ### `components.ArticleVisibility` ```typescript -const value: components.ArticleVisibility = "hidden"; +const value: components.ArticleVisibility = "private"; ``` ### `components.ArticleVisibility[]` diff --git a/docs/models/operations/benefitscreatebenefitcreate.md b/docs/models/operations/benefitscreatebenefitcreate.md index de284921..1b45743e 100644 --- a/docs/models/operations/benefitscreatebenefitcreate.md +++ b/docs/models/operations/benefitscreatebenefitcreate.md @@ -7,7 +7,7 @@ ```typescript const value: components.BenefitCustomCreate = { - description: "tenderly huzzah shanghai ruddy gadzooks tricky realistic", + description: "once worth yippee", isTaxApplicable: false, properties: {}, }; @@ -17,7 +17,7 @@ const value: components.BenefitCustomCreate = { ```typescript const value: components.BenefitAdsCreate = { - description: "purse thoughtfully sternly hence amid", + description: "aha shark nimble duh", properties: {}, }; ``` @@ -26,7 +26,8 @@ const value: components.BenefitAdsCreate = { ```typescript const value: components.BenefitDiscordCreate = { - description: "duster laughter pastel solidly upwardly", + description: + "total materialise lined brr airmail if while unless after vainly", properties: { guildToken: "", roleId: "", @@ -38,7 +39,7 @@ const value: components.BenefitDiscordCreate = { ```typescript const value: components.BenefitGitHubRepositoryCreate = { - description: "than boo yum huzzah outside availability sorrowful towards", + description: "moral rowdy ah speedily showy", properties: { repositoryOwner: "polarsource", repositoryName: "private_repo", @@ -51,7 +52,7 @@ const value: components.BenefitGitHubRepositoryCreate = { ```typescript const value: components.BenefitDownloadablesCreate = { - description: "pick obediently kissingly", + description: "curiously alliance boo political equally", properties: { files: [ "", @@ -64,7 +65,7 @@ const value: components.BenefitDownloadablesCreate = { ```typescript const value: components.BenefitLicenseKeysCreate = { - description: "boggle often ornery needily in massage unhappy zowie", + description: "fooey among entwine capsize unfinished boo", properties: {}, }; ``` diff --git a/docs/models/operations/benefitscreateresponsebenefitscreate.md b/docs/models/operations/benefitscreateresponsebenefitscreate.md deleted file mode 100644 index c65f5180..00000000 --- a/docs/models/operations/benefitscreateresponsebenefitscreate.md +++ /dev/null @@ -1,147 +0,0 @@ -# BenefitsCreateResponseBenefitsCreate - -Benefit created. - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2022-05-10T17:03:48.644Z"), - modifiedAt: new Date("2022-01-28T14:36:19.330Z"), - id: "", - description: - "across clamour wealthy for presume times mysterious soggy onto until", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2024-06-29T04:50:59.216Z"), - modifiedAt: new Date("2022-03-05T11:14:44.230Z"), - id: "", - description: "glow amused geez oval per", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2024-05-15T16:43:38.676Z"), - modifiedAt: new Date("2022-12-14T17:12:44.022Z"), - id: "", - description: - "criminal blink mortally so continually rebuke circa anticodon self-reliant yowza", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscord` - -```typescript -const value: components.BenefitDiscord = { - createdAt: new Date("2024-03-22T10:05:33.577Z"), - modifiedAt: new Date("2024-06-18T19:59:01.294Z"), - id: "", - description: "amongst peony despite energetically quixotic", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - guildToken: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2024-07-15T12:28:05.877Z"), - modifiedAt: new Date("2024-05-02T17:32:01.787Z"), - id: "", - description: "brief where daintily role infatuated", - 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-02T02:23:36.593Z"), - modifiedAt: new Date("2022-04-12T18:21:29.910Z"), - id: "", - description: "pleasing about whack orient", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2023-04-06T13:49:22.596Z"), - modifiedAt: new Date("2024-03-09T09:46:45.083Z"), - id: "", - description: - "furthermore conceal er anti browse develop freely summarise pick than", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 528742, - timeframe: "month", - }, - activations: { - limit: 759451, - enableUserAdmin: false, - }, - limitUsage: 178201, - }, -}; -``` - diff --git a/docs/models/operations/benefitsgetresponsebenefitsget.md b/docs/models/operations/benefitsgetresponsebenefitsget.md deleted file mode 100644 index f472b81d..00000000 --- a/docs/models/operations/benefitsgetresponsebenefitsget.md +++ /dev/null @@ -1,146 +0,0 @@ -# BenefitsGetResponseBenefitsGet - -Successful Response - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2022-07-07T14:30:34.396Z"), - modifiedAt: new Date("2023-04-19T07:11:20.698Z"), - id: "", - description: "speedily out snow fencing vice", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2024-11-16T06:34:46.551Z"), - modifiedAt: new Date("2024-06-22T09:30:18.789Z"), - id: "", - description: "daintily now nephew equally cleverly of for", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2023-01-16T19:34:44.796Z"), - modifiedAt: new Date("2023-05-13T18:21:47.587Z"), - id: "", - description: - "except fax hence optimistically militate rusty so after awkwardly", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscord` - -```typescript -const value: components.BenefitDiscord = { - createdAt: new Date("2022-05-09T19:55:42.332Z"), - modifiedAt: new Date("2023-02-23T07:01:12.546Z"), - id: "", - description: - "than acidly colorless oof oof ugh beneath unruly pupil extroverted", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - guildToken: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2023-10-26T03:03:05.451Z"), - modifiedAt: new Date("2022-11-28T23:36:29.114Z"), - id: "", - description: "oh appropriate bar successfully best sans after", - selectable: false, - deletable: false, - organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "triage", - }, -}; -``` - -### `components.BenefitDownloadables` - -```typescript -const value: components.BenefitDownloadables = { - createdAt: new Date("2024-04-01T00:20:32.487Z"), - modifiedAt: new Date("2023-08-07T10:34:04.832Z"), - id: "", - description: "jubilantly dark machine", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2022-05-28T03:45:35.250Z"), - modifiedAt: new Date("2024-07-21T06:55:08.065Z"), - id: "", - description: "aha barring wise finally enlightened aha reiterate", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 921916, - timeframe: "year", - }, - activations: { - limit: 114924, - enableUserAdmin: false, - }, - limitUsage: 724073, - }, -}; -``` - diff --git a/docs/models/operations/benefitsgrantsresponse.md b/docs/models/operations/benefitsgrantsresponse.md index fad03c09..34891369 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-17T04:37:18.826Z"), - modifiedAt: new Date("2023-05-25T17:46:27.444Z"), + createdAt: new Date("2024-05-18T13:53:28.368Z"), + modifiedAt: new Date("2024-07-04T20:50:00.142Z"), id: "", isGranted: false, isRevoked: false, @@ -22,8 +22,8 @@ let value: BenefitsGrantsResponse = { }, ], pagination: { - totalCount: 120387, - maxPage: 683271, + totalCount: 881189, + maxPage: 916419, }, }, }; diff --git a/docs/models/operations/benefitslistresponse.md b/docs/models/operations/benefitslistresponse.md index 7ff9e7db..738428ed 100644 --- a/docs/models/operations/benefitslistresponse.md +++ b/docs/models/operations/benefitslistresponse.md @@ -9,10 +9,10 @@ let value: BenefitsListResponse = { result: { items: [ { - createdAt: new Date("2024-07-22T13:58:22.659Z"), - modifiedAt: new Date("2024-11-20T18:50:24.078Z"), + createdAt: new Date("2024-05-25T08:43:19.210Z"), + modifiedAt: new Date("2024-10-09T02:34:28.117Z"), id: "", - description: "yuck mmm canter", + description: "frankly for unwelcome aftermath grown", selectable: false, deletable: false, organizationId: "", @@ -24,8 +24,8 @@ let value: BenefitsListResponse = { }, ], pagination: { - totalCount: 397026, - maxPage: 276650, + totalCount: 548849, + maxPage: 815225, }, }, }; diff --git a/docs/models/operations/benefitsupdatebenefitupdate.md b/docs/models/operations/benefitsupdatebenefitupdate.md index 598a0431..024c6c9b 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: "triage", + permission: "admin", }, }; ``` diff --git a/docs/models/operations/benefitsupdaterequest.md b/docs/models/operations/benefitsupdaterequest.md index ee2f7231..57ae6ff8 100644 --- a/docs/models/operations/benefitsupdaterequest.md +++ b/docs/models/operations/benefitsupdaterequest.md @@ -7,7 +7,13 @@ import { BenefitsUpdateRequest } from "@polar-sh/sdk/models/operations"; let value: BenefitsUpdateRequest = { id: "", - requestBody: {}, + requestBody: { + properties: { + repositoryOwner: "polarsource", + repositoryName: "private_repo", + permission: "maintain", + }, + }, }; ``` diff --git a/docs/models/operations/benefitsupdateresponsebenefitsupdate.md b/docs/models/operations/benefitsupdateresponsebenefitsupdate.md deleted file mode 100644 index cc868f20..00000000 --- a/docs/models/operations/benefitsupdateresponsebenefitsupdate.md +++ /dev/null @@ -1,146 +0,0 @@ -# BenefitsUpdateResponseBenefitsUpdate - -Benefit updated. - - -## Supported Types - -### `components.BenefitArticles` - -```typescript -const value: components.BenefitArticles = { - createdAt: new Date("2022-12-17T12:12:43.741Z"), - modifiedAt: new Date("2024-06-14T05:46:06.678Z"), - id: "", - description: "stay appertain so quintessential until enroll upsell", - selectable: false, - deletable: false, - organizationId: "", - properties: { - paidArticles: false, - }, -}; -``` - -### `components.BenefitAds` - -```typescript -const value: components.BenefitAds = { - createdAt: new Date("2023-10-04T05:10:54.402Z"), - modifiedAt: new Date("2024-11-26T06:30:19.542Z"), - id: "", - description: - "certainly punctual sermon insist whose among bell pocket-watch for mindless", - selectable: false, - deletable: false, - organizationId: "", - properties: {}, -}; -``` - -### `components.BenefitCustom` - -```typescript -const value: components.BenefitCustom = { - createdAt: new Date("2022-05-26T20:25:51.045Z"), - modifiedAt: new Date("2024-04-27T16:57:06.047Z"), - id: "", - description: "deficient long unselfish meh strange vaguely", - selectable: false, - deletable: false, - organizationId: "", - properties: { - note: "", - }, - isTaxApplicable: false, -}; -``` - -### `components.BenefitDiscord` - -```typescript -const value: components.BenefitDiscord = { - createdAt: new Date("2023-07-06T20:47:44.778Z"), - modifiedAt: new Date("2023-11-12T10:36:59.251Z"), - id: "", - description: - "liberalize excepting flight swathe amongst dislocate however entire ah", - selectable: false, - deletable: false, - organizationId: "", - properties: { - guildId: "", - roleId: "", - guildToken: "", - }, -}; -``` - -### `components.BenefitGitHubRepository` - -```typescript -const value: components.BenefitGitHubRepository = { - createdAt: new Date("2023-02-12T15:22:20.817Z"), - modifiedAt: new Date("2024-11-01T03:26:54.317Z"), - id: "", - description: "coagulate submissive ridge veg save hourly as whenever", - selectable: false, - deletable: false, - organizationId: "", - properties: { - repositoryId: "", - repositoryOwner: "polarsource", - repositoryName: "private_repo", - permission: "triage", - }, -}; -``` - -### `components.BenefitDownloadables` - -```typescript -const value: components.BenefitDownloadables = { - createdAt: new Date("2024-09-23T03:05:19.693Z"), - modifiedAt: new Date("2022-11-21T16:45:04.547Z"), - id: "", - description: "chow yahoo blah gee wisely mathematics", - selectable: false, - deletable: false, - organizationId: "", - properties: { - archived: { - "key": false, - }, - files: [ - "", - ], - }, -}; -``` - -### `components.BenefitLicenseKeys` - -```typescript -const value: components.BenefitLicenseKeys = { - createdAt: new Date("2022-01-19T16:14:20.571Z"), - modifiedAt: new Date("2023-09-05T17:10:02.116Z"), - id: "", - description: "promptly ha that what massive gah newsstand", - selectable: false, - deletable: false, - organizationId: "", - properties: { - prefix: "", - expires: { - ttl: 662184, - timeframe: "month", - }, - activations: { - limit: 869602, - enableUserAdmin: false, - }, - limitUsage: 993406, - }, -}; -``` - diff --git a/docs/models/operations/checkoutscustomlistresponse.md b/docs/models/operations/checkoutscustomlistresponse.md index 4ebfef16..5ce3bf4b 100644 --- a/docs/models/operations/checkoutscustomlistresponse.md +++ b/docs/models/operations/checkoutscustomlistresponse.md @@ -9,38 +9,38 @@ let value: CheckoutsCustomListResponse = { result: { items: [ { - createdAt: new Date("2023-08-07T00:52:08.467Z"), - modifiedAt: new Date("2024-06-22T05:15:07.307Z"), + createdAt: new Date("2023-03-31T23:27:16.931Z"), + modifiedAt: new Date("2023-07-24T21:41:06.633Z"), id: "", - status: "open", + status: "confirmed", clientSecret: "", - expiresAt: new Date("2023-05-25T13:18:45.811Z"), - successUrl: "https://dependable-retention.com", - amount: 946416, - taxAmount: 468221, - currency: "Guyana Dollar", - totalAmount: 116807, + expiresAt: new Date("2024-05-26T14:43:35.408Z"), + successUrl: "https://steel-bid.net", + amount: 66596, + taxAmount: 235970, + currency: "Belize Dollar", + totalAmount: 197519, productId: "", productPriceId: "", isPaymentRequired: false, customerId: "", customerName: "", - customerEmail: "Magdalena_Haag64@yahoo.com", + customerEmail: "Margarete76@yahoo.com", customerIpAddress: "", customerBillingAddress: { - country: "Cape Verde", + country: "Martinique", }, customerTaxId: "", paymentProcessorMetadata: {}, metadata: { "key": "", }, - url: "https://forceful-confusion.org", + url: "https://partial-horde.name/", }, ], pagination: { - totalCount: 309192, - maxPage: 124740, + totalCount: 416934, + maxPage: 400470, }, }, }; diff --git a/docs/models/operations/externalorganizationslistresponse.md b/docs/models/operations/externalorganizationslistresponse.md index 15c3c558..4bb1473e 100644 --- a/docs/models/operations/externalorganizationslistresponse.md +++ b/docs/models/operations/externalorganizationslistresponse.md @@ -9,23 +9,23 @@ let value: ExternalOrganizationsListResponse = { result: { items: [ { - id: "a48120f0-291e-4bf8-b48e-84e5035d775e", + id: "ebf848e8-4e50-435d-9775-eff6fca332e4", name: "", - avatarUrl: "https://huge-vibration.net", + avatarUrl: "https://spanish-starboard.com/", isPersonal: false, bio: "", prettyName: "", - company: "Frami, Emmerich and Cummerata", + company: "Spinka and Sons", blog: "", location: "", - email: "Eldred_Kunde84@hotmail.com", + email: "Carli.Blanda@gmail.com", twitterUsername: "", organizationId: "", }, ], pagination: { - totalCount: 426904, - maxPage: 842855, + totalCount: 246557, + maxPage: 596433, }, }, }; diff --git a/docs/models/operations/filescreatefilecreate.md b/docs/models/operations/filescreatefilecreate.md index 60e1b10f..c5902219 100644 --- a/docs/models/operations/filescreatefilecreate.md +++ b/docs/models/operations/filescreatefilecreate.md @@ -9,13 +9,13 @@ const value: components.DownloadableFileCreate = { name: "", mimeType: "", - size: 198406, + size: 44252, upload: { parts: [ { - number: 603038, - chunkStart: 340231, - chunkEnd: 238371, + number: 431258, + chunkStart: 672627, + chunkEnd: 828481, }, ], }, @@ -28,13 +28,13 @@ const value: components.DownloadableFileCreate = { const value: components.ProductMediaFileCreate = { name: "", mimeType: "", - size: 510401, + size: 852689, upload: { parts: [ { - number: 291649, - chunkStart: 222140, - chunkEnd: 879723, + number: 32775, + chunkStart: 244157, + chunkEnd: 339094, }, ], }, @@ -47,13 +47,13 @@ const value: components.ProductMediaFileCreate = { const value: components.OrganizationAvatarFileCreate = { name: "", mimeType: "", - size: 155762, + size: 188732, upload: { parts: [ { - number: 280590, - chunkStart: 386138, - chunkEnd: 273638, + number: 802976, + chunkStart: 767466, + chunkEnd: 516833, }, ], }, diff --git a/docs/models/operations/fileslistresponse.md b/docs/models/operations/fileslistresponse.md index f167e816..f76da920 100644 --- a/docs/models/operations/fileslistresponse.md +++ b/docs/models/operations/fileslistresponse.md @@ -12,24 +12,24 @@ let value: FilesListResponse = { id: "", organizationId: "", name: "", - path: "/opt/share", + path: "/etc", mimeType: "", - size: 926803, + size: 166542, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-05-28T02:07:36.978Z"), + lastModifiedAt: new Date("2024-07-21T21:55:28.560Z"), version: "", isUploaded: false, - createdAt: new Date("2022-04-10T21:15:07.296Z"), + createdAt: new Date("2024-04-25T02:25:06.711Z"), sizeReadable: "", - publicUrl: "https://unsung-hyphenation.com/", + publicUrl: "https://humble-transom.net/", }, ], pagination: { - totalCount: 593830, - maxPage: 537623, + totalCount: 614346, + maxPage: 221490, }, }, }; diff --git a/docs/models/operations/filesupdateresponsefilesupdate.md b/docs/models/operations/filesupdateresponsefilesupdate.md index c4f2dea5..4798f023 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: "/usr/lib", + path: "/Applications", mimeType: "", - size: 857979, + size: 845078, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-05-12T19:42:35.257Z"), + lastModifiedAt: new Date("2022-06-19T16:55:47.504Z"), version: "", isUploaded: false, - createdAt: new Date("2023-04-22T00:36:49.607Z"), + createdAt: new Date("2022-08-12T17:48:39.683Z"), sizeReadable: "", }; ``` @@ -34,19 +34,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/lost+found", + path: "/Library", mimeType: "", - size: 5051, + size: 884622, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2022-07-24T04:31:39.728Z"), + lastModifiedAt: new Date("2022-08-15T06:29:52.517Z"), version: "", isUploaded: false, - createdAt: new Date("2024-12-09T22:20:44.776Z"), + createdAt: new Date("2024-05-24T02:08:00.227Z"), sizeReadable: "", - publicUrl: "https://fearless-veto.info", + publicUrl: "https://vast-captain.biz", }; ``` @@ -57,19 +57,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/media", + path: "/usr/lib", mimeType: "", - size: 152807, + size: 196000, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-09-15T03:58:39.261Z"), + lastModifiedAt: new Date("2022-11-10T19:36:44.643Z"), version: "", isUploaded: false, - createdAt: new Date("2024-12-17T17:51:01.747Z"), + createdAt: new Date("2022-07-02T17:58:13.883Z"), sizeReadable: "", - publicUrl: "https://salty-fisherman.com/", + publicUrl: "https://long-cake.biz/", }; ``` diff --git a/docs/models/operations/filesuploadedrequest.md b/docs/models/operations/filesuploadedrequest.md index 173ab937..65f1df1e 100644 --- a/docs/models/operations/filesuploadedrequest.md +++ b/docs/models/operations/filesuploadedrequest.md @@ -9,10 +9,10 @@ let value: FilesUploadedRequest = { id: "", fileUploadCompleted: { id: "", - path: "/home/user", + path: "/var/tmp", parts: [ { - number: 771146, + number: 144058, checksumEtag: "", checksumSha256Base64: "", }, diff --git a/docs/models/operations/filesuploadedresponsefilesuploaded.md b/docs/models/operations/filesuploadedresponsefilesuploaded.md index 6ab41244..bf8a22d8 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: "/net", + path: "/usr/src", mimeType: "", - size: 112513, + size: 116463, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-08-16T19:42:22.872Z"), + lastModifiedAt: new Date("2022-06-28T20:19:53.694Z"), version: "", isUploaded: false, - createdAt: new Date("2022-05-18T12:50:57.952Z"), + createdAt: new Date("2024-02-03T01:20:59.436Z"), sizeReadable: "", }; ``` @@ -34,19 +34,19 @@ const value: components.ProductMediaFileRead = { id: "", organizationId: "", name: "", - path: "/opt", + path: "/etc/defaults", mimeType: "", - size: 881827, + size: 565845, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-02-09T14:24:57.874Z"), + lastModifiedAt: new Date("2023-04-06T13:49:22.596Z"), version: "", isUploaded: false, - createdAt: new Date("2023-11-25T05:30:57.815Z"), + createdAt: new Date("2024-03-09T09:46:45.083Z"), sizeReadable: "", - publicUrl: "https://considerate-patroller.org", + publicUrl: "https://soggy-steeple.com", }; ``` @@ -57,19 +57,19 @@ const value: components.OrganizationAvatarFileRead = { id: "", organizationId: "", name: "", - path: "/etc", + path: "/mnt", mimeType: "", - size: 753680, + size: 515433, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-01-27T11:19:03.177Z"), + lastModifiedAt: new Date("2023-04-01T21:14:09.557Z"), version: "", isUploaded: false, - createdAt: new Date("2024-08-07T20:38:23.153Z"), + createdAt: new Date("2022-09-11T10:55:49.019Z"), sizeReadable: "", - publicUrl: "https://fruitful-populist.com/", + publicUrl: "https://weary-emergent.info/", }; ``` diff --git a/docs/models/operations/interval.md b/docs/models/operations/interval.md deleted file mode 100644 index 59c6012d..00000000 --- a/docs/models/operations/interval.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interval - -Interval between two timestamps. - -## Example Usage - -```typescript -import { Interval } from "@polar-sh/sdk/models/operations"; - -let value: Interval = "month"; -``` - -## Values - -```typescript -"year" | "month" | "week" | "day" | "hour" -``` \ No newline at end of file diff --git a/docs/models/operations/licensekeyslistresponse.md b/docs/models/operations/licensekeyslistresponse.md index 553ba5cb..c122ba87 100644 --- a/docs/models/operations/licensekeyslistresponse.md +++ b/docs/models/operations/licensekeyslistresponse.md @@ -12,21 +12,27 @@ let value: LicenseKeysListResponse = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Rebeka23@hotmail.com", + avatarUrl: "https://strict-bungalow.com", + }, benefitId: "", key: "", displayKey: "", - status: "revoked", - limitActivations: 793260, - usage: 327624, - limitUsage: 701477, - validations: 427859, - lastValidatedAt: new Date("2024-11-22T14:24:07.004Z"), - expiresAt: new Date("2024-04-24T22:48:28.937Z"), + status: "granted", + limitActivations: 270477, + usage: 616183, + limitUsage: 384273, + validations: 703407, + lastValidatedAt: new Date("2023-01-22T23:17:01.541Z"), + expiresAt: new Date("2022-06-19T06:00:22.932Z"), }, ], pagination: { - totalCount: 356351, - maxPage: 17747, + totalCount: 312690, + maxPage: 884325, }, }, }; diff --git a/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md b/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md index 4287e57d..e10aec83 100644 --- a/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md +++ b/docs/models/operations/metricsgetqueryparamproductpricetypefilter.md @@ -8,7 +8,7 @@ Filter by product price type. `recurring` will filter data corresponding to subs ### `components.ProductPriceType` ```typescript -const value: components.ProductPriceType = "recurring"; +const value: components.ProductPriceType = "one_time"; ``` ### `components.ProductPriceType[]` diff --git a/docs/models/operations/metricsgetrequest.md b/docs/models/operations/metricsgetrequest.md index 0c860a0d..84ffb8b4 100644 --- a/docs/models/operations/metricsgetrequest.md +++ b/docs/models/operations/metricsgetrequest.md @@ -7,9 +7,9 @@ import { MetricsGetRequest } from "@polar-sh/sdk/models/operations"; import { RFCDate } from "@polar-sh/sdk/types"; let value: MetricsGetRequest = { - startDate: new RFCDate("2024-06-15"), - endDate: new RFCDate("2023-06-30"), - interval: "month", + startDate: new RFCDate("2023-03-02"), + endDate: new RFCDate("2022-04-14"), + interval: "week", }; ``` @@ -19,7 +19,7 @@ let value: MetricsGetRequest = { | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `startDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | Start date. | | `endDate` | [RFCDate](../../types/rfcdate.md) | :heavy_check_mark: | End date. | -| `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_check_mark: | Interval between two timestamps. | +| `interval` | [components.Interval](../../models/components/interval.md) | :heavy_check_mark: | Interval between two timestamps. | | `organizationId` | *operations.MetricsGetQueryParamOrganizationIDFilter* | :heavy_minus_sign: | Filter by organization ID. | | `productId` | *operations.MetricsGetQueryParamProductIDFilter* | :heavy_minus_sign: | Filter by product ID. | | `productPriceType` | *operations.MetricsGetQueryParamProductPriceTypeFilter* | :heavy_minus_sign: | Filter by product price type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases. | \ No newline at end of file diff --git a/docs/models/operations/oauth2clientslistresponse.md b/docs/models/operations/oauth2clientslistresponse.md index 83e3d5ca..8f4d9a49 100644 --- a/docs/models/operations/oauth2clientslistresponse.md +++ b/docs/models/operations/oauth2clientslistresponse.md @@ -10,20 +10,20 @@ let value: Oauth2ClientsListResponse = { items: [ { redirectUris: [ - "https://spherical-legend.com", + "https://enlightened-draft.net", ], clientName: "", - createdAt: new Date("2023-06-02T18:22:20.317Z"), - modifiedAt: new Date("2023-04-26T07:53:03.945Z"), + createdAt: new Date("2024-11-13T07:16:15.727Z"), + modifiedAt: new Date("2022-12-13T22:32:12.208Z"), clientId: "", clientSecret: "", - clientIdIssuedAt: 202796, - clientSecretExpiresAt: 423588, + clientIdIssuedAt: 826806, + clientSecretExpiresAt: 103990, }, ], pagination: { - totalCount: 357758, - maxPage: 163684, + totalCount: 633982, + maxPage: 751033, }, }, }; diff --git a/docs/models/operations/oauth2clientsoauth2updateclientrequest.md b/docs/models/operations/oauth2clientsoauth2updateclientrequest.md index 08bd2864..63b68ef4 100644 --- a/docs/models/operations/oauth2clientsoauth2updateclientrequest.md +++ b/docs/models/operations/oauth2clientsoauth2updateclientrequest.md @@ -9,7 +9,7 @@ let value: Oauth2ClientsOauth2UpdateClientRequest = { clientId: "", oAuth2ClientConfigurationUpdate: { redirectUris: [ - "https://fatal-license.com/", + "https://intelligent-taro.com/", ], 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 6b2c162a..cabe1ad8 100644 --- a/docs/models/operations/oauth2requesttokenrequestbody.md +++ b/docs/models/operations/oauth2requesttokenrequestbody.md @@ -11,7 +11,7 @@ const value: clientId: "", clientSecret: "", code: "", - redirectUri: "https://next-encouragement.org", + redirectUri: "https://flawed-lace.info/", }; ``` diff --git a/docs/models/operations/orderslistresponse.md b/docs/models/operations/orderslistresponse.md index 4ab57b98..ef25a50b 100644 --- a/docs/models/operations/orderslistresponse.md +++ b/docs/models/operations/orderslistresponse.md @@ -9,15 +9,16 @@ let value: OrdersListResponse = { result: { items: [ { - createdAt: new Date("2023-08-16T23:39:48.423Z"), - modifiedAt: new Date("2022-11-26T14:19:13.907Z"), + createdAt: new Date("2022-01-22T13:58:08.292Z"), + modifiedAt: new Date("2022-02-14T19:10:20.351Z"), id: "", metadata: { "key": "", }, - amount: 738325, - taxAmount: 259341, - currency: "Yemeni Rial", + amount: 257821, + taxAmount: 740245, + currency: "Norwegian Krone", + billingReason: "subscription_update", userId: "", productId: "", productPriceId: "", @@ -25,47 +26,47 @@ let value: OrdersListResponse = { checkoutId: "", user: { id: "", - email: "Annette.Zieme31@yahoo.com", + email: "Russell_Wuckert@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://qualified-label.name", + avatarUrl: "https://zealous-ceramic.net/", }, product: { - createdAt: new Date("2022-12-15T09:19:38.551Z"), - modifiedAt: new Date("2023-11-05T03:15:33.344Z"), + createdAt: new Date("2024-06-18T19:59:01.294Z"), + modifiedAt: new Date("2023-02-13T20:49:34.820Z"), id: "", name: "", - description: "splendid physically where likable bludgeon cleave", + description: "vastly capsize supposing immediately", isRecurring: false, isArchived: false, organizationId: "", }, productPrice: { - createdAt: new Date("2023-10-10T02:26:47.325Z"), - modifiedAt: new Date("2023-08-22T06:08:02.478Z"), + createdAt: new Date("2024-03-13T10:16:08.156Z"), + modifiedAt: new Date("2024-09-02T13:29:38.345Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 939096, - maximumAmount: 129156, - presetAmount: 73197, + minimumAmount: 989089, + maximumAmount: 662857, + presetAmount: 845365, }, subscription: { metadata: { "key": "", }, - createdAt: new Date("2022-06-18T21:53:52.884Z"), - modifiedAt: new Date("2022-09-26T12:13:20.933Z"), + createdAt: new Date("2024-05-02T17:32:01.787Z"), + modifiedAt: new Date("2022-12-04T01:19:21.934Z"), id: "", - amount: 592946, - currency: "Naira", + amount: 875693, + currency: "Argentine Peso", recurringInterval: "month", - status: "active", - currentPeriodStart: new Date("2023-06-13T08:09:17.911Z"), - currentPeriodEnd: new Date("2023-05-12T14:37:32.147Z"), + status: "incomplete_expired", + currentPeriodStart: new Date("2023-05-22T11:00:48.310Z"), + currentPeriodEnd: new Date("2023-12-01T15:29:51.324Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-05-30T16:27:19.575Z"), - endedAt: new Date("2023-06-01T23:24:52.236Z"), + startedAt: new Date("2022-04-22T12:57:54.328Z"), + endedAt: new Date("2024-01-08T14:51:30.818Z"), userId: "", productId: "", priceId: "", @@ -74,8 +75,8 @@ let value: OrdersListResponse = { }, ], pagination: { - totalCount: 758366, - maxPage: 166481, + totalCount: 801816, + maxPage: 185313, }, }, }; diff --git a/docs/models/operations/organizationslistresponse.md b/docs/models/operations/organizationslistresponse.md index b60ce064..86ac43e2 100644 --- a/docs/models/operations/organizationslistresponse.md +++ b/docs/models/operations/organizationslistresponse.md @@ -9,29 +9,29 @@ let value: OrganizationsListResponse = { result: { items: [ { - createdAt: new Date("2024-05-03T23:32:08.929Z"), - modifiedAt: new Date("2024-05-21T23:12:32.595Z"), + createdAt: new Date("2024-06-07T16:17:56.157Z"), + modifiedAt: new Date("2023-01-17T14:50:27.103Z"), id: "", name: "", slug: "", - avatarUrl: "https://somber-receptor.com/", + avatarUrl: "https://bare-sustenance.org/", bio: "", - company: "Kiehn, Kuhlman and Kirlin", + company: "Harvey - Daniel", blog: "", location: "", - email: "Lilliana_Streich@yahoo.com", + email: "Stella.Wuckert@gmail.com", twitterUsername: "", - pledgeMinimumAmount: 810839, + pledgeMinimumAmount: 367917, pledgeBadgeShowAmount: false, - defaultUpfrontSplitToContributors: 348192, + defaultUpfrontSplitToContributors: 342342, donationsEnabled: false, profileSettings: {}, featureSettings: {}, }, ], pagination: { - totalCount: 211455, - maxPage: 59383, + totalCount: 757364, + maxPage: 314573, }, }, }; diff --git a/docs/models/operations/productscreateproductcreate.md b/docs/models/operations/productscreateproductcreate.md index ff97d56d..730064a8 100644 --- a/docs/models/operations/productscreateproductcreate.md +++ b/docs/models/operations/productscreateproductcreate.md @@ -10,6 +10,7 @@ const value: components.ProductRecurringCreate = { name: "", prices: [ { + priceAmount: 435142, recurringInterval: "year", }, ], diff --git a/docs/models/operations/productslistrequest.md b/docs/models/operations/productslistrequest.md index 99e1b548..960c731e 100644 --- a/docs/models/operations/productslistrequest.md +++ b/docs/models/operations/productslistrequest.md @@ -6,9 +6,7 @@ import { ProductsListRequest } from "@polar-sh/sdk/models/operations"; let value: ProductsListRequest = { - organizationId: [ - "", - ], + organizationId: "", }; ``` diff --git a/docs/models/operations/productslistresponse.md b/docs/models/operations/productslistresponse.md index cec78b75..3dde04fe 100644 --- a/docs/models/operations/productslistresponse.md +++ b/docs/models/operations/productslistresponse.md @@ -9,35 +9,32 @@ let value: ProductsListResponse = { result: { items: [ { - createdAt: new Date("2022-07-15T03:50:42.259Z"), - modifiedAt: new Date("2024-12-02T08:02:45.129Z"), + createdAt: new Date("2023-10-28T20:52:23.318Z"), + modifiedAt: new Date("2023-08-01T03:15:58.659Z"), id: "", name: "", - description: "yawningly limp as uncover sleepily", + description: "soggy onto until oof hateful faithfully steel", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-02-27T19:43:42.467Z"), - modifiedAt: new Date("2024-10-30T08:26:55.656Z"), + createdAt: new Date("2023-10-08T04:10:09.540Z"), + modifiedAt: new Date("2022-02-19T21:06:49.752Z"), id: "", isArchived: false, - recurringInterval: "year", }, ], benefits: [ { - createdAt: new Date("2022-12-20T21:44:54.690Z"), - modifiedAt: new Date("2023-01-14T22:29:55.353Z"), + createdAt: new Date("2023-03-20T15:09:55.930Z"), + modifiedAt: new Date("2023-10-21T23:59:41.091Z"), id: "", - description: "loftily seafood jive boo singe that", + type: "downloadables", + description: "nimble whoever mmm boohoo straight innocently", selectable: false, deletable: false, organizationId: "", - properties: { - paidArticles: false, - }, }, ], medias: [ @@ -45,26 +42,26 @@ let value: ProductsListResponse = { id: "", organizationId: "", name: "", - path: "/boot/defaults", + path: "/var/log", mimeType: "", - size: 774804, + size: 960767, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2023-05-06T11:07:49.747Z"), + lastModifiedAt: new Date("2023-12-04T01:24:39.845Z"), version: "", isUploaded: false, - createdAt: new Date("2023-12-26T05:38:43.189Z"), + createdAt: new Date("2024-01-25T18:12:19.188Z"), sizeReadable: "", - publicUrl: "https://natural-co-producer.info", + publicUrl: "https://mild-management.info/", }, ], }, ], pagination: { - totalCount: 76873, - maxPage: 689301, + totalCount: 68596, + maxPage: 228907, }, }, }; diff --git a/docs/models/operations/queryparambenefittypefilter.md b/docs/models/operations/queryparambenefittypefilter.md index be899661..caa0bde8 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 = "license_keys"; +const value: components.BenefitType = "custom"; ``` ### `components.BenefitType[]` ```typescript const value: components.BenefitType[] = [ - "downloadables", + "github_repository", ]; ``` diff --git a/docs/models/operations/queryparamproductpricetypefilter.md b/docs/models/operations/queryparamproductpricetypefilter.md index 5347cb3d..beedfd04 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 ad4a7dc1..d02e663e 100644 --- a/docs/models/operations/repositorieslistresponse.md +++ b/docs/models/operations/repositorieslistresponse.md @@ -9,33 +9,33 @@ let value: RepositoriesListResponse = { result: { items: [ { - id: "d1241619-391f-4e63-b470-a66cbf5ec594", + id: "1fe63470-a66c-4bf5-8ec5-94d1326b8706", isPrivate: false, name: "MyOrg", - description: "yuck shinny invite", + description: "before enrage upside-down accurate", stars: 1337, license: "", homepage: "", profileSettings: {}, organization: { - id: "e04b621d-7eb6-458e-8b0b-eb2725ee459f", + id: "beb2725e-e459-4f24-bd7e-2855765ebb49", name: "", - avatarUrl: "https://trusty-junior.org/", + avatarUrl: "https://grown-rust.net", isPersonal: false, bio: "", prettyName: "", - company: "Lemke - Hansen", + company: "Streich - Kiehn", blog: "", location: "", - email: "Isac73@gmail.com", + email: "Isidro.Mraz@yahoo.com", twitterUsername: "", organizationId: "", }, }, ], pagination: { - totalCount: 289913, - maxPage: 577710, + totalCount: 401428, + maxPage: 416692, }, }, }; diff --git a/docs/models/operations/subscriptionslistresponse.md b/docs/models/operations/subscriptionslistresponse.md index 4da7fea6..404aae0b 100644 --- a/docs/models/operations/subscriptionslistresponse.md +++ b/docs/models/operations/subscriptionslistresponse.md @@ -9,18 +9,18 @@ let value: SubscriptionsListResponse = { result: { items: [ { - createdAt: new Date("2024-08-18T03:00:36.748Z"), - modifiedAt: new Date("2024-10-03T17:26:45.068Z"), + createdAt: new Date("2023-12-22T10:07:00.418Z"), + modifiedAt: new Date("2023-07-21T23:44:43.083Z"), id: "", - amount: 120120, - currency: "Guyana Dollar", - recurringInterval: "month", - status: "incomplete", - currentPeriodStart: new Date("2024-09-13T06:05:41.309Z"), - currentPeriodEnd: new Date("2022-03-04T08:05:57.928Z"), + amount: 484966, + currency: "Peso Uruguayo", + recurringInterval: "year", + status: "canceled", + currentPeriodStart: new Date("2024-03-06T05:29:10.468Z"), + currentPeriodEnd: new Date("2022-02-12T06:12:35.281Z"), cancelAtPeriodEnd: false, - startedAt: new Date("2024-12-10T14:41:41.611Z"), - endedAt: new Date("2022-04-16T17:02:36.383Z"), + startedAt: new Date("2024-04-27T07:53:12.556Z"), + endedAt: new Date("2022-08-26T16:33:18.210Z"), userId: "", productId: "", priceId: "", @@ -29,41 +29,43 @@ let value: SubscriptionsListResponse = { "key": "", }, user: { - email: "Kenny_Heaney@hotmail.com", + email: "Ally.Bradtke82@hotmail.com", publicName: "", githubUsername: "", - avatarUrl: "https://lovable-tennis.name", + avatarUrl: "https://gracious-silk.com/", }, product: { - createdAt: new Date("2024-06-25T05:46:03.384Z"), - modifiedAt: new Date("2024-03-06T05:29:10.468Z"), + createdAt: new Date("2022-09-07T04:32:30.698Z"), + modifiedAt: new Date("2022-03-17T11:04:55.466Z"), id: "", name: "", - description: "legitimize geez mmm", + description: + "educated or fedora compromise if made-up deer rightfully", isRecurring: false, isArchived: false, organizationId: "", prices: [ { - createdAt: new Date("2024-12-03T07:19:37.207Z"), - modifiedAt: new Date("2022-06-27T22:39:48.462Z"), + createdAt: new Date("2023-06-06T12:07:56.121Z"), + modifiedAt: new Date("2024-02-16T19:29:46.908Z"), id: "", isArchived: false, priceCurrency: "", - priceAmount: 290841, + priceAmount: 43975, }, ], benefits: [ { - createdAt: new Date("2023-01-14T16:10:50.825Z"), - modifiedAt: new Date("2023-06-11T03:31:17.736Z"), + createdAt: new Date("2023-07-25T00:13:17.699Z"), + modifiedAt: new Date("2022-02-03T14:30:29.574Z"), id: "", - type: "discord", - description: - "inasmuch voluntarily positively upbeat merge mozzarella alliance airbrush oil", + description: "lest paintwork but fondly", selectable: false, deletable: false, organizationId: "", + properties: { + paidArticles: false, + }, }, ], medias: [ @@ -71,38 +73,38 @@ let value: SubscriptionsListResponse = { id: "", organizationId: "", name: "", - path: "/tmp", + path: "/Library", mimeType: "", - size: 948541, + size: 127294, storageVersion: "", checksumEtag: "", checksumSha256Base64: "", checksumSha256Hex: "", - lastModifiedAt: new Date("2024-05-02T23:46:34.697Z"), + lastModifiedAt: new Date("2023-07-31T06:52:43.326Z"), version: "", isUploaded: false, - createdAt: new Date("2024-07-18T18:52:26.316Z"), + createdAt: new Date("2022-06-05T10:21:41.832Z"), sizeReadable: "", - publicUrl: "https://dependent-yeast.com/", + publicUrl: "https://powerful-railway.com/", }, ], }, price: { - createdAt: new Date("2022-03-16T15:07:15.176Z"), - modifiedAt: new Date("2024-10-31T11:03:10.627Z"), + createdAt: new Date("2023-12-16T17:29:07.234Z"), + modifiedAt: new Date("2024-07-24T03:46:55.765Z"), id: "", isArchived: false, priceCurrency: "", - minimumAmount: 964925, - maximumAmount: 719389, - presetAmount: 349993, + minimumAmount: 475325, + maximumAmount: 969206, + presetAmount: 265632, recurringInterval: "month", }, }, ], pagination: { - totalCount: 265303, - maxPage: 127294, + totalCount: 483753, + maxPage: 256114, }, }, }; diff --git a/docs/models/operations/tokentypehint.md b/docs/models/operations/tokentypehint.md index f9e721bf..cf18c8fe 100644 --- a/docs/models/operations/tokentypehint.md +++ b/docs/models/operations/tokentypehint.md @@ -5,7 +5,7 @@ ```typescript import { TokenTypeHint } from "@polar-sh/sdk/models/operations"; -let value: TokenTypeHint = "access_token"; +let value: TokenTypeHint = "refresh_token"; ``` ## Values diff --git a/docs/models/operations/userslicensekeyslistresponse.md b/docs/models/operations/userslicensekeyslistresponse.md index d1bf748b..bb959ac4 100644 --- a/docs/models/operations/userslicensekeyslistresponse.md +++ b/docs/models/operations/userslicensekeyslistresponse.md @@ -12,21 +12,27 @@ let value: UsersLicenseKeysListResponse = { id: "", organizationId: "", userId: "", + user: { + id: "", + publicName: "", + email: "Xander_Hickle@hotmail.com", + avatarUrl: "https://major-pleasure.biz/", + }, benefitId: "", key: "", displayKey: "", - status: "disabled", - limitActivations: 987349, - usage: 759283, - limitUsage: 364544, - validations: 501063, - lastValidatedAt: new Date("2023-02-17T12:32:25.218Z"), - expiresAt: new Date("2023-02-04T22:38:27.365Z"), + status: "revoked", + limitActivations: 117380, + usage: 159845, + limitUsage: 46806, + validations: 970732, + lastValidatedAt: new Date("2022-01-05T05:32:33.670Z"), + expiresAt: new Date("2022-07-15T17:22:02.927Z"), }, ], pagination: { - totalCount: 260904, - maxPage: 495970, + totalCount: 612867, + maxPage: 81369, }, }, }; diff --git a/docs/sdks/articles/README.md b/docs/sdks/articles/README.md index 07620002..49d124ca 100644 --- a/docs/sdks/articles/README.md +++ b/docs/sdks/articles/README.md @@ -7,6 +7,7 @@ * [list](#list) - List Articles * [create](#create) - Create Article +* [export](#export) - Export Articles * [get](#get) - Get Article * [update](#update) - Update Article * [delete](#delete) - Delete Article @@ -168,6 +169,83 @@ run(); | errors.HTTPValidationError | 422 | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | +## export + +Export organization articles. + +### 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.articles.export({ + organizationId: "cf4e3d5e-2b50-4470-a85b-8d021391fabb", + }); + + // 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 { articlesExport } from "@polar-sh/sdk/funcs/articlesExport.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 articlesExport(polar, { + organizationId: "cf4e3d5e-2b50-4470-a85b-8d021391fabb", + }); + + if (!res.ok) { + throw res.error; + } + + const { value: result } = res; + + // Handle the result + console.log(result); +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ArticlesExportRequest](../../models/operations/articlesexportrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `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\<[any](../../models/.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------- | -------------------------- | -------------------------- | +| errors.HTTPValidationError | 422 | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + ## get Get an article by ID. diff --git a/docs/sdks/benefits/README.md b/docs/sdks/benefits/README.md index 960441ab..b984a4b7 100644 --- a/docs/sdks/benefits/README.md +++ b/docs/sdks/benefits/README.md @@ -163,7 +163,7 @@ run(); ### Response -**Promise\<[operations.BenefitsCreateResponseBenefitsCreate](../../models/operations/benefitscreateresponsebenefitscreate.md)\>** +**Promise\<[components.Benefit](../../models/components/benefit.md)\>** ### Errors @@ -240,7 +240,7 @@ run(); ### Response -**Promise\<[operations.BenefitsGetResponseBenefitsGet](../../models/operations/benefitsgetresponsebenefitsget.md)\>** +**Promise\<[components.Benefit](../../models/components/benefit.md)\>** ### Errors @@ -320,7 +320,7 @@ run(); ### Response -**Promise\<[operations.BenefitsUpdateResponseBenefitsUpdate](../../models/operations/benefitsupdateresponsebenefitsupdate.md)\>** +**Promise\<[components.Benefit](../../models/components/benefit.md)\>** ### Errors diff --git a/jsr.json b/jsr.json index 391133c0..5e4e8ada 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@polar-sh/sdk", - "version": "0.13.0", + "version": "0.13.1", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index dce00c45..393680f6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@polar-sh/sdk", - "version": "0.13.0", + "version": "0.13.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@polar-sh/sdk", - "version": "0.13.0", + "version": "0.13.1", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index 9ba7f24b..d06b28fb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@polar-sh/sdk", - "version": "0.13.0", + "version": "0.13.1", "author": "Speakeasy", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/articlesExport.ts b/src/funcs/articlesExport.ts new file mode 100644 index 00000000..cdc27389 --- /dev/null +++ b/src/funcs/articlesExport.ts @@ -0,0 +1,129 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { PolarCore } from "../core.js"; +import { encodeFormQuery } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { safeParse } from "../lib/schemas.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 * as errors from "../models/errors/index.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"; + +/** + * Export Articles + * + * @remarks + * Export organization articles. + */ +export async function articlesExport( + client: PolarCore, + request: operations.ArticlesExportRequest, + options?: RequestOptions, +): Promise< + Result< + any, + | errors.HTTPValidationError + | SDKError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + > +> { + const parsed = safeParse( + request, + (value) => operations.ArticlesExportRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return parsed; + } + const payload = parsed.value; + const body = null; + + const path = pathToFunc("/v1/articles/export")(); + + const query = encodeFormQuery({ + "organization_id": payload.organization_id, + }); + + const headers = new Headers({ + Accept: "application/json", + }); + + const secConfig = await extractSecurity(client._options.accessToken); + const securityInput = secConfig == null ? {} : { accessToken: secConfig }; + const context = { + operationID: "articles:export", + oAuth2Scopes: [], + securitySource: client._options.accessToken, + }; + const requestSecurity = resolveGlobalSecurity(securityInput); + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + path: path, + headers: headers, + query: query, + body: body, + 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: ["422", "4XX", "5XX"], + retryConfig: options?.retries + || client._options.retryConfig, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }); + if (!doResult.ok) { + return doResult; + } + const response = doResult.value; + + const responseFields = { + HttpMeta: { Response: response, Request: req }, + }; + + const [result] = await M.match< + any, + | errors.HTTPValidationError + | SDKError + | SDKValidationError + | UnexpectedClientError + | InvalidRequestError + | RequestAbortedError + | RequestTimeoutError + | ConnectionError + >( + M.json(200, z.any()), + M.jsonErr(422, errors.HTTPValidationError$inboundSchema), + M.fail(["4XX", "5XX"]), + )(response, { extraFields: responseFields }); + if (!result.ok) { + return result; + } + + return result; +} diff --git a/src/funcs/benefitsCreate.ts b/src/funcs/benefitsCreate.ts index e4b40db2..dc217d05 100644 --- a/src/funcs/benefitsCreate.ts +++ b/src/funcs/benefitsCreate.ts @@ -9,6 +9,7 @@ import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; +import * as components from "../models/components/index.js"; import { ConnectionError, InvalidRequestError, @@ -34,7 +35,7 @@ export async function benefitsCreate( options?: RequestOptions, ): Promise< Result< - operations.BenefitsCreateResponseBenefitsCreate, + components.Benefit, | errors.HTTPValidationError | SDKError | SDKValidationError @@ -103,7 +104,7 @@ export async function benefitsCreate( }; const [result] = await M.match< - operations.BenefitsCreateResponseBenefitsCreate, + components.Benefit, | errors.HTTPValidationError | SDKError | SDKValidationError @@ -113,7 +114,7 @@ export async function benefitsCreate( | RequestTimeoutError | ConnectionError >( - M.json(201, operations.BenefitsCreateResponseBenefitsCreate$inboundSchema), + M.json(201, components.Benefit$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail(["4XX", "5XX"]), )(response, { extraFields: responseFields }); diff --git a/src/funcs/benefitsGet.ts b/src/funcs/benefitsGet.ts index 4858ebf8..a1c63ea5 100644 --- a/src/funcs/benefitsGet.ts +++ b/src/funcs/benefitsGet.ts @@ -9,6 +9,7 @@ import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; +import * as components from "../models/components/index.js"; import { ConnectionError, InvalidRequestError, @@ -34,7 +35,7 @@ export async function benefitsGet( options?: RequestOptions, ): Promise< Result< - operations.BenefitsGetResponseBenefitsGet, + components.Benefit, | errors.ResourceNotFound | errors.HTTPValidationError | SDKError @@ -109,7 +110,7 @@ export async function benefitsGet( }; const [result] = await M.match< - operations.BenefitsGetResponseBenefitsGet, + components.Benefit, | errors.ResourceNotFound | errors.HTTPValidationError | SDKError @@ -120,7 +121,7 @@ export async function benefitsGet( | RequestTimeoutError | ConnectionError >( - M.json(200, operations.BenefitsGetResponseBenefitsGet$inboundSchema), + M.json(200, components.Benefit$inboundSchema), M.jsonErr(404, errors.ResourceNotFound$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), M.fail(["4XX", "5XX"]), diff --git a/src/funcs/benefitsUpdate.ts b/src/funcs/benefitsUpdate.ts index e9149fed..db549c48 100644 --- a/src/funcs/benefitsUpdate.ts +++ b/src/funcs/benefitsUpdate.ts @@ -9,6 +9,7 @@ import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; +import * as components from "../models/components/index.js"; import { ConnectionError, InvalidRequestError, @@ -34,7 +35,7 @@ export async function benefitsUpdate( options?: RequestOptions, ): Promise< Result< - operations.BenefitsUpdateResponseBenefitsUpdate, + components.Benefit, | errors.NotPermitted | errors.ResourceNotFound | errors.HTTPValidationError @@ -111,7 +112,7 @@ export async function benefitsUpdate( }; const [result] = await M.match< - operations.BenefitsUpdateResponseBenefitsUpdate, + components.Benefit, | errors.NotPermitted | errors.ResourceNotFound | errors.HTTPValidationError @@ -123,7 +124,7 @@ export async function benefitsUpdate( | RequestTimeoutError | ConnectionError >( - M.json(200, operations.BenefitsUpdateResponseBenefitsUpdate$inboundSchema), + M.json(200, components.Benefit$inboundSchema), M.jsonErr(403, errors.NotPermitted$inboundSchema), M.jsonErr(404, errors.ResourceNotFound$inboundSchema), M.jsonErr(422, errors.HTTPValidationError$inboundSchema), diff --git a/src/lib/config.ts b/src/lib/config.ts index 94f17800..17c6db68 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.13.0", - genVersion: "2.437.1", - userAgent: "speakeasy-sdk/typescript 0.13.0 2.437.1 0.1.0 @polar-sh/sdk", + sdkVersion: "0.13.1", + genVersion: "2.438.3", + userAgent: "speakeasy-sdk/typescript 0.13.1 2.438.3 0.1.0 @polar-sh/sdk", } as const; diff --git a/src/models/components/articlecreate.ts b/src/models/components/articlecreate.ts index 414c1978..38d63964 100644 --- a/src/models/components/articlecreate.ts +++ b/src/models/components/articlecreate.ts @@ -4,30 +4,16 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; -import { ClosedEnum } from "../../types/enums.js"; - -/** - * If the user or organization should be credited in the byline. - */ -export const ArticleCreateArticleByline = { - User: "user", - Organization: "organization", -} as const; -/** - * If the user or organization should be credited in the byline. - */ -export type ArticleCreateArticleByline = ClosedEnum< - typeof ArticleCreateArticleByline ->; - -export const ArticleCreateArticleVisibility = { - Public: "public", - Hidden: "hidden", - Private: "private", -} as const; -export type ArticleCreateArticleVisibility = ClosedEnum< - typeof ArticleCreateArticleVisibility ->; +import { + ArticleByline, + ArticleByline$inboundSchema, + ArticleByline$outboundSchema, +} from "./articlebyline.js"; +import { + ArticleVisibility, + ArticleVisibility$inboundSchema, + ArticleVisibility$outboundSchema, +} from "./articlevisibility.js"; export type ArticleCreate = { /** @@ -50,11 +36,8 @@ export type ArticleCreate = { * The ID of the organization owning the article. **Required unless you use an organization token.** */ organizationId?: string | null | undefined; - /** - * If the user or organization should be credited in the byline. - */ - byline?: ArticleCreateArticleByline | undefined; - visibility?: ArticleCreateArticleVisibility | undefined; + byline?: ArticleByline | undefined; + visibility?: ArticleVisibility | undefined; /** * Set to true to only make this article available for subscribers to a paid subscription tier in the organization. */ @@ -85,48 +68,6 @@ export type ArticleCreate = { ogDescription?: string | null | undefined; }; -/** @internal */ -export const ArticleCreateArticleByline$inboundSchema: z.ZodNativeEnum< - typeof ArticleCreateArticleByline -> = z.nativeEnum(ArticleCreateArticleByline); - -/** @internal */ -export const ArticleCreateArticleByline$outboundSchema: z.ZodNativeEnum< - typeof ArticleCreateArticleByline -> = ArticleCreateArticleByline$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ArticleCreateArticleByline$ { - /** @deprecated use `ArticleCreateArticleByline$inboundSchema` instead. */ - export const inboundSchema = ArticleCreateArticleByline$inboundSchema; - /** @deprecated use `ArticleCreateArticleByline$outboundSchema` instead. */ - export const outboundSchema = ArticleCreateArticleByline$outboundSchema; -} - -/** @internal */ -export const ArticleCreateArticleVisibility$inboundSchema: z.ZodNativeEnum< - typeof ArticleCreateArticleVisibility -> = z.nativeEnum(ArticleCreateArticleVisibility); - -/** @internal */ -export const ArticleCreateArticleVisibility$outboundSchema: z.ZodNativeEnum< - typeof ArticleCreateArticleVisibility -> = ArticleCreateArticleVisibility$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace ArticleCreateArticleVisibility$ { - /** @deprecated use `ArticleCreateArticleVisibility$inboundSchema` instead. */ - export const inboundSchema = ArticleCreateArticleVisibility$inboundSchema; - /** @deprecated use `ArticleCreateArticleVisibility$outboundSchema` instead. */ - export const outboundSchema = ArticleCreateArticleVisibility$outboundSchema; -} - /** @internal */ export const ArticleCreate$inboundSchema: z.ZodType< ArticleCreate, @@ -138,8 +79,8 @@ export const ArticleCreate$inboundSchema: z.ZodType< body: z.nullable(z.string()).optional(), body_base64: z.nullable(z.string()).optional(), organization_id: z.nullable(z.string()).optional(), - byline: ArticleCreateArticleByline$inboundSchema.default("organization"), - visibility: ArticleCreateArticleVisibility$inboundSchema.default("private"), + byline: ArticleByline$inboundSchema.optional(), + visibility: ArticleVisibility$inboundSchema.optional(), paid_subscribers_only: z.boolean().default(false), paid_subscribers_only_ends_at: z.nullable( z.string().datetime({ offset: true }).transform(v => new Date(v)), @@ -172,8 +113,8 @@ export type ArticleCreate$Outbound = { body?: string | null | undefined; body_base64?: string | null | undefined; organization_id?: string | null | undefined; - byline: string; - visibility: string; + byline?: string | undefined; + visibility?: string | undefined; paid_subscribers_only: boolean; paid_subscribers_only_ends_at?: string | null | undefined; published_at?: string | null | undefined; @@ -194,8 +135,8 @@ export const ArticleCreate$outboundSchema: z.ZodType< body: z.nullable(z.string()).optional(), bodyBase64: z.nullable(z.string()).optional(), organizationId: z.nullable(z.string()).optional(), - byline: ArticleCreateArticleByline$outboundSchema.default("organization"), - visibility: ArticleCreateArticleVisibility$outboundSchema.default("private"), + byline: ArticleByline$outboundSchema.optional(), + visibility: ArticleVisibility$outboundSchema.optional(), paidSubscribersOnly: z.boolean().default(false), paidSubscribersOnlyEndsAt: z.nullable( z.date().transform(v => v.toISOString()), diff --git a/src/models/components/benefit.ts b/src/models/components/benefit.ts new file mode 100644 index 00000000..59c0d53e --- /dev/null +++ b/src/models/components/benefit.ts @@ -0,0 +1,106 @@ +/* + * 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 { + BenefitDiscord, + BenefitDiscord$inboundSchema, + BenefitDiscord$Outbound, + BenefitDiscord$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 Benefit = + | BenefitArticles + | BenefitAds + | BenefitDiscord + | BenefitGitHubRepository + | BenefitDownloadables + | BenefitLicenseKeys + | BenefitCustom; + +/** @internal */ +export const Benefit$inboundSchema: z.ZodType = + z.union([ + BenefitArticles$inboundSchema, + BenefitAds$inboundSchema, + BenefitDiscord$inboundSchema, + BenefitGitHubRepository$inboundSchema, + BenefitDownloadables$inboundSchema, + BenefitLicenseKeys$inboundSchema, + BenefitCustom$inboundSchema, + ]); + +/** @internal */ +export type Benefit$Outbound = + | BenefitArticles$Outbound + | BenefitAds$Outbound + | BenefitDiscord$Outbound + | BenefitGitHubRepository$Outbound + | BenefitDownloadables$Outbound + | BenefitLicenseKeys$Outbound + | BenefitCustom$Outbound; + +/** @internal */ +export const Benefit$outboundSchema: z.ZodType< + Benefit$Outbound, + z.ZodTypeDef, + Benefit +> = z.union([ + BenefitArticles$outboundSchema, + BenefitAds$outboundSchema, + BenefitDiscord$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 Benefit$ { + /** @deprecated use `Benefit$inboundSchema` instead. */ + export const inboundSchema = Benefit$inboundSchema; + /** @deprecated use `Benefit$outboundSchema` instead. */ + export const outboundSchema = Benefit$outboundSchema; + /** @deprecated use `Benefit$Outbound` instead. */ + export type Outbound = Benefit$Outbound; +} diff --git a/src/models/components/benefitbase.ts b/src/models/components/benefitbase.ts index cfc3b6d5..a35b4b13 100644 --- a/src/models/components/benefitbase.ts +++ b/src/models/components/benefitbase.ts @@ -23,9 +23,6 @@ export type BenefitBase = { * The ID of the benefit. */ id: string; - /** - * The type of the benefit. - */ type: BenefitType; /** * The description of the benefit. diff --git a/src/models/components/benefitgrantwebhook.ts b/src/models/components/benefitgrantwebhook.ts index c20cb47d..d2b3ac71 100644 --- a/src/models/components/benefitgrantwebhook.ts +++ b/src/models/components/benefitgrantwebhook.ts @@ -4,42 +4,6 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; -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 { BenefitGrantAdsProperties, BenefitGrantAdsProperties$inboundSchema, @@ -83,11 +47,11 @@ import { BenefitGrantLicenseKeysProperties$outboundSchema, } from "./benefitgrantlicensekeysproperties.js"; import { - BenefitLicenseKeys, - BenefitLicenseKeys$inboundSchema, - BenefitLicenseKeys$Outbound, - BenefitLicenseKeys$outboundSchema, -} from "./benefitlicensekeys.js"; + BenefitInput, + BenefitInput$inboundSchema, + BenefitInput$Outbound, + BenefitInput$outboundSchema, +} from "./benefitinput.js"; export type BenefitGrantWebhookProperties = | BenefitGrantCustomProperties @@ -98,15 +62,6 @@ export type BenefitGrantWebhookProperties = | BenefitGrantDiscordProperties | BenefitGrantGitHubRepositoryProperties; -export type BenefitGrantWebhookBenefit = - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; - export type PreviousProperties = | BenefitGrantCustomProperties | BenefitGrantArticlesProperties @@ -169,14 +124,7 @@ export type BenefitGrantWebhook = { | BenefitGrantLicenseKeysProperties | BenefitGrantDiscordProperties | BenefitGrantGitHubRepositoryProperties; - benefit: - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; + benefit: BenefitInput; previousProperties?: | BenefitGrantCustomProperties | BenefitGrantArticlesProperties @@ -242,59 +190,6 @@ export namespace BenefitGrantWebhookProperties$ { export type Outbound = BenefitGrantWebhookProperties$Outbound; } -/** @internal */ -export const BenefitGrantWebhookBenefit$inboundSchema: z.ZodType< - BenefitGrantWebhookBenefit, - z.ZodTypeDef, - unknown -> = z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type BenefitGrantWebhookBenefit$Outbound = - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; - -/** @internal */ -export const BenefitGrantWebhookBenefit$outboundSchema: z.ZodType< - BenefitGrantWebhookBenefit$Outbound, - z.ZodTypeDef, - BenefitGrantWebhookBenefit -> = 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 BenefitGrantWebhookBenefit$ { - /** @deprecated use `BenefitGrantWebhookBenefit$inboundSchema` instead. */ - export const inboundSchema = BenefitGrantWebhookBenefit$inboundSchema; - /** @deprecated use `BenefitGrantWebhookBenefit$outboundSchema` instead. */ - export const outboundSchema = BenefitGrantWebhookBenefit$outboundSchema; - /** @deprecated use `BenefitGrantWebhookBenefit$Outbound` instead. */ - export type Outbound = BenefitGrantWebhookBenefit$Outbound; -} - /** @internal */ export const PreviousProperties$inboundSchema: z.ZodType< PreviousProperties, @@ -380,15 +275,7 @@ export const BenefitGrantWebhook$inboundSchema: z.ZodType< BenefitGrantDiscordProperties$inboundSchema, BenefitGrantGitHubRepositoryProperties$inboundSchema, ]), - benefit: z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, - ]), + benefit: BenefitInput$inboundSchema, previous_properties: z.nullable( z.union([ BenefitGrantCustomProperties$inboundSchema, @@ -437,14 +324,7 @@ export type BenefitGrantWebhook$Outbound = { | BenefitGrantLicenseKeysProperties$Outbound | BenefitGrantDiscordProperties$Outbound | BenefitGrantGitHubRepositoryProperties$Outbound; - benefit: - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; + benefit: BenefitInput$Outbound; previous_properties?: | BenefitGrantCustomProperties$Outbound | BenefitGrantArticlesProperties$Outbound @@ -483,15 +363,7 @@ export const BenefitGrantWebhook$outboundSchema: z.ZodType< BenefitGrantDiscordProperties$outboundSchema, BenefitGrantGitHubRepositoryProperties$outboundSchema, ]), - benefit: z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscordInput$outboundSchema, - BenefitGitHubRepository$outboundSchema, - BenefitDownloadables$outboundSchema, - BenefitLicenseKeys$outboundSchema, - BenefitCustom$outboundSchema, - ]), + benefit: BenefitInput$outboundSchema, previousProperties: z.nullable( z.union([ BenefitGrantCustomProperties$outboundSchema, diff --git a/src/models/components/benefitinput.ts b/src/models/components/benefitinput.ts new file mode 100644 index 00000000..8722dd7b --- /dev/null +++ b/src/models/components/benefitinput.ts @@ -0,0 +1,109 @@ +/* + * 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/checkoutpublic.ts b/src/models/components/checkoutpublic.ts index 0362a0e5..8c4354eb 100644 --- a/src/models/components/checkoutpublic.ts +++ b/src/models/components/checkoutpublic.ts @@ -46,13 +46,7 @@ export type CheckoutPublic = { * The ID of the object. */ id: string; - /** - * Payment processor used. - */ paymentProcessor?: "stripe" | undefined; - /** - * Status of the checkout session. - */ status: CheckoutStatus; /** * Client secret used to update and complete the checkout session from the client. diff --git a/src/models/components/index.ts b/src/models/components/index.ts index 0f01255c..9c421c64 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -15,6 +15,7 @@ export * from "./articleupdate.js"; export * from "./articlevisibility.js"; export * from "./assignee.js"; export * from "./author.js"; +export * from "./benefit.js"; export * from "./benefitads.js"; export * from "./benefitadscreate.js"; export * from "./benefitadsproperties.js"; @@ -68,6 +69,7 @@ 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"; @@ -101,6 +103,7 @@ export * from "./fileservicetypes.js"; export * from "./fileupload.js"; export * from "./fileuploadcompleted.js"; export * from "./funding.js"; +export * from "./interval.js"; export * from "./introspecttokenresponse.js"; export * from "./issue.js"; export * from "./label.js"; @@ -111,6 +114,7 @@ export * from "./licensekeydeactivate.js"; export * from "./licensekeyread.js"; export * from "./licensekeystatus.js"; export * from "./licensekeyupdate.js"; +export * from "./licensekeyuser.js"; export * from "./licensekeyvalidate.js"; export * from "./licensekeywithactivations.js"; export * from "./listresourcearticle.js"; @@ -145,6 +149,7 @@ export * from "./oauth2clientconfigurationupdate.js"; export * from "./onev11oauth21tokenpostxcomponentsauthorizationcodetokenrequest.js"; export * from "./onev11oauth21tokenpostxcomponentsrefreshtokenrequest.js"; export * from "./order.js"; +export * from "./orderbillingreason.js"; export * from "./orderinvoice.js"; export * from "./orderproduct.js"; export * from "./ordersortproperty.js"; @@ -249,5 +254,8 @@ export * from "./webhookpledgecreatedpayload.js"; export * from "./webhookpledgeupdatedpayload.js"; export * from "./webhookproductcreatedpayload.js"; export * from "./webhookproductupdatedpayload.js"; +export * from "./webhooksubscriptionactivepayload.js"; +export * from "./webhooksubscriptioncanceledpayload.js"; export * from "./webhooksubscriptioncreatedpayload.js"; +export * from "./webhooksubscriptionrevokedpayload.js"; export * from "./webhooksubscriptionupdatedpayload.js"; diff --git a/src/models/components/interval.ts b/src/models/components/interval.ts new file mode 100644 index 00000000..ad15449f --- /dev/null +++ b/src/models/components/interval.ts @@ -0,0 +1,34 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; + +export const Interval = { + Year: "year", + Month: "month", + Week: "week", + Day: "day", + Hour: "hour", +} as const; +export type Interval = ClosedEnum; + +/** @internal */ +export const Interval$inboundSchema: z.ZodNativeEnum = z + .nativeEnum(Interval); + +/** @internal */ +export const Interval$outboundSchema: z.ZodNativeEnum = + Interval$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Interval$ { + /** @deprecated use `Interval$inboundSchema` instead. */ + export const inboundSchema = Interval$inboundSchema; + /** @deprecated use `Interval$outboundSchema` instead. */ + export const outboundSchema = Interval$outboundSchema; +} diff --git a/src/models/components/issue.ts b/src/models/components/issue.ts index ccd7de36..d8bbfebd 100644 --- a/src/models/components/issue.ts +++ b/src/models/components/issue.ts @@ -44,9 +44,6 @@ import { State, State$inboundSchema, State$outboundSchema } from "./state.js"; export type Issue = { id: string; - /** - * Issue platform (currently always GitHub) - */ platform?: "github" | undefined; /** * GitHub #number @@ -90,9 +87,6 @@ export type Issue = { */ confirmedSolvedAt?: Date | null | undefined; funding: Funding; - /** - * The repository that the issue is in - */ repository: RepositoryInput; /** * Share of rewrads that will be rewarded to contributors of this issue. A number between 0 and 100 (inclusive). diff --git a/src/models/components/licensekeyread.ts b/src/models/components/licensekeyread.ts index 7ef089dc..6b151304 100644 --- a/src/models/components/licensekeyread.ts +++ b/src/models/components/licensekeyread.ts @@ -9,11 +9,18 @@ import { LicenseKeyStatus$inboundSchema, LicenseKeyStatus$outboundSchema, } from "./licensekeystatus.js"; +import { + LicenseKeyUser, + LicenseKeyUser$inboundSchema, + LicenseKeyUser$Outbound, + LicenseKeyUser$outboundSchema, +} from "./licensekeyuser.js"; export type LicenseKeyRead = { id: string; organizationId: string; userId: string; + user: LicenseKeyUser; /** * The benefit ID. */ @@ -38,6 +45,7 @@ export const LicenseKeyRead$inboundSchema: z.ZodType< id: z.string(), organization_id: z.string(), user_id: z.string(), + user: LicenseKeyUser$inboundSchema, benefit_id: z.string(), key: z.string(), display_key: z.string(), @@ -70,6 +78,7 @@ export type LicenseKeyRead$Outbound = { id: string; organization_id: string; user_id: string; + user: LicenseKeyUser$Outbound; benefit_id: string; key: string; display_key: string; @@ -91,6 +100,7 @@ export const LicenseKeyRead$outboundSchema: z.ZodType< id: z.string(), organizationId: z.string(), userId: z.string(), + user: LicenseKeyUser$outboundSchema, benefitId: z.string(), key: z.string(), displayKey: z.string(), diff --git a/src/models/components/licensekeyuser.ts b/src/models/components/licensekeyuser.ts new file mode 100644 index 00000000..9290d779 --- /dev/null +++ b/src/models/components/licensekeyuser.ts @@ -0,0 +1,68 @@ +/* + * 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 LicenseKeyUser = { + id: string; + publicName: string; + email: string; + avatarUrl: string | null; +}; + +/** @internal */ +export const LicenseKeyUser$inboundSchema: z.ZodType< + LicenseKeyUser, + 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 LicenseKeyUser$Outbound = { + id: string; + public_name: string; + email: string; + avatar_url: string | null; +}; + +/** @internal */ +export const LicenseKeyUser$outboundSchema: z.ZodType< + LicenseKeyUser$Outbound, + z.ZodTypeDef, + LicenseKeyUser +> = 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", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace LicenseKeyUser$ { + /** @deprecated use `LicenseKeyUser$inboundSchema` instead. */ + export const inboundSchema = LicenseKeyUser$inboundSchema; + /** @deprecated use `LicenseKeyUser$outboundSchema` instead. */ + export const outboundSchema = LicenseKeyUser$outboundSchema; + /** @deprecated use `LicenseKeyUser$Outbound` instead. */ + export type Outbound = LicenseKeyUser$Outbound; +} diff --git a/src/models/components/licensekeywithactivations.ts b/src/models/components/licensekeywithactivations.ts index 5a108170..9ed3d34e 100644 --- a/src/models/components/licensekeywithactivations.ts +++ b/src/models/components/licensekeywithactivations.ts @@ -15,11 +15,18 @@ import { LicenseKeyStatus$inboundSchema, LicenseKeyStatus$outboundSchema, } from "./licensekeystatus.js"; +import { + LicenseKeyUser, + LicenseKeyUser$inboundSchema, + LicenseKeyUser$Outbound, + LicenseKeyUser$outboundSchema, +} from "./licensekeyuser.js"; export type LicenseKeyWithActivations = { id: string; organizationId: string; userId: string; + user: LicenseKeyUser; /** * The benefit ID. */ @@ -45,6 +52,7 @@ export const LicenseKeyWithActivations$inboundSchema: z.ZodType< id: z.string(), organization_id: z.string(), user_id: z.string(), + user: LicenseKeyUser$inboundSchema, benefit_id: z.string(), key: z.string(), display_key: z.string(), @@ -78,6 +86,7 @@ export type LicenseKeyWithActivations$Outbound = { id: string; organization_id: string; user_id: string; + user: LicenseKeyUser$Outbound; benefit_id: string; key: string; display_key: string; @@ -100,6 +109,7 @@ export const LicenseKeyWithActivations$outboundSchema: z.ZodType< id: z.string(), organizationId: z.string(), userId: z.string(), + user: LicenseKeyUser$outboundSchema, benefitId: z.string(), key: z.string(), displayKey: z.string(), diff --git a/src/models/components/listresourcebenefit.ts b/src/models/components/listresourcebenefit.ts index 90b594da..110e2f6f 100644 --- a/src/models/components/listresourcebenefit.ts +++ b/src/models/components/listresourcebenefit.ts @@ -4,47 +4,11 @@ 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 { - BenefitDiscord, - BenefitDiscord$inboundSchema, - BenefitDiscord$Outbound, - BenefitDiscord$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"; + Benefit, + Benefit$inboundSchema, + Benefit$Outbound, + Benefit$outboundSchema, +} from "./benefit.js"; import { Pagination, Pagination$inboundSchema, @@ -52,109 +16,24 @@ import { Pagination$outboundSchema, } from "./pagination.js"; -export type Benefit = - | BenefitArticles - | BenefitAds - | BenefitDiscord - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; - export type ListResourceBenefit = { - items: Array< - | BenefitArticles - | BenefitAds - | BenefitDiscord - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom - >; + items: Array; pagination: Pagination; }; -/** @internal */ -export const Benefit$inboundSchema: z.ZodType = - z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscord$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, - ]); - -/** @internal */ -export type Benefit$Outbound = - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscord$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; - -/** @internal */ -export const Benefit$outboundSchema: z.ZodType< - Benefit$Outbound, - z.ZodTypeDef, - Benefit -> = z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscord$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 Benefit$ { - /** @deprecated use `Benefit$inboundSchema` instead. */ - export const inboundSchema = Benefit$inboundSchema; - /** @deprecated use `Benefit$outboundSchema` instead. */ - export const outboundSchema = Benefit$outboundSchema; - /** @deprecated use `Benefit$Outbound` instead. */ - export type Outbound = Benefit$Outbound; -} - /** @internal */ export const ListResourceBenefit$inboundSchema: z.ZodType< ListResourceBenefit, z.ZodTypeDef, unknown > = z.object({ - items: z.array( - z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscord$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, - ]), - ), + items: z.array(Benefit$inboundSchema), pagination: Pagination$inboundSchema, }); /** @internal */ export type ListResourceBenefit$Outbound = { - items: Array< - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscord$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound - >; + items: Array; pagination: Pagination$Outbound; }; @@ -164,17 +43,7 @@ export const ListResourceBenefit$outboundSchema: z.ZodType< z.ZodTypeDef, ListResourceBenefit > = z.object({ - items: z.array( - z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscord$outboundSchema, - BenefitGitHubRepository$outboundSchema, - BenefitDownloadables$outboundSchema, - BenefitLicenseKeys$outboundSchema, - BenefitCustom$outboundSchema, - ]), - ), + items: z.array(Benefit$outboundSchema), pagination: Pagination$outboundSchema, }); diff --git a/src/models/components/metric.ts b/src/models/components/metric.ts index 81211851..166bf537 100644 --- a/src/models/components/metric.ts +++ b/src/models/components/metric.ts @@ -22,9 +22,6 @@ export type Metric = { * Human-readable name for the metric. */ displayName: string; - /** - * Type of the metric, useful to know the unit or format of the value. - */ type: MetricType; }; diff --git a/src/models/components/metricsintervalslimits.ts b/src/models/components/metricsintervalslimits.ts index 71a5ae15..e60d8733 100644 --- a/src/models/components/metricsintervalslimits.ts +++ b/src/models/components/metricsintervalslimits.ts @@ -15,23 +15,23 @@ import { */ export type MetricsIntervalsLimits = { /** - * Limits for the hour interval. + * Date interval limit to get metrics for a given interval. */ hour: MetricsIntervalLimit; /** - * Limits for the day interval. + * Date interval limit to get metrics for a given interval. */ day: MetricsIntervalLimit; /** - * Limits for the week interval. + * Date interval limit to get metrics for a given interval. */ week: MetricsIntervalLimit; /** - * Limits for the month interval. + * Date interval limit to get metrics for a given interval. */ month: MetricsIntervalLimit; /** - * Limits for the year interval. + * Date interval limit to get metrics for a given interval. */ year: MetricsIntervalLimit; }; diff --git a/src/models/components/metricslimits.ts b/src/models/components/metricslimits.ts index 97c5cdcd..7eb878fb 100644 --- a/src/models/components/metricslimits.ts +++ b/src/models/components/metricslimits.ts @@ -21,7 +21,7 @@ export type MetricsLimits = { */ minDate: RFCDate; /** - * Limits for each interval. + * Date interval limits to get metrics for each interval. */ intervals: MetricsIntervalsLimits; }; diff --git a/src/models/components/metricsresponse.ts b/src/models/components/metricsresponse.ts index d0cbca65..b39a326d 100644 --- a/src/models/components/metricsresponse.ts +++ b/src/models/components/metricsresponse.ts @@ -24,9 +24,6 @@ export type MetricsResponse = { * List of data for each timestamp. */ periods: Array; - /** - * Information about the returned metrics. - */ metrics: Metrics; }; diff --git a/src/models/components/order.ts b/src/models/components/order.ts index 664a7147..003cc751 100644 --- a/src/models/components/order.ts +++ b/src/models/components/order.ts @@ -4,6 +4,11 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; +import { + OrderBillingReason, + OrderBillingReason$inboundSchema, + OrderBillingReason$outboundSchema, +} from "./orderbillingreason.js"; import { OrderProduct, OrderProduct$inboundSchema, @@ -46,6 +51,7 @@ export type Order = { amount: number; taxAmount: number; currency: string; + billingReason: OrderBillingReason; userId: string; productId: string; productPriceId: string; @@ -71,6 +77,7 @@ export const Order$inboundSchema: z.ZodType = z amount: z.number().int(), tax_amount: z.number().int(), currency: z.string(), + billing_reason: OrderBillingReason$inboundSchema, user_id: z.string(), product_id: z.string(), product_price_id: z.string(), @@ -85,6 +92,7 @@ export const Order$inboundSchema: z.ZodType = z "created_at": "createdAt", "modified_at": "modifiedAt", "tax_amount": "taxAmount", + "billing_reason": "billingReason", "user_id": "userId", "product_id": "productId", "product_price_id": "productPriceId", @@ -103,6 +111,7 @@ export type Order$Outbound = { amount: number; tax_amount: number; currency: string; + billing_reason: string; user_id: string; product_id: string; product_price_id: string; @@ -127,6 +136,7 @@ export const Order$outboundSchema: z.ZodType< amount: z.number().int(), taxAmount: z.number().int(), currency: z.string(), + billingReason: OrderBillingReason$outboundSchema, userId: z.string(), productId: z.string(), productPriceId: z.string(), @@ -141,6 +151,7 @@ export const Order$outboundSchema: z.ZodType< createdAt: "created_at", modifiedAt: "modified_at", taxAmount: "tax_amount", + billingReason: "billing_reason", userId: "user_id", productId: "product_id", productPriceId: "product_price_id", diff --git a/src/models/components/orderbillingreason.ts b/src/models/components/orderbillingreason.ts new file mode 100644 index 00000000..a0e2472e --- /dev/null +++ b/src/models/components/orderbillingreason.ts @@ -0,0 +1,35 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; + +export const OrderBillingReason = { + Purchase: "purchase", + SubscriptionCreate: "subscription_create", + SubscriptionCycle: "subscription_cycle", + SubscriptionUpdate: "subscription_update", +} as const; +export type OrderBillingReason = ClosedEnum; + +/** @internal */ +export const OrderBillingReason$inboundSchema: z.ZodNativeEnum< + typeof OrderBillingReason +> = z.nativeEnum(OrderBillingReason); + +/** @internal */ +export const OrderBillingReason$outboundSchema: z.ZodNativeEnum< + typeof OrderBillingReason +> = OrderBillingReason$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OrderBillingReason$ { + /** @deprecated use `OrderBillingReason$inboundSchema` instead. */ + export const inboundSchema = OrderBillingReason$inboundSchema; + /** @deprecated use `OrderBillingReason$outboundSchema` instead. */ + export const outboundSchema = OrderBillingReason$outboundSchema; +} diff --git a/src/models/components/pledge.ts b/src/models/components/pledge.ts index 97ddb162..e0193f7f 100644 --- a/src/models/components/pledge.ts +++ b/src/models/components/pledge.ts @@ -45,13 +45,7 @@ export type Pledge = { */ amount: number; currency: string; - /** - * Current state of the pledge - */ state: PledgeState; - /** - * Type of pledge - */ type: PledgeType; /** * If and when the pledge was refunded to the pledger @@ -61,9 +55,6 @@ export type Pledge = { * When the payout is scheduled to be made to the maintainers behind the issue. Disputes must be made before this date. */ scheduledPayoutAt?: Date | null | undefined; - /** - * The issue that the pledge was made towards - */ issue: Issue; /** * The user or organization that made this pledge diff --git a/src/models/components/polarcheckoutschemascheckout.ts b/src/models/components/polarcheckoutschemascheckout.ts index 2ae2d2a7..0aa04efe 100644 --- a/src/models/components/polarcheckoutschemascheckout.ts +++ b/src/models/components/polarcheckoutschemascheckout.ts @@ -34,13 +34,7 @@ export type PolarCheckoutSchemasCheckout = { * The ID of the object. */ id: string; - /** - * Payment processor used. - */ paymentProcessor?: "stripe" | undefined; - /** - * Status of the checkout session. - */ status: CheckoutStatus; /** * Client secret used to update and complete the checkout session from the client. @@ -106,13 +100,7 @@ export type PolarCheckoutSchemasCheckoutInput = { * The ID of the object. */ id: string; - /** - * Payment processor used. - */ paymentProcessor?: "stripe" | undefined; - /** - * Status of the checkout session. - */ status: CheckoutStatus; /** * Client secret used to update and complete the checkout session from the client. diff --git a/src/models/components/productpricerecurringcustom.ts b/src/models/components/productpricerecurringcustom.ts index 8fbf00c1..f96fa896 100644 --- a/src/models/components/productpricerecurringcustom.ts +++ b/src/models/components/productpricerecurringcustom.ts @@ -72,9 +72,6 @@ export type ProductPriceRecurringCustom = { * The type of the price. */ type?: "recurring" | undefined; - /** - * The recurring interval of the price. - */ recurringInterval: SubscriptionRecurringInterval; }; diff --git a/src/models/components/productpricerecurringfixed.ts b/src/models/components/productpricerecurringfixed.ts index 0a819535..bbe26fe0 100644 --- a/src/models/components/productpricerecurringfixed.ts +++ b/src/models/components/productpricerecurringfixed.ts @@ -62,9 +62,6 @@ export type ProductPriceRecurringFixed = { * The type of the price. */ type?: "recurring" | undefined; - /** - * The recurring interval of the price. - */ recurringInterval: SubscriptionRecurringInterval; }; diff --git a/src/models/components/productpricerecurringfixedcreate.ts b/src/models/components/productpricerecurringfixedcreate.ts index bdfabfc4..6436884a 100644 --- a/src/models/components/productpricerecurringfixedcreate.ts +++ b/src/models/components/productpricerecurringfixedcreate.ts @@ -39,9 +39,6 @@ export type ProductPriceRecurringFixedCreate = { * The currency. Currently, only `usd` is supported. */ priceCurrency?: string | undefined; - /** - * The recurring interval of the price. - */ recurringInterval: SubscriptionRecurringInterval; }; diff --git a/src/models/components/productpricerecurringfree.ts b/src/models/components/productpricerecurringfree.ts index b7720a71..4be58629 100644 --- a/src/models/components/productpricerecurringfree.ts +++ b/src/models/components/productpricerecurringfree.ts @@ -56,9 +56,6 @@ export type ProductPriceRecurringFree = { * The type of the price. */ type?: "recurring" | undefined; - /** - * The recurring interval of the price. - */ recurringInterval: SubscriptionRecurringInterval; }; diff --git a/src/models/components/productpricerecurringfreecreate.ts b/src/models/components/productpricerecurringfreecreate.ts index 340f4bee..da0ae947 100644 --- a/src/models/components/productpricerecurringfreecreate.ts +++ b/src/models/components/productpricerecurringfreecreate.ts @@ -31,9 +31,6 @@ export type ProductPriceRecurringFreeCreateAmountType = ClosedEnum< export type ProductPriceRecurringFreeCreate = { type?: "recurring" | undefined; amountType?: "free" | undefined; - /** - * The recurring interval of the price. - */ recurringInterval: SubscriptionRecurringInterval; }; diff --git a/src/models/components/validatedlicensekey.ts b/src/models/components/validatedlicensekey.ts index fae33f6d..35186b20 100644 --- a/src/models/components/validatedlicensekey.ts +++ b/src/models/components/validatedlicensekey.ts @@ -15,11 +15,18 @@ import { LicenseKeyStatus$inboundSchema, LicenseKeyStatus$outboundSchema, } from "./licensekeystatus.js"; +import { + LicenseKeyUser, + LicenseKeyUser$inboundSchema, + LicenseKeyUser$Outbound, + LicenseKeyUser$outboundSchema, +} from "./licensekeyuser.js"; export type ValidatedLicenseKey = { id: string; organizationId: string; userId: string; + user: LicenseKeyUser; /** * The benefit ID. */ @@ -45,6 +52,7 @@ export const ValidatedLicenseKey$inboundSchema: z.ZodType< id: z.string(), organization_id: z.string(), user_id: z.string(), + user: LicenseKeyUser$inboundSchema, benefit_id: z.string(), key: z.string(), display_key: z.string(), @@ -78,6 +86,7 @@ export type ValidatedLicenseKey$Outbound = { id: string; organization_id: string; user_id: string; + user: LicenseKeyUser$Outbound; benefit_id: string; key: string; display_key: string; @@ -100,6 +109,7 @@ export const ValidatedLicenseKey$outboundSchema: z.ZodType< id: z.string(), organizationId: z.string(), userId: z.string(), + user: LicenseKeyUser$outboundSchema, benefitId: z.string(), key: z.string(), displayKey: z.string(), diff --git a/src/models/components/webhookbenefitcreatedpayload.ts b/src/models/components/webhookbenefitcreatedpayload.ts index 710feab5..a702ad55 100644 --- a/src/models/components/webhookbenefitcreatedpayload.ts +++ b/src/models/components/webhookbenefitcreatedpayload.ts @@ -5,47 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; 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"; + BenefitInput, + BenefitInput$inboundSchema, + BenefitInput$Outbound, + BenefitInput$outboundSchema, +} from "./benefitinput.js"; export const WebhookBenefitCreatedPayloadType = { BenefitCreated: "benefit.created", @@ -54,15 +18,6 @@ export type WebhookBenefitCreatedPayloadType = ClosedEnum< typeof WebhookBenefitCreatedPayloadType >; -export type WebhookBenefitCreatedPayloadBenefit = - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; - /** * Sent when a new benefit is created. * @@ -72,14 +27,7 @@ export type WebhookBenefitCreatedPayloadBenefit = */ export type WebhookBenefitCreatedPayload = { type?: "benefit.created" | undefined; - data: - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; + data: BenefitInput; }; /** @internal */ @@ -103,61 +51,6 @@ export namespace WebhookBenefitCreatedPayloadType$ { export const outboundSchema = WebhookBenefitCreatedPayloadType$outboundSchema; } -/** @internal */ -export const WebhookBenefitCreatedPayloadBenefit$inboundSchema: z.ZodType< - WebhookBenefitCreatedPayloadBenefit, - z.ZodTypeDef, - unknown -> = z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type WebhookBenefitCreatedPayloadBenefit$Outbound = - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; - -/** @internal */ -export const WebhookBenefitCreatedPayloadBenefit$outboundSchema: z.ZodType< - WebhookBenefitCreatedPayloadBenefit$Outbound, - z.ZodTypeDef, - WebhookBenefitCreatedPayloadBenefit -> = 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 WebhookBenefitCreatedPayloadBenefit$ { - /** @deprecated use `WebhookBenefitCreatedPayloadBenefit$inboundSchema` instead. */ - export const inboundSchema = - WebhookBenefitCreatedPayloadBenefit$inboundSchema; - /** @deprecated use `WebhookBenefitCreatedPayloadBenefit$outboundSchema` instead. */ - export const outboundSchema = - WebhookBenefitCreatedPayloadBenefit$outboundSchema; - /** @deprecated use `WebhookBenefitCreatedPayloadBenefit$Outbound` instead. */ - export type Outbound = WebhookBenefitCreatedPayloadBenefit$Outbound; -} - /** @internal */ export const WebhookBenefitCreatedPayload$inboundSchema: z.ZodType< WebhookBenefitCreatedPayload, @@ -165,28 +58,13 @@ export const WebhookBenefitCreatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("benefit.created").optional(), - data: z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, - ]), + data: BenefitInput$inboundSchema, }); /** @internal */ export type WebhookBenefitCreatedPayload$Outbound = { type: "benefit.created"; - data: - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; + data: BenefitInput$Outbound; }; /** @internal */ @@ -196,15 +74,7 @@ export const WebhookBenefitCreatedPayload$outboundSchema: z.ZodType< WebhookBenefitCreatedPayload > = z.object({ type: z.literal("benefit.created").default("benefit.created"), - data: z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscordInput$outboundSchema, - BenefitGitHubRepository$outboundSchema, - BenefitDownloadables$outboundSchema, - BenefitLicenseKeys$outboundSchema, - BenefitCustom$outboundSchema, - ]), + data: BenefitInput$outboundSchema, }); /** diff --git a/src/models/components/webhookbenefitupdatedpayload.ts b/src/models/components/webhookbenefitupdatedpayload.ts index 1b7e54a1..20c89781 100644 --- a/src/models/components/webhookbenefitupdatedpayload.ts +++ b/src/models/components/webhookbenefitupdatedpayload.ts @@ -5,47 +5,11 @@ import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; 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"; + BenefitInput, + BenefitInput$inboundSchema, + BenefitInput$Outbound, + BenefitInput$outboundSchema, +} from "./benefitinput.js"; export const WebhookBenefitUpdatedPayloadType = { BenefitUpdated: "benefit.updated", @@ -54,15 +18,6 @@ export type WebhookBenefitUpdatedPayloadType = ClosedEnum< typeof WebhookBenefitUpdatedPayloadType >; -export type WebhookBenefitUpdatedPayloadBenefit = - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; - /** * Sent when a benefit is updated. * @@ -72,14 +27,7 @@ export type WebhookBenefitUpdatedPayloadBenefit = */ export type WebhookBenefitUpdatedPayload = { type?: "benefit.updated" | undefined; - data: - | BenefitArticles - | BenefitAds - | BenefitDiscordInput - | BenefitGitHubRepository - | BenefitDownloadables - | BenefitLicenseKeys - | BenefitCustom; + data: BenefitInput; }; /** @internal */ @@ -103,61 +51,6 @@ export namespace WebhookBenefitUpdatedPayloadType$ { export const outboundSchema = WebhookBenefitUpdatedPayloadType$outboundSchema; } -/** @internal */ -export const WebhookBenefitUpdatedPayloadBenefit$inboundSchema: z.ZodType< - WebhookBenefitUpdatedPayloadBenefit, - z.ZodTypeDef, - unknown -> = z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type WebhookBenefitUpdatedPayloadBenefit$Outbound = - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; - -/** @internal */ -export const WebhookBenefitUpdatedPayloadBenefit$outboundSchema: z.ZodType< - WebhookBenefitUpdatedPayloadBenefit$Outbound, - z.ZodTypeDef, - WebhookBenefitUpdatedPayloadBenefit -> = 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 WebhookBenefitUpdatedPayloadBenefit$ { - /** @deprecated use `WebhookBenefitUpdatedPayloadBenefit$inboundSchema` instead. */ - export const inboundSchema = - WebhookBenefitUpdatedPayloadBenefit$inboundSchema; - /** @deprecated use `WebhookBenefitUpdatedPayloadBenefit$outboundSchema` instead. */ - export const outboundSchema = - WebhookBenefitUpdatedPayloadBenefit$outboundSchema; - /** @deprecated use `WebhookBenefitUpdatedPayloadBenefit$Outbound` instead. */ - export type Outbound = WebhookBenefitUpdatedPayloadBenefit$Outbound; -} - /** @internal */ export const WebhookBenefitUpdatedPayload$inboundSchema: z.ZodType< WebhookBenefitUpdatedPayload, @@ -165,28 +58,13 @@ export const WebhookBenefitUpdatedPayload$inboundSchema: z.ZodType< unknown > = z.object({ type: z.literal("benefit.updated").optional(), - data: z.union([ - BenefitArticles$inboundSchema, - BenefitAds$inboundSchema, - BenefitDiscordInput$inboundSchema, - BenefitGitHubRepository$inboundSchema, - BenefitDownloadables$inboundSchema, - BenefitLicenseKeys$inboundSchema, - BenefitCustom$inboundSchema, - ]), + data: BenefitInput$inboundSchema, }); /** @internal */ export type WebhookBenefitUpdatedPayload$Outbound = { type: "benefit.updated"; - data: - | BenefitArticles$Outbound - | BenefitAds$Outbound - | BenefitDiscordInput$Outbound - | BenefitGitHubRepository$Outbound - | BenefitDownloadables$Outbound - | BenefitLicenseKeys$Outbound - | BenefitCustom$Outbound; + data: BenefitInput$Outbound; }; /** @internal */ @@ -196,15 +74,7 @@ export const WebhookBenefitUpdatedPayload$outboundSchema: z.ZodType< WebhookBenefitUpdatedPayload > = z.object({ type: z.literal("benefit.updated").default("benefit.updated"), - data: z.union([ - BenefitArticles$outboundSchema, - BenefitAds$outboundSchema, - BenefitDiscordInput$outboundSchema, - BenefitGitHubRepository$outboundSchema, - BenefitDownloadables$outboundSchema, - BenefitLicenseKeys$outboundSchema, - BenefitCustom$outboundSchema, - ]), + data: BenefitInput$outboundSchema, }); /** diff --git a/src/models/components/webhooksubscriptionactivepayload.ts b/src/models/components/webhooksubscriptionactivepayload.ts new file mode 100644 index 00000000..06e77985 --- /dev/null +++ b/src/models/components/webhooksubscriptionactivepayload.ts @@ -0,0 +1,95 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; +import { + SubscriptionInput, + SubscriptionInput$inboundSchema, + SubscriptionInput$Outbound, + SubscriptionInput$outboundSchema, +} from "./subscriptioninput.js"; + +export const WebhookSubscriptionActivePayloadType = { + SubscriptionActive: "subscription.active", +} as const; +export type WebhookSubscriptionActivePayloadType = ClosedEnum< + typeof WebhookSubscriptionActivePayloadType +>; + +/** + * Sent when a subscription becomes active, + * + * @remarks + * whether because it's a new paid subscription or because payment was recovered. + * + * **Discord & Slack support:** Full + */ +export type WebhookSubscriptionActivePayload = { + type?: "subscription.active" | undefined; + data: SubscriptionInput; +}; + +/** @internal */ +export const WebhookSubscriptionActivePayloadType$inboundSchema: + z.ZodNativeEnum = z.nativeEnum( + WebhookSubscriptionActivePayloadType, + ); + +/** @internal */ +export const WebhookSubscriptionActivePayloadType$outboundSchema: + z.ZodNativeEnum = + WebhookSubscriptionActivePayloadType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionActivePayloadType$ { + /** @deprecated use `WebhookSubscriptionActivePayloadType$inboundSchema` instead. */ + export const inboundSchema = + WebhookSubscriptionActivePayloadType$inboundSchema; + /** @deprecated use `WebhookSubscriptionActivePayloadType$outboundSchema` instead. */ + export const outboundSchema = + WebhookSubscriptionActivePayloadType$outboundSchema; +} + +/** @internal */ +export const WebhookSubscriptionActivePayload$inboundSchema: z.ZodType< + WebhookSubscriptionActivePayload, + z.ZodTypeDef, + unknown +> = z.object({ + type: z.literal("subscription.active").optional(), + data: SubscriptionInput$inboundSchema, +}); + +/** @internal */ +export type WebhookSubscriptionActivePayload$Outbound = { + type: "subscription.active"; + data: SubscriptionInput$Outbound; +}; + +/** @internal */ +export const WebhookSubscriptionActivePayload$outboundSchema: z.ZodType< + WebhookSubscriptionActivePayload$Outbound, + z.ZodTypeDef, + WebhookSubscriptionActivePayload +> = z.object({ + type: z.literal("subscription.active").default("subscription.active"), + data: SubscriptionInput$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionActivePayload$ { + /** @deprecated use `WebhookSubscriptionActivePayload$inboundSchema` instead. */ + export const inboundSchema = WebhookSubscriptionActivePayload$inboundSchema; + /** @deprecated use `WebhookSubscriptionActivePayload$outboundSchema` instead. */ + export const outboundSchema = WebhookSubscriptionActivePayload$outboundSchema; + /** @deprecated use `WebhookSubscriptionActivePayload$Outbound` instead. */ + export type Outbound = WebhookSubscriptionActivePayload$Outbound; +} diff --git a/src/models/components/webhooksubscriptioncanceledpayload.ts b/src/models/components/webhooksubscriptioncanceledpayload.ts new file mode 100644 index 00000000..c18236c1 --- /dev/null +++ b/src/models/components/webhooksubscriptioncanceledpayload.ts @@ -0,0 +1,96 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; +import { + SubscriptionInput, + SubscriptionInput$inboundSchema, + SubscriptionInput$Outbound, + SubscriptionInput$outboundSchema, +} from "./subscriptioninput.js"; + +export const WebhookSubscriptionCanceledPayloadType = { + SubscriptionCanceled: "subscription.canceled", +} as const; +export type WebhookSubscriptionCanceledPayloadType = ClosedEnum< + typeof WebhookSubscriptionCanceledPayloadType +>; + +/** + * Sent when a subscription is canceled by the user. + * + * @remarks + * They might still have access until the end of the current period. + * + * **Discord & Slack support:** Full + */ +export type WebhookSubscriptionCanceledPayload = { + type?: "subscription.canceled" | undefined; + data: SubscriptionInput; +}; + +/** @internal */ +export const WebhookSubscriptionCanceledPayloadType$inboundSchema: + z.ZodNativeEnum = z.nativeEnum( + WebhookSubscriptionCanceledPayloadType, + ); + +/** @internal */ +export const WebhookSubscriptionCanceledPayloadType$outboundSchema: + z.ZodNativeEnum = + WebhookSubscriptionCanceledPayloadType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionCanceledPayloadType$ { + /** @deprecated use `WebhookSubscriptionCanceledPayloadType$inboundSchema` instead. */ + export const inboundSchema = + WebhookSubscriptionCanceledPayloadType$inboundSchema; + /** @deprecated use `WebhookSubscriptionCanceledPayloadType$outboundSchema` instead. */ + export const outboundSchema = + WebhookSubscriptionCanceledPayloadType$outboundSchema; +} + +/** @internal */ +export const WebhookSubscriptionCanceledPayload$inboundSchema: z.ZodType< + WebhookSubscriptionCanceledPayload, + z.ZodTypeDef, + unknown +> = z.object({ + type: z.literal("subscription.canceled").optional(), + data: SubscriptionInput$inboundSchema, +}); + +/** @internal */ +export type WebhookSubscriptionCanceledPayload$Outbound = { + type: "subscription.canceled"; + data: SubscriptionInput$Outbound; +}; + +/** @internal */ +export const WebhookSubscriptionCanceledPayload$outboundSchema: z.ZodType< + WebhookSubscriptionCanceledPayload$Outbound, + z.ZodTypeDef, + WebhookSubscriptionCanceledPayload +> = z.object({ + type: z.literal("subscription.canceled").default("subscription.canceled"), + data: SubscriptionInput$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionCanceledPayload$ { + /** @deprecated use `WebhookSubscriptionCanceledPayload$inboundSchema` instead. */ + export const inboundSchema = WebhookSubscriptionCanceledPayload$inboundSchema; + /** @deprecated use `WebhookSubscriptionCanceledPayload$outboundSchema` instead. */ + export const outboundSchema = + WebhookSubscriptionCanceledPayload$outboundSchema; + /** @deprecated use `WebhookSubscriptionCanceledPayload$Outbound` instead. */ + export type Outbound = WebhookSubscriptionCanceledPayload$Outbound; +} diff --git a/src/models/components/webhooksubscriptionrevokedpayload.ts b/src/models/components/webhooksubscriptionrevokedpayload.ts new file mode 100644 index 00000000..0aa3d186 --- /dev/null +++ b/src/models/components/webhooksubscriptionrevokedpayload.ts @@ -0,0 +1,96 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { ClosedEnum } from "../../types/enums.js"; +import { + SubscriptionInput, + SubscriptionInput$inboundSchema, + SubscriptionInput$Outbound, + SubscriptionInput$outboundSchema, +} from "./subscriptioninput.js"; + +export const WebhookSubscriptionRevokedPayloadType = { + SubscriptionRevoked: "subscription.revoked", +} as const; +export type WebhookSubscriptionRevokedPayloadType = ClosedEnum< + typeof WebhookSubscriptionRevokedPayloadType +>; + +/** + * Sent when a subscription is revoked, the user looses access immediately. + * + * @remarks + * Happens when the subscription is canceled, or payment is past due. + * + * **Discord & Slack support:** Full + */ +export type WebhookSubscriptionRevokedPayload = { + type?: "subscription.revoked" | undefined; + data: SubscriptionInput; +}; + +/** @internal */ +export const WebhookSubscriptionRevokedPayloadType$inboundSchema: + z.ZodNativeEnum = z.nativeEnum( + WebhookSubscriptionRevokedPayloadType, + ); + +/** @internal */ +export const WebhookSubscriptionRevokedPayloadType$outboundSchema: + z.ZodNativeEnum = + WebhookSubscriptionRevokedPayloadType$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionRevokedPayloadType$ { + /** @deprecated use `WebhookSubscriptionRevokedPayloadType$inboundSchema` instead. */ + export const inboundSchema = + WebhookSubscriptionRevokedPayloadType$inboundSchema; + /** @deprecated use `WebhookSubscriptionRevokedPayloadType$outboundSchema` instead. */ + export const outboundSchema = + WebhookSubscriptionRevokedPayloadType$outboundSchema; +} + +/** @internal */ +export const WebhookSubscriptionRevokedPayload$inboundSchema: z.ZodType< + WebhookSubscriptionRevokedPayload, + z.ZodTypeDef, + unknown +> = z.object({ + type: z.literal("subscription.revoked").optional(), + data: SubscriptionInput$inboundSchema, +}); + +/** @internal */ +export type WebhookSubscriptionRevokedPayload$Outbound = { + type: "subscription.revoked"; + data: SubscriptionInput$Outbound; +}; + +/** @internal */ +export const WebhookSubscriptionRevokedPayload$outboundSchema: z.ZodType< + WebhookSubscriptionRevokedPayload$Outbound, + z.ZodTypeDef, + WebhookSubscriptionRevokedPayload +> = z.object({ + type: z.literal("subscription.revoked").default("subscription.revoked"), + data: SubscriptionInput$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace WebhookSubscriptionRevokedPayload$ { + /** @deprecated use `WebhookSubscriptionRevokedPayload$inboundSchema` instead. */ + export const inboundSchema = WebhookSubscriptionRevokedPayload$inboundSchema; + /** @deprecated use `WebhookSubscriptionRevokedPayload$outboundSchema` instead. */ + export const outboundSchema = + WebhookSubscriptionRevokedPayload$outboundSchema; + /** @deprecated use `WebhookSubscriptionRevokedPayload$Outbound` instead. */ + export type Outbound = WebhookSubscriptionRevokedPayload$Outbound; +} diff --git a/src/models/components/webhooksubscriptionupdatedpayload.ts b/src/models/components/webhooksubscriptionupdatedpayload.ts index 161747d6..80b9f9fa 100644 --- a/src/models/components/webhooksubscriptionupdatedpayload.ts +++ b/src/models/components/webhooksubscriptionupdatedpayload.ts @@ -19,11 +19,15 @@ export type WebhookSubscriptionUpdatedPayloadType = ClosedEnum< >; /** - * Sent when a new subscription is updated. This event fires if the subscription is cancelled, both immediately and if the subscription is cancelled at the end of the current period. + * Sent when a subscription is updated. This event fires for all changes to the subscription, including renewals. * * @remarks * - * **Discord & Slack support:** On cancellation + * If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, and `subscription.revoked`. + * + * To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field. + * + * **Discord & Slack support:** On cancellation and revocation. Renewals are skipped. */ export type WebhookSubscriptionUpdatedPayload = { type?: "subscription.updated" | undefined; diff --git a/src/models/operations/articlesexport.ts b/src/models/operations/articlesexport.ts new file mode 100644 index 00000000..fac4fe96 --- /dev/null +++ b/src/models/operations/articlesexport.ts @@ -0,0 +1,54 @@ +/* + * 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 ArticlesExportRequest = { + organizationId: string; +}; + +/** @internal */ +export const ArticlesExportRequest$inboundSchema: z.ZodType< + ArticlesExportRequest, + z.ZodTypeDef, + unknown +> = z.object({ + organization_id: z.string(), +}).transform((v) => { + return remap$(v, { + "organization_id": "organizationId", + }); +}); + +/** @internal */ +export type ArticlesExportRequest$Outbound = { + organization_id: string; +}; + +/** @internal */ +export const ArticlesExportRequest$outboundSchema: z.ZodType< + ArticlesExportRequest$Outbound, + z.ZodTypeDef, + ArticlesExportRequest +> = z.object({ + organizationId: z.string(), +}).transform((v) => { + return remap$(v, { + 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 ArticlesExportRequest$ { + /** @deprecated use `ArticlesExportRequest$inboundSchema` instead. */ + export const inboundSchema = ArticlesExportRequest$inboundSchema; + /** @deprecated use `ArticlesExportRequest$outboundSchema` instead. */ + export const outboundSchema = ArticlesExportRequest$outboundSchema; + /** @deprecated use `ArticlesExportRequest$Outbound` instead. */ + export type Outbound = ArticlesExportRequest$Outbound; +} diff --git a/src/models/operations/benefitscreate.ts b/src/models/operations/benefitscreate.ts index 72b71b23..5c34bb94 100644 --- a/src/models/operations/benefitscreate.ts +++ b/src/models/operations/benefitscreate.ts @@ -13,18 +13,6 @@ export type BenefitsCreateBenefitCreate = | (components.BenefitLicenseKeysCreate & { type: "license_keys" }) | (components.BenefitCustomCreate & { type: "custom" }); -/** - * Benefit created. - */ -export type BenefitsCreateResponseBenefitsCreate = - | components.BenefitArticles - | components.BenefitAds - | components.BenefitDiscord - | components.BenefitGitHubRepository - | components.BenefitDownloadables - | components.BenefitLicenseKeys - | components.BenefitCustom; - /** @internal */ export const BenefitsCreateBenefitCreate$inboundSchema: z.ZodType< BenefitsCreateBenefitCreate, @@ -120,58 +108,3 @@ export namespace BenefitsCreateBenefitCreate$ { /** @deprecated use `BenefitsCreateBenefitCreate$Outbound` instead. */ export type Outbound = BenefitsCreateBenefitCreate$Outbound; } - -/** @internal */ -export const BenefitsCreateResponseBenefitsCreate$inboundSchema: z.ZodType< - BenefitsCreateResponseBenefitsCreate, - z.ZodTypeDef, - unknown -> = z.union([ - components.BenefitArticles$inboundSchema, - components.BenefitAds$inboundSchema, - components.BenefitDiscord$inboundSchema, - components.BenefitGitHubRepository$inboundSchema, - components.BenefitDownloadables$inboundSchema, - components.BenefitLicenseKeys$inboundSchema, - components.BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type BenefitsCreateResponseBenefitsCreate$Outbound = - | components.BenefitArticles$Outbound - | components.BenefitAds$Outbound - | components.BenefitDiscord$Outbound - | components.BenefitGitHubRepository$Outbound - | components.BenefitDownloadables$Outbound - | components.BenefitLicenseKeys$Outbound - | components.BenefitCustom$Outbound; - -/** @internal */ -export const BenefitsCreateResponseBenefitsCreate$outboundSchema: z.ZodType< - BenefitsCreateResponseBenefitsCreate$Outbound, - z.ZodTypeDef, - BenefitsCreateResponseBenefitsCreate -> = z.union([ - components.BenefitArticles$outboundSchema, - components.BenefitAds$outboundSchema, - components.BenefitDiscord$outboundSchema, - components.BenefitGitHubRepository$outboundSchema, - components.BenefitDownloadables$outboundSchema, - components.BenefitLicenseKeys$outboundSchema, - components.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 BenefitsCreateResponseBenefitsCreate$ { - /** @deprecated use `BenefitsCreateResponseBenefitsCreate$inboundSchema` instead. */ - export const inboundSchema = - BenefitsCreateResponseBenefitsCreate$inboundSchema; - /** @deprecated use `BenefitsCreateResponseBenefitsCreate$outboundSchema` instead. */ - export const outboundSchema = - BenefitsCreateResponseBenefitsCreate$outboundSchema; - /** @deprecated use `BenefitsCreateResponseBenefitsCreate$Outbound` instead. */ - export type Outbound = BenefitsCreateResponseBenefitsCreate$Outbound; -} diff --git a/src/models/operations/benefitsget.ts b/src/models/operations/benefitsget.ts index 4a8afea3..ff9d6e1b 100644 --- a/src/models/operations/benefitsget.ts +++ b/src/models/operations/benefitsget.ts @@ -3,24 +3,11 @@ */ import * as z from "zod"; -import * as components from "../components/index.js"; export type BenefitsGetRequest = { id: string; }; -/** - * Successful Response - */ -export type BenefitsGetResponseBenefitsGet = - | components.BenefitArticles - | components.BenefitAds - | components.BenefitDiscord - | components.BenefitGitHubRepository - | components.BenefitDownloadables - | components.BenefitLicenseKeys - | components.BenefitCustom; - /** @internal */ export const BenefitsGetRequest$inboundSchema: z.ZodType< BenefitsGetRequest, @@ -56,56 +43,3 @@ export namespace BenefitsGetRequest$ { /** @deprecated use `BenefitsGetRequest$Outbound` instead. */ export type Outbound = BenefitsGetRequest$Outbound; } - -/** @internal */ -export const BenefitsGetResponseBenefitsGet$inboundSchema: z.ZodType< - BenefitsGetResponseBenefitsGet, - z.ZodTypeDef, - unknown -> = z.union([ - components.BenefitArticles$inboundSchema, - components.BenefitAds$inboundSchema, - components.BenefitDiscord$inboundSchema, - components.BenefitGitHubRepository$inboundSchema, - components.BenefitDownloadables$inboundSchema, - components.BenefitLicenseKeys$inboundSchema, - components.BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type BenefitsGetResponseBenefitsGet$Outbound = - | components.BenefitArticles$Outbound - | components.BenefitAds$Outbound - | components.BenefitDiscord$Outbound - | components.BenefitGitHubRepository$Outbound - | components.BenefitDownloadables$Outbound - | components.BenefitLicenseKeys$Outbound - | components.BenefitCustom$Outbound; - -/** @internal */ -export const BenefitsGetResponseBenefitsGet$outboundSchema: z.ZodType< - BenefitsGetResponseBenefitsGet$Outbound, - z.ZodTypeDef, - BenefitsGetResponseBenefitsGet -> = z.union([ - components.BenefitArticles$outboundSchema, - components.BenefitAds$outboundSchema, - components.BenefitDiscord$outboundSchema, - components.BenefitGitHubRepository$outboundSchema, - components.BenefitDownloadables$outboundSchema, - components.BenefitLicenseKeys$outboundSchema, - components.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 BenefitsGetResponseBenefitsGet$ { - /** @deprecated use `BenefitsGetResponseBenefitsGet$inboundSchema` instead. */ - export const inboundSchema = BenefitsGetResponseBenefitsGet$inboundSchema; - /** @deprecated use `BenefitsGetResponseBenefitsGet$outboundSchema` instead. */ - export const outboundSchema = BenefitsGetResponseBenefitsGet$outboundSchema; - /** @deprecated use `BenefitsGetResponseBenefitsGet$Outbound` instead. */ - export type Outbound = BenefitsGetResponseBenefitsGet$Outbound; -} diff --git a/src/models/operations/benefitsupdate.ts b/src/models/operations/benefitsupdate.ts index cec3b2b0..c3380bf2 100644 --- a/src/models/operations/benefitsupdate.ts +++ b/src/models/operations/benefitsupdate.ts @@ -27,18 +27,6 @@ export type BenefitsUpdateRequest = { | components.BenefitLicenseKeysUpdate; }; -/** - * Benefit updated. - */ -export type BenefitsUpdateResponseBenefitsUpdate = - | components.BenefitArticles - | components.BenefitAds - | components.BenefitDiscord - | components.BenefitGitHubRepository - | components.BenefitDownloadables - | components.BenefitLicenseKeys - | components.BenefitCustom; - /** @internal */ export const BenefitsUpdateBenefitUpdate$inboundSchema: z.ZodType< BenefitsUpdateBenefitUpdate, @@ -161,58 +149,3 @@ export namespace BenefitsUpdateRequest$ { /** @deprecated use `BenefitsUpdateRequest$Outbound` instead. */ export type Outbound = BenefitsUpdateRequest$Outbound; } - -/** @internal */ -export const BenefitsUpdateResponseBenefitsUpdate$inboundSchema: z.ZodType< - BenefitsUpdateResponseBenefitsUpdate, - z.ZodTypeDef, - unknown -> = z.union([ - components.BenefitArticles$inboundSchema, - components.BenefitAds$inboundSchema, - components.BenefitDiscord$inboundSchema, - components.BenefitGitHubRepository$inboundSchema, - components.BenefitDownloadables$inboundSchema, - components.BenefitLicenseKeys$inboundSchema, - components.BenefitCustom$inboundSchema, -]); - -/** @internal */ -export type BenefitsUpdateResponseBenefitsUpdate$Outbound = - | components.BenefitArticles$Outbound - | components.BenefitAds$Outbound - | components.BenefitDiscord$Outbound - | components.BenefitGitHubRepository$Outbound - | components.BenefitDownloadables$Outbound - | components.BenefitLicenseKeys$Outbound - | components.BenefitCustom$Outbound; - -/** @internal */ -export const BenefitsUpdateResponseBenefitsUpdate$outboundSchema: z.ZodType< - BenefitsUpdateResponseBenefitsUpdate$Outbound, - z.ZodTypeDef, - BenefitsUpdateResponseBenefitsUpdate -> = z.union([ - components.BenefitArticles$outboundSchema, - components.BenefitAds$outboundSchema, - components.BenefitDiscord$outboundSchema, - components.BenefitGitHubRepository$outboundSchema, - components.BenefitDownloadables$outboundSchema, - components.BenefitLicenseKeys$outboundSchema, - components.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 BenefitsUpdateResponseBenefitsUpdate$ { - /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$inboundSchema` instead. */ - export const inboundSchema = - BenefitsUpdateResponseBenefitsUpdate$inboundSchema; - /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$outboundSchema` instead. */ - export const outboundSchema = - BenefitsUpdateResponseBenefitsUpdate$outboundSchema; - /** @deprecated use `BenefitsUpdateResponseBenefitsUpdate$Outbound` instead. */ - export type Outbound = BenefitsUpdateResponseBenefitsUpdate$Outbound; -} diff --git a/src/models/operations/index.ts b/src/models/operations/index.ts index 182f1634..b288542e 100644 --- a/src/models/operations/index.ts +++ b/src/models/operations/index.ts @@ -5,6 +5,7 @@ export * from "./advertisementsget.js"; export * from "./advertisementslist.js"; export * from "./articlesdelete.js"; +export * from "./articlesexport.js"; export * from "./articlesget.js"; export * from "./articleslist.js"; export * from "./articlespreview.js"; diff --git a/src/models/operations/metricsget.ts b/src/models/operations/metricsget.ts index 294d4fed..e44cdf33 100644 --- a/src/models/operations/metricsget.ts +++ b/src/models/operations/metricsget.ts @@ -4,25 +4,9 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; -import { ClosedEnum } from "../../types/enums.js"; import { RFCDate } from "../../types/rfcdate.js"; import * as components from "../components/index.js"; -/** - * Interval between two timestamps. - */ -export const Interval = { - Year: "year", - Month: "month", - Week: "week", - Day: "day", - Hour: "hour", -} as const; -/** - * Interval between two timestamps. - */ -export type Interval = ClosedEnum; - /** * Filter by organization ID. */ @@ -52,7 +36,7 @@ export type MetricsGetRequest = { /** * Interval between two timestamps. */ - interval: Interval; + interval: components.Interval; /** * Filter by organization ID. */ @@ -71,25 +55,6 @@ export type MetricsGetRequest = { | undefined; }; -/** @internal */ -export const Interval$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(Interval); - -/** @internal */ -export const Interval$outboundSchema: z.ZodNativeEnum = - Interval$inboundSchema; - -/** - * @internal - * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. - */ -export namespace Interval$ { - /** @deprecated use `Interval$inboundSchema` instead. */ - export const inboundSchema = Interval$inboundSchema; - /** @deprecated use `Interval$outboundSchema` instead. */ - export const outboundSchema = Interval$outboundSchema; -} - /** @internal */ export const MetricsGetQueryParamOrganizationIDFilter$inboundSchema: z.ZodType< MetricsGetQueryParamOrganizationIDFilter, @@ -205,7 +170,7 @@ export const MetricsGetRequest$inboundSchema: z.ZodType< > = z.object({ start_date: z.string().transform(v => new RFCDate(v)), end_date: z.string().transform(v => new RFCDate(v)), - interval: Interval$inboundSchema, + interval: components.Interval$inboundSchema, organization_id: z.nullable(z.union([z.string(), z.array(z.string())])) .optional(), product_id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(), @@ -243,7 +208,7 @@ export const MetricsGetRequest$outboundSchema: z.ZodType< > = z.object({ startDate: z.instanceof(RFCDate).transform(v => v.toString()), endDate: z.instanceof(RFCDate).transform(v => v.toString()), - interval: Interval$outboundSchema, + interval: components.Interval$outboundSchema, organizationId: z.nullable(z.union([z.string(), z.array(z.string())])) .optional(), productId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(), diff --git a/src/sdk/articles.ts b/src/sdk/articles.ts index ace9b726..376ce3bc 100644 --- a/src/sdk/articles.ts +++ b/src/sdk/articles.ts @@ -4,6 +4,7 @@ import { articlesCreate } from "../funcs/articlesCreate.js"; import { articlesDelete } from "../funcs/articlesDelete.js"; +import { articlesExport } from "../funcs/articlesExport.js"; import { articlesGet } from "../funcs/articlesGet.js"; import { articlesList } from "../funcs/articlesList.js"; import { articlesPreview } from "../funcs/articlesPreview.js"; @@ -51,6 +52,23 @@ export class Articles extends ClientSDK { )); } + /** + * Export Articles + * + * @remarks + * Export organization articles. + */ + async export( + request: operations.ArticlesExportRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(articlesExport( + this, + request, + options, + )); + } + /** * Get Article * diff --git a/src/sdk/benefits.ts b/src/sdk/benefits.ts index 46818783..a413274f 100644 --- a/src/sdk/benefits.ts +++ b/src/sdk/benefits.ts @@ -9,6 +9,7 @@ import { benefitsGrants } from "../funcs/benefitsGrants.js"; import { benefitsList } from "../funcs/benefitsList.js"; import { benefitsUpdate } from "../funcs/benefitsUpdate.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; +import * as components from "../models/components/index.js"; import * as operations from "../models/operations/index.js"; import { unwrapAsync } from "../types/fp.js"; import { PageIterator, unwrapResultIterator } from "../types/operations.js"; @@ -40,7 +41,7 @@ export class Benefits extends ClientSDK { async create( request: operations.BenefitsCreateBenefitCreate, options?: RequestOptions, - ): Promise { + ): Promise { return unwrapAsync(benefitsCreate( this, request, @@ -57,7 +58,7 @@ export class Benefits extends ClientSDK { async get( request: operations.BenefitsGetRequest, options?: RequestOptions, - ): Promise { + ): Promise { return unwrapAsync(benefitsGet( this, request, @@ -74,7 +75,7 @@ export class Benefits extends ClientSDK { async update( request: operations.BenefitsUpdateRequest, options?: RequestOptions, - ): Promise { + ): Promise { return unwrapAsync(benefitsUpdate( this, request,