Function EventsApiFp

Returns {
    getEvent(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<Event>)>;
    listEvents(tilled_account, created_at_gte?, created_at_lte?, types?, object_id?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListEvents200Response>)>;
}

• getEvent:function

  • getEvent(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<Event>)>

  • 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<((axios?, basePath?) => AxiosPromise<Event>)>

• listEvents:function

  • listEvents(tilled_account, created_at_gte?, created_at_lte?, types?, object_id?, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListEvents200Response>)>

  • 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 created_at_gte: string

      Minimum `created_at` value to filter by (inclusive).

    • Optional created_at_lte: string

      Maximum `created_at` value to filter by (inclusive).

    • 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 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<((axios?, basePath?) => AxiosPromise<ListEvents200Response>)>