Liking cljdoc? Tell your friends :D

telegrambot-lib.payments.core

Telegram Payments - function implementations.

Most functions are multi-arity with the following options:

  • Send all parameters in a 'content' map.
  • Send only the required parameters as simple values.
  • Send the required paraemters as simple values and then 'optional' parameters in a map.
Telegram Payments - function implementations.
- <https://core.telegram.org/bots/api#payments>

Most functions are multi-arity with the following options:
- Send all parameters in a 'content' map.
- Send only the required parameters as simple values.
- Send the required paraemters as simple values and then 'optional' parameters in a map.
raw docstring

answer-precheckout-query-errorclj

(answer-precheckout-query-error this content)
(answer-precheckout-query-error this pre_checkout_query_id error_message)

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Sets 'ok' param to false.

Required

  • this ; a bot instance
  • pre_checkout_query_id ; id of query to be answered
  • ok ; true if all is good (in stock, etc) and bot is ready to proceed with order (auto set by this function)
  • error_message ; Required if 'ok' is false, message why checkout cannot proceed
Once the user has confirmed their payment and shipping details,
the Bot API sends the final confirmation in the form of an Update
with the field pre_checkout_query.
Use this method to respond to such pre-checkout queries.
On success, True is returned.
Sets 'ok' param to false.

Required
- this ; a bot instance
- pre_checkout_query_id ; id of query to be answered
- ok ; true if all is good (in stock, etc) and bot is ready to proceed with order
       (auto set by this function)
- error_message ; Required if 'ok' is false, message why checkout cannot proceed
sourceraw docstring

answer-precheckout-query-okcljmultimethod

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Sets 'ok' param to true.

Required

  • this ; a bot instance
  • pre_checkout_query_id ; id of query to be answered
  • ok ; true if all is good (in stock, etc) and bot is ready to proceed with order (auto set by this function)
Once the user has confirmed their payment and shipping details,
the Bot API sends the final confirmation in the form of an Update
with the field pre_checkout_query.
Use this method to respond to such pre-checkout queries.
On success, True is returned.
Sets 'ok' param to true.

Required
- this ; a bot instance
- pre_checkout_query_id ; id of query to be answered
- ok ; true if all is good (in stock, etc) and bot is ready to proceed with order
       (auto set by this function)
sourceraw docstring

answer-shipping-query-errorclj

(answer-shipping-query-error this content)
(answer-shipping-query-error this shipping_query_id error_message)

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. Sets 'ok' param to false.

Required

  • this ; a bot instance
  • shipping_query_id ; id of query to be answered
  • ok ; true if delivery to address is possible (auto set by this function)
  • error_message ; Required if 'ok' is false, message why order cannot complete
If you sent an invoice requesting a shipping address
and the parameter is_flexible was specified, the Bot API
will send an Update with a shipping_query field to the bot.
Use this method to reply to shipping queries.
On success, True is returned.
Sets 'ok' param to false.

Required
- this ; a bot instance
- shipping_query_id ; id of query to be answered
- ok ; true if delivery to address is possible (auto set by this function)
- error_message ; Required if 'ok' is false, message why order cannot complete
sourceraw docstring

answer-shipping-query-okclj

(answer-shipping-query-ok this content)
(answer-shipping-query-ok this shipping_query_id shipping_options)

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. Sets 'ok' param to true.

Required

  • this ; a bot instance
  • shipping_query_id ; id of query to be answered
  • ok ; true if delivery to address is possible (auto set by this function)
  • shipping_options ; Required if 'ok' is true, array of shipping options
If you sent an invoice requesting a shipping address
and the parameter is_flexible was specified, the Bot API
will send an Update with a shipping_query field to the bot.
Use this method to reply to shipping queries.
On success, True is returned.
Sets 'ok' param to true.

Required
- this ; a bot instance
- shipping_query_id ; id of query to be answered
- ok ; true if delivery to address is possible (auto set by this function)
- shipping_options ; Required if 'ok' is true, array of shipping options
sourceraw docstring

behaviorclj

Map for extending the core TBot record with functions.

Map for extending the core TBot record with functions.
sourceraw docstring

content-map?clj

(content-map? _ content & _)

Used throughout the multi-methods in order to check if content is a map or not.

Used throughout the multi-methods in order to check if content is a map or not.
sourceraw docstring

send-invoiceclj

(send-invoice this content)
(send-invoice this
              chat_id
              title
              description
              payload
              provider_token
              start_parameter
              currency
              prices)
(send-invoice this
              chat_id
              title
              description
              payload
              provider_token
              start_parameter
              currency
              prices
              &
              optional)

Use this method to send invoices. On success, the sent Message is returned.

Required

  • this ; a bot instance
  • chat_id ; id for the target private chat
  • title ; product name
  • description ; product description
  • payload ; internal bot defined invoice payload
  • provider_token ; payments provider token
  • start_parameter ; 'deep-linking' start param
  • currency ; three letter ISO 4217 currency code
  • prices ; 'LabeledPrice' array breakdown (price, tax, discount, delivery, etc)

Optional

  • provider_data ; json data about invoice, payment provider specific
  • photo_url ; product photo for the invoice
  • photo_size
  • photo_width
  • photo_height
  • need_name ; true if the user's full name is required for order
  • need_phone_number ; true if the user's phone number is required for order
  • need_email ; true if the user's email is required for order
  • need_shipping_address ; true if the user's address is required for order
  • send_phone_number_to_provider ; true to send phone number to provider
  • send_email_to_provider ; true to send email to provider
  • is_flexible ; true if final price depends on shipping method
  • disable_notification ; send message silently
  • reply_to_message_id ; id of original message if a reply
  • allow_sending_without_reply ; true to send message even if replied-to message is not found
  • reply_markup ; inline keyboard markup
Use this method to send invoices.
On success, the sent Message is returned.

Required
- this ; a bot instance
- chat_id ; id for the target private chat
- title ; product name
- description ; product description
- payload ; internal bot defined invoice payload
- provider_token ; payments provider token
- start_parameter ; 'deep-linking' start param
- currency ; three letter ISO 4217 currency code
- prices ; 'LabeledPrice' array breakdown (price, tax, discount, delivery, etc)

Optional
- provider_data ; json data about invoice, payment provider specific
- photo_url ; product photo for the invoice
- photo_size
- photo_width
- photo_height
- need_name ; true if the user's full name is required for order
- need_phone_number ; true if the user's phone number is required for order
- need_email ; true if the user's email is required for order
- need_shipping_address ; true if the user's address is required for order
- send_phone_number_to_provider ; true to send phone number to provider
- send_email_to_provider ; true to send email to provider
- is_flexible ; true if final price depends on shipping method
- disable_notification ; send message silently
- reply_to_message_id ; id of original message if a reply
- allow_sending_without_reply ; true to send message even if replied-to message is not found
- reply_markup ; inline keyboard markup
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close