paddle/customers

Types

PaddleCustomer = object of PaddleBaseObject
  email*: string             ## The customer's email address
  name*: string              ## The customer's full name
  locate*: string            ## Valid IETF BCP 47 short form locale tag. If omitted, defaults to `en`

Procs

proc genAuthToken(client: PaddleClient; customerId: PaddleEntryID): Future[
    ApiResponseData[PaddleCustomerToken]] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Generates a customer authentication token.
proc getCustomer(client: PaddleClient; id: PaddleEntryID): Future[
    PaddleApiResponse[PaddleCustomer]] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Retrieves a single customer by its unique identifier.
proc getCustomers(client: PaddleClient): Future[
    PaddleApiResponse[seq[PaddleCustomer]]] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Retrieves a list of customers.
proc patchCustomer(client: PaddleClient; id: PaddleEntryID;
                   email: Option[string] = none(string);
                   name: Option[string] = none(string);
                   locale: Option[string] = none(string)): Future[
    PaddleApiResponse[PaddleCustomer]] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Updates an existing customer with the specified parameters.
proc postCustomer(client: PaddleClient; email: string; name: string;
                  locale: Option[string] = none(string)): Future[
    PaddleApiResponse[PaddleCustomer]] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Creates a new customer with the specified parameters.