From ea94e8a71d1e4b6709b5b5070098fffef84d1515 Mon Sep 17 00:00:00 2001 From: cillian Date: Mon, 19 Aug 2024 10:19:32 +0000 Subject: [PATCH] deploy: a471d84e9715239590a647d09bf73add51852590 --- docs/api/admin/3.0/index.html | 16 ++++++++-------- docs/api/admin/3.1/index.html | 16 ++-------------- 2 files changed, 10 insertions(+), 22 deletions(-) diff --git a/docs/api/admin/3.0/index.html b/docs/api/admin/3.0/index.html index e61eb0d1797..3df791b907d 100644 --- a/docs/api/admin/3.0/index.html +++ b/docs/api/admin/3.0/index.html @@ -316,7 +316,7 @@ Authentication @@ -330,13 +330,13 @@ Views @@ -787,7 +787,7 @@

Authentication

If you find your API token has been compromised it can be revoked and a new one generated.

Your API token needs to be included in the Authorization header so your requests can be authenticated.

-

Confirm you can connect

curl --request GET \
+

Confirm you can connect

curl --request GET \
   --url 'https://api.tito.io/v3/hello' \
   --header 'Authorization: Token token=YOUR-API-TOKEN' \
   --header 'Accept: application/json' \
@@ -846,11 +846,11 @@ 

Views

  • Short
  • Extended
  • -

     Short

    +

     Short

    This is what you get if you ask for a list of records (e.g. Get all Registrations) then we give you the "short" view of the data, so that we can make the response as quick as possible and you don't get a lot of data all at once.

    -

    Extended

    +

    Extended

    If you ask for a single record (e.g. Get a Registration) then we give you the "extended" view which gives you more detailed information and possible associated records.

    -

    Choosing the view

    +

    Choosing the view

    You can override this by passing the view parameter. For example:

    GET https://api.tito.io/v3/:account_slug/:event_slug/tickets?view=extended

    diff --git a/docs/api/admin/3.1/index.html b/docs/api/admin/3.1/index.html index 5235f3a0619..d43a9cfaa1a 100644 --- a/docs/api/admin/3.1/index.html +++ b/docs/api/admin/3.1/index.html @@ -316,7 +316,7 @@ Authentication @@ -884,7 +884,7 @@

    Authentication

    If you find your API token has been compromised it can be revoked and a new one generated.

    Your API token needs to be included in the Authorization header so your requests can be authenticated.

    -

    Confirm you can connect

    curl --request GET \
    +

    Confirm you can connect

    curl --request GET \
       --url 'https://api.tito.io/v3/hello' \
       --header 'Authorization: Token token=YOUR-API-TOKEN' \
       --header 'Accept: application/json' \
    @@ -2290,7 +2290,6 @@ 

    Attributes

  • any_live_ticketsbooleanread only
  • archivedboolean
    Whether this event is archived or not.
  • bannerobject
  • -
  • banner_link
  • banner_urlurlread only
    A link to the event's banner image.
  • consentobject
    Whether consent is required for data protection
  • credit_card_payment_option_gateway_typestring
    The payment option for credit cards, e.g. "stripe".
  • @@ -2325,7 +2324,6 @@

    Attributes

  • email_image
  • email_invoice
  • end_datedate
    The date the event is going to end
  • -
  • external_order_reference_format
  • facebook_share_messagetranslated*
  • from_email
  • happening_in
    Either past, now, future or unknown (if start_date is blank).
  • @@ -2525,7 +2523,6 @@

    Get all upcoming events "after_registration_redirect_after_questions": false, "any_live_sales": true, "any_live_tickets": true, - "banner_link": null, "credit_card_payment_option_id": null, "credit_card_payment_option_gateway_type": null, "custom_background_color": null, @@ -2553,7 +2550,6 @@

    Get all upcoming events } }, "email_invoice": true, - "external_order_reference_format": null, "facebook_share_message": null, "hide_tax_types": false, "invoice_change_cutoff_days": 90, @@ -2712,7 +2708,6 @@

    Get all upcoming events "after_registration_redirect_after_questions": false, "any_live_sales": false, "any_live_tickets": false, - "banner_link": null, "credit_card_payment_option_id": null, "credit_card_payment_option_gateway_type": null, "custom_background_color": null, @@ -2740,7 +2735,6 @@

    Get all upcoming events } }, "email_invoice": true, - "external_order_reference_format": null, "facebook_share_message": null, "hide_tax_types": false, "invoice_change_cutoff_days": 90, @@ -2986,7 +2980,6 @@

    Get an event

    "after_registration_redirect_after_questions": false, "any_live_sales": true, "any_live_tickets": true, - "banner_link": null, "credit_card_payment_option_id": null, "credit_card_payment_option_gateway_type": null, "custom_background_color": null, @@ -3014,7 +3007,6 @@

    Get an event

    } }, "email_invoice": true, - "external_order_reference_format": null, "facebook_share_message": null, "hide_tax_types": false, "invoice_change_cutoff_days": 90, @@ -3202,7 +3194,6 @@

    Create an event "after_registration_redirect_after_questions": false, "any_live_sales": false, "any_live_tickets": false, - "banner_link": null, "credit_card_payment_option_id": null, "credit_card_payment_option_gateway_type": null, "custom_background_color": null, @@ -3230,7 +3221,6 @@

    Create an event } }, "email_invoice": true, - "external_order_reference_format": null, "facebook_share_message": null, "hide_tax_types": false, "invoice_change_cutoff_days": 90, @@ -3420,7 +3410,6 @@

    Update an event "after_registration_redirect_after_questions": false, "any_live_sales": true, "any_live_tickets": true, - "banner_link": null, "credit_card_payment_option_id": null, "credit_card_payment_option_gateway_type": null, "custom_background_color": null, @@ -3448,7 +3437,6 @@

    Update an event } }, "email_invoice": true, - "external_order_reference_format": null, "facebook_share_message": null, "hide_tax_types": false, "invoice_change_cutoff_days": 90,