Class ShippingQuery

Hierarchy (View Summary)

Constructors

constructor

Properties

author id invoicePayload shippingAddress

Accessors

client

Methods

_clone _patch _update answerQuery toJSON valueOf

Constructors

constructor

Properties

author

author: User

User who sent the query

id

id: string

Unique query identifier

invoicePayload

invoicePayload: string

Bot specified invoice payload.

shippingAddress

shippingAddress: {
    city: string;
    countryCode: string;
    postCode: string;
    state: string;
    streetLine1: string;
    streetLine2: string;
}

User specified shipping address

Type declaration

  • city: string
    • City
  • countryCode: string
    • Two-letter ISO 3166-1 alpha-2 country code
  • postCode: string
    • Address post code
  • state: string
    • State, if applicable
  • streetLine1: string
    • First line for the address
  • streetLine2: string
    • Second line for the address

Accessors

client

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data: Record<string, any>): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data: Record<string, any>): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

answerQuery

  • answerQuery(
        ok: boolean,
        options?: Omit<
            {
                errorMessage?: string;
                ok: boolean;
                shippingOptions?: readonly ShippingOption[];
                shippingQueryId: string;
            },
            "ok"
            | "shippingQueryId",
        >,
    ): Promise<true>

  • 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.

    Parameters

    • ok: boolean

      Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

    • Optionaloptions: Omit<
          {
              errorMessage?: string;
              ok: boolean;
              shippingOptions?: readonly ShippingOption[];
              shippingQueryId: string;
          },
          "ok"
          | "shippingQueryId",
      >

      out parameters

    Returns Promise<true>

    On success, True is returned.

toJSON

  • toJSON(
        propsRecursive?: boolean,
        ...props: Record<string, string | boolean>[],
    ): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • ...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods