Function EventsApiAxiosParamCreator

Returns {
    getEvent: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listEvents: ((tilled_account, delivery_status?, created_at_gte?, created_at_lte?, types?, object_id?, include_connected_accounts?, offset?, limit?, options?) => Promise<RequestArgs>);
}

• getEvent: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • Retrieves the details of an Event.

      Summary

      Get an Event

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listEvents: ((tilled_account, delivery_status?, created_at_gte?, created_at_lte?, types?, object_id?, include_connected_accounts?, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, delivery_status?, created_at_gte?, created_at_lte?, types?, object_id?, include_connected_accounts?, offset?, limit?, options?): Promise<RequestArgs>

    • Returns a list of Events from the past 30 days. The Events are sorted with the most recently created appearing first.

      Summary

      List all Events

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • Optional delivery_status: ListEventsDeliveryStatus

        Filters events by their webhook delivery status. - `succeeded` — all endpoints received a 2xx response - `failed` — at least one endpoint exhausted retries without a successful delivery - `pending` — event is still queued for delivery (fan-out not yet complete) - `undelivered` — no delivery was attempted because the endpoint was `inactive` or `disabled` When omitted, all events are returned regardless of delivery status.

      • Optional created_at_gte: string

        Minimum `created_at` value to filter by (inclusive). Default is 30 days in the past.

      • Optional created_at_lte: string

        Maximum `created_at` value to filter by (inclusive). Default is current date.

      • Optional types: ListEventsTypes[]

        An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property.

      • Optional object_id: string

        Id of related resource. The list will be filtered to include events that are related to the resource with this id.

      • Optional include_connected_accounts: boolean

        Whether or not to include the results from any connected accounts.

      • Optional offset: number

        The (zero-based) offset of the first item in the collection to return.

      • Optional limit: number

        The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>