Index

Modules: gumroad, gumroad/api, gumroad/earnings, gumroad/files, gumroad/licenses, gumroad/products.

API symbols

`$`:

• api: proc `$`(query: var QueryTable): string

abortAccepted:

• files: GumroadFileAbortStatus.abortAccepted

abortAlreadyGone:

• files: GumroadFileAbortStatus.abortAlreadyGone

addAccessToken:

• api: proc addAccessToken(query: var QueryTable; client: GumroadClient)

aud:

• products: GumroadCurrency.aud

brl:

• products: GumroadCurrency.brl

cad:

• products: GumroadCurrency.cad

chf:

• products: GumroadCurrency.chf

configureOAuth:

• api: proc configureOAuth(client: GumroadClient; clientId, clientSecret: string)

czk:

• products: GumroadCurrency.czk

deleteOfferCode:

• products: proc deleteOfferCode(client: GumroadClient; productId, offerCodeId: string): Future[ GumroadApiResponseDeleteOfferCode]

deleteProductCover:

• products: proc deleteProductCover(client: GumroadClient; productId, coverId: string): Future[ GumroadApiResponseProductsCovers]

deleteProductCustomField:

• products: proc deleteProductCustomField(client: GumroadClient; productId, fieldName: string): Future[ GumroadApiResponseDeleteProductCustomField]

durationAnnually:

• products: GumroadSubscriptionDuration.durationAnnually

durationBiannually:

• products: GumroadSubscriptionDuration.durationBiannually

durationEveryTwoYears:

• products: GumroadSubscriptionDuration.durationEveryTwoYears

durationMonthly:

• products: GumroadSubscriptionDuration.durationMonthly

durationQuarterly:

• products: GumroadSubscriptionDuration.durationQuarterly

eur:

• products: GumroadCurrency.eur

exchangeCodeForToken:

• api: proc exchangeCodeForToken(clientId, clientSecret, code, redirectUri: string): Future[ JsonNode]

gbp:

• products: GumroadCurrency.gbp

getAuthorizationUrl:

• api: proc getAuthorizationUrl(clientId, redirectUri: string; scopes: seq[GumroadScope]; state = ""): string

getEarnings:

• earnings: proc getEarnings(client: GumroadClient; year: int): Future[GumroadApiResponseEarnings]

getOfferCode:

• products: proc getOfferCode(client: GumroadClient; productId, offerCodeId: string): Future[ GumroadApiResponseOfferCode]

getOfferCodes:

• products: proc getOfferCodes(client: GumroadClient; productId: string): Future[ GumroadApiResponseOfferCodes]

getProduct:

• products: proc getProduct(client: GumroadClient; productId: string): Future[GumroadProduct]

getProductCustomFields:

• products: proc getProductCustomFields(client: GumroadClient; productId: string): Future[ GumroadApiResponseProductsCustomFields]

getProducts:

• products: proc getProducts(client: GumroadClient): Future[GumroadApiResponseProducts]

GumroadApiResponseDeleteOfferCode:

• products: object GumroadApiResponseDeleteOfferCode

GumroadApiResponseDeleteProductCustomField:

• products: object GumroadApiResponseDeleteProductCustomField

GumroadApiResponseEarnings:

• earnings: object GumroadApiResponseEarnings

GumroadApiResponseFileAbort:

• files: object GumroadApiResponseFileAbort

GumroadApiResponseFileComplete:

• files: object GumroadApiResponseFileComplete

GumroadApiResponseFilePresign:

• files: object GumroadApiResponseFilePresign

GumroadApiResponseOfferCode:

• products: object GumroadApiResponseOfferCode

GumroadApiResponseOfferCodes:

• products: object GumroadApiResponseOfferCodes

GumroadApiResponseProduct:

• products: object GumroadApiResponseProduct

GumroadApiResponseProducts:

• products: object GumroadApiResponseProducts

GumroadApiResponseProductsCovers:

• products: object GumroadApiResponseProductsCovers

GumroadApiResponseProductsCustomField:

• products: object GumroadApiResponseProductsCustomField

GumroadApiResponseProductsCustomFields:

• products: object GumroadApiResponseProductsCustomFields

GumroadCard:

• licenses: object GumroadCard

GumroadClient:

• api: type GumroadClient

GumroadClientError:

• api: object GumroadClientError

GumroadCurrency:

• products: enum GumroadCurrency

GumroadCustomField:

• licenses: object GumroadCustomField

GumroadFileAbortStatus:

• files: enum GumroadFileAbortStatus

GumroadFileCompletePart:

• files: object GumroadFileCompletePart

GumroadFilePresignPart:

• files: object GumroadFilePresignPart

GumroadLicense:

• licenses: object GumroadLicense

GumroadMaxFileSizeBytes:

• files: const GumroadMaxFileSizeBytes

GumroadOfferCode:

• products: object GumroadOfferCode

GumroadProduct:

• products: object GumroadProduct

GumroadProductBundleProduct:

• products: object GumroadProductBundleProduct

GumroadProductCover:

• products: object GumroadProductCover

GumroadProductCustomField:

• products: object GumroadProductCustomField

GumroadProductNew:

• products: object GumroadProductNew

GumroadProductType:

• products: enum GumroadProductType

GumroadPurchase:

• licenses: object GumroadPurchase

GumroadScope:

• api: enum GumroadScope

GumroadSubscriptionDuration:

• products: enum GumroadSubscriptionDuration

hkd:

• products: GumroadCurrency.hkd

HTMLContent:

• products: type HTMLContent

httpDelete:

• api: proc httpDelete(client: GumroadClient; endpoint: string): Future[AsyncResponse]

httpGet:

• api: proc httpGet(client: GumroadClient; endpoint: string): Future[AsyncResponse]
• api: proc httpGet(client: GumroadClient; endpoint: string; query: var QueryTable): Future[ AsyncResponse]

httpPost:

• api: proc httpPost(client: GumroadClient; endpoint: string): Future[AsyncResponse]
• api: proc httpPost(client: GumroadClient; endpoint: string; query: var QueryTable): Future[ AsyncResponse]
• api: proc httpPost[T](client: GumroadClient; endpoint: string; body: T): Future[ AsyncResponse]

httpPut:

• api: proc httpPut(client: GumroadClient; endpoint: string; query: var QueryTable): Future[ AsyncResponse]
• api: proc httpPut[T](client: GumroadClient; endpoint: string; body: T): Future[ AsyncResponse]

ils:

• products: GumroadCurrency.ils

initGumroadClient:

• api: proc initGumroadClient(): GumroadClient

inr:

• products: GumroadCurrency.inr

isEmpty:

• products: proc isEmpty(res: GumroadApiResponseProducts): bool

isGone:

• files: proc isGone(res: GumroadApiResponseFileAbort): bool

jpy:

• products: GumroadCurrency.jpy

krw:

• products: GumroadCurrency.krw

len:

• products: proc len(res: GumroadApiResponseProducts): int

nzd:

• products: GumroadCurrency.nzd

php:

• products: GumroadCurrency.php

pln:

• products: GumroadCurrency.pln

postAbortFileUpload:

• files: proc postAbortFileUpload(client: GumroadClient; uploadId, key: string): Future[ GumroadApiResponseFileAbort]

postCompleteFileUpload:

• files: proc postCompleteFileUpload(client: GumroadClient; uploadId, key: string; parts: seq[GumroadFileCompletePart]): Future[ GumroadApiResponseFileComplete]

postLicense:

• licenses: proc postLicense(client: GumroadClient; productId, licenseKey: string; incrementUses: Option[bool] = none(bool)): Future[GumroadLicense]

postOfferCode:

• products: proc postOfferCode(client: GumroadClient; productId, name: string; amountOff: int; offerType: Option[string] = none(string); maxPurchaseCount: Option[int] = none(int); universal: Option[bool] = none(bool)): Future[ GumroadApiResponseOfferCode]

postPresignFile:

• files: proc postPresignFile(client: GumroadClient; filename: string; fileSize: int64): Future[ GumroadApiResponseFilePresign]

postProduct:

• products: proc postProduct(client: GumroadClient; product: GumroadProductNew): Future[ GumroadProduct]

postProductCover:

• products: proc postProductCover(client: GumroadClient; productId, url: string): Future[ GumroadApiResponseProductsCovers]

postProductCustomField:

• products: proc postProductCustomField(client: GumroadClient; productId, name: string; required: bool; variant: Option[string] = none(string)): Future[ GumroadApiResponseProductsCustomField]

productBundle:

• products: GumroadProductType.productBundle

productCall:

• products: GumroadProductType.productCall

productCoffee:

• products: GumroadProductType.productCoffee

productCommission:

• products: GumroadProductType.productCommission

productCourse:

• products: GumroadProductType.productCourse

productDigital:

• products: GumroadProductType.productDigital

productEbook:

• products: GumroadProductType.productEbook

productMembership:

• products: GumroadProductType.productMembership

ProseMirrorDocument:

• products: object ProseMirrorDocument

putLicenseDecrementUses:

• licenses: proc putLicenseDecrementUses(client: GumroadClient; productId, licenseKey: string): Future[ GumroadLicense]

putLicenseDisable:

• licenses: proc putLicenseDisable(client: GumroadClient; productId, licenseKey: string): Future[ GumroadLicense]

putLicenseEnable:

• licenses: proc putLicenseEnable(client: GumroadClient; productId, licenseKey: string): Future[ GumroadLicense]

putOfferCode:

• products: proc putOfferCode(client: GumroadClient; productId, offerCodeId: string; maxPurchaseCount: Option[int]): Future[GumroadApiResponseOfferCode]

putProductCustomField:

• products: proc putProductCustomField(client: GumroadClient; productId, fieldName: string; required: bool; variant, name: Option[string] = none(string)): Future[ GumroadApiResponseProductsCustomField]

QueryTable:

• api: type QueryTable

refreshAccessToken:

• api: proc refreshAccessToken(clientId, clientSecret, refreshToken: string): Future[ JsonNode]

scopeAccount:

• api: GumroadScope.scopeAccount

scopeEditProducts:

• api: GumroadScope.scopeEditProducts

scopeEditSales:

• api: GumroadScope.scopeEditSales

scopeMarkSalesAsShipped:

• api: GumroadScope.scopeMarkSalesAsShipped

scopeViewPayouts:

• api: GumroadScope.scopeViewPayouts

scopeViewProfile:

• api: GumroadScope.scopeViewProfile

scopeViewSales:

• api: GumroadScope.scopeViewSales

scopeViewTaxData:

• api: GumroadScope.scopeViewTaxData

setTokens:

• api: proc setTokens(client: GumroadClient; accessToken, refreshToken: string; expiresIn: Option[int] = none(int))

sgd:

• products: GumroadCurrency.sgd

shouldRetry:

• files: proc shouldRetry(res: GumroadApiResponseFileAbort): bool

twd:

• products: GumroadCurrency.twd

usd:

• products: GumroadCurrency.usd

zar:

• products: GumroadCurrency.zar