diff --git a/doc/api/resources/categories.rst b/doc/api/resources/categories.rst index 49f1cdf46..e379cda62 100644 --- a/doc/api/resources/categories.rst +++ b/doc/api/resources/categories.rst @@ -20,7 +20,7 @@ internal_name string An optional nam description multi-lingual string A public description (might include markdown, can be ``null``) position integer An integer, used for sorting the categories -is_addon boolean If ``True``, items within this category are not on sale +is_addon boolean If ``true``, items within this category are not on sale on their own but the category provides a source for defining add-ons for other products. ===================================== ========================== ======================================================= diff --git a/doc/api/resources/checkinlists.rst b/doc/api/resources/checkinlists.rst index 6a4bc749e..522d999a7 100644 --- a/doc/api/resources/checkinlists.rst +++ b/doc/api/resources/checkinlists.rst @@ -156,14 +156,14 @@ Endpoints "checkin_count": 17, "position_count": 42, "event": { - "name": "Demo Converence", + "name": "Demo Conference" }, "items": [ { "name": "T-Shirt", "id": 1, "checkin_count": 1, - "admission": False, + "admission": false, "position_count": 1, "variations": [ { @@ -184,7 +184,7 @@ Endpoints "name": "Ticket", "id": 2, "checkin_count": 15, - "admission": True, + "admission": true, "position_count": 22, "variations": [] } diff --git a/doc/api/resources/events.rst b/doc/api/resources/events.rst index 9d5172225..abd293784 100644 --- a/doc/api/resources/events.rst +++ b/doc/api/resources/events.rst @@ -25,7 +25,7 @@ is_public boolean If ``true``, th presale_start datetime The date at which the ticket shop opens (or ``null``) presale_end datetime The date at which the ticket shop closes (or ``null``) location multi-lingual string The event location (or ``null``) -has_subevents boolean ``True`` if the event series feature is active for this +has_subevents boolean ``true`` if the event series feature is active for this event. Cannot change after event is created. meta_data dict Values set for organizer-specific meta data parameters. plugins list A list of package names of the enabled plugins for this diff --git a/doc/api/resources/invoices.rst b/doc/api/resources/invoices.rst index 3738cd4f4..2236403ef 100644 --- a/doc/api/resources/invoices.rst +++ b/doc/api/resources/invoices.rst @@ -13,7 +13,7 @@ Field Type Description ===================================== ========================== ======================================================= number string Invoice number (with prefix) order string Order code of the order this invoice belongs to -is_cancellation boolean ``True``, if this invoice is the cancellation of a +is_cancellation boolean ``true``, if this invoice is the cancellation of a different invoice. invoice_from string Sender address invoice_to string Receiver address diff --git a/doc/api/resources/item_variations.rst b/doc/api/resources/item_variations.rst index 677bf5008..441e0201d 100644 --- a/doc/api/resources/item_variations.rst +++ b/doc/api/resources/item_variations.rst @@ -18,7 +18,7 @@ default_price money (string) The price set d price money (string) The price used for this variation. This is either the same as ``default_price`` if that value is set or equal to the item's ``default_price`` (read-only). -active boolean If ``False``, this variation will not be sold or shown. +active boolean If ``false``, this variation will not be sold or shown. description multi-lingual string A public description of the variation. May contain Markdown syntax or can be ``null``. position integer An integer, used for sorting diff --git a/doc/api/resources/items.rst b/doc/api/resources/items.rst index a8b1d5679..2c1c7b931 100644 --- a/doc/api/resources/items.rst +++ b/doc/api/resources/items.rst @@ -21,18 +21,18 @@ default_price money (string) The item price overwritten by variations or other options. category integer The ID of the category this item belongs to (or ``null``). -active boolean If ``False``, the item is hidden from all public lists +active boolean If ``false``, the item is hidden from all public lists and will not be sold. description multi-lingual string A public description of the item. May contain Markdown syntax or can be ``null``. -free_price boolean If ``True``, customers can change the price at which +free_price boolean If ``true``, customers can change the price at which they buy the product (however, the price can't be set lower than the price defined by ``default_price`` or otherwise). tax_rate decimal (string) The VAT rate to be applied for this item. tax_rule integer The internal ID of the applied tax rule (or ``null``). -admission boolean ``True`` for items that grant admission to the event - (such as primary tickets) and ``False`` for others +admission boolean ``true`` for items that grant admission to the event + (such as primary tickets) and ``false`` for others (such as add-ons or merchandise). position integer An integer, used for sorting picture string A product picture to be displayed in the shop @@ -43,12 +43,12 @@ available_from datetime The first date (or ``null``). available_until datetime The last date time at which this item can be bought (or ``null``). -require_voucher boolean If ``True``, this item can only be bought using a +require_voucher boolean If ``true``, this item can only be bought using a voucher that is specifically assigned to this item. -hide_without_voucher boolean If ``True``, this item is only shown during the voucher +hide_without_voucher boolean If ``true``, this item is only shown during the voucher redemption process, but not in the normal shop frontend. -allow_cancel boolean If ``False``, customers cannot cancel orders containing +allow_cancel boolean If ``false``, customers cannot cancel orders containing this item. min_per_order integer This product can only be bought if it is included at least this many times in the order (or ``null`` for no @@ -56,17 +56,17 @@ min_per_order integer This product ca max_per_order integer This product can only be bought if it is included at most this many times in the order (or ``null`` for no limitation). -checkin_attention boolean If ``True``, the check-in app should show a warning +checkin_attention boolean If ``true``, the check-in app should show a warning that this ticket requires special attention if such a product is being scanned. original_price money (string) An original price, shown for comparison, not used for price calculations (or ``null``). -require_approval boolean If ``True``, orders with this product will need to be +require_approval boolean If ``true``, orders with this product will need to be approved by the event organizer before they can be paid. -require_bundling boolean If ``True``, this item is only available as part of bundles. -generate_tickets boolean If ``False``, tickets are never generated for this - product, regardless of other settings. If ``True``, +require_bundling boolean If ``true``, this item is only available as part of bundles. +generate_tickets boolean If ``false``, tickets are never generated for this + product, regardless of other settings. If ``true``, tickets are generated even if this is a non-admission or add-on product, regardless of event settings. If this is ``null``, regular ticketing @@ -81,7 +81,7 @@ variations list of objects A list with one ├ price money (string) The price used for this variation. This is either the same as ``default_price`` if that value is set or equal to the item's ``default_price``. -├ active boolean If ``False``, this variation will not be sold or shown. +├ active boolean If ``false``, this variation will not be sold or shown. ├ description multi-lingual string A public description of the variation. May contain Markdown syntax or can be ``null``. └ position integer An integer, used for sorting diff --git a/doc/api/resources/orders.rst b/doc/api/resources/orders.rst index f365b9435..b69521f0c 100644 --- a/doc/api/resources/orders.rst +++ b/doc/api/resources/orders.rst @@ -26,7 +26,7 @@ status string Order status, o * ``p`` – paid * ``e`` – expired * ``c`` – canceled -testmode boolean If ``True``, this order was created when the event was in +testmode boolean If ``true``, this order was created when the event was in test mode. Only orders in test mode can be deleted. secret string The secret contained in the link sent to the customer email string The customer email address @@ -39,13 +39,13 @@ payment_date date **DEPRECATED AN payment_provider string **DEPRECATED AND INACCURATE** Payment provider used for this order total money (string) Total value of this order comment string Internal comment on this order -checkin_attention boolean If ``True``, the check-in app should show a warning +checkin_attention boolean If ``true``, the check-in app should show a warning that this ticket requires special attention if a ticket of this order is scanned. invoice_address object Invoice address information (can be ``null``) ├ last_modified datetime Last modification date of the address ├ company string Customer company name -├ is_business boolean Business or individual customers (always ``False`` +├ is_business boolean Business or individual customers (always ``false`` for orders created before pretix 1.7, do not rely on it). ├ name string Customer name @@ -56,7 +56,7 @@ invoice_address object Invoice address ├ country string Customer country ├ internal_reference string Customer's internal reference to be printed on the invoice ├ vat_id string Customer VAT ID -└ vat_id_validated string ``True``, if the VAT ID has been validated against the +└ vat_id_validated string ``true``, if the VAT ID has been validated against the EU VAT service and validation was successful. This only happens in rare cases. positions list of objects List of non-canceled order positions (see below) @@ -78,9 +78,9 @@ downloads list of objects List of ticket download options. ├ output string Ticket output provider (e.g. ``pdf``, ``passbook``) └ url string Download URL -require_approval boolean If ``True`` and the order is pending, this order +require_approval boolean If ``true`` and the order is pending, this order needs approval by an organizer before it can - continue. If ``True`` and the order is canceled, + continue. If ``true`` and the order is canceled, this order has been denied by the event organizer. payments list of objects List of payment processes (see below) refunds list of objects List of refund processes (see below) @@ -295,7 +295,7 @@ List of all orders "require_approval": false, "invoice_address": { "last_modified": "2017-12-01T10:00:00Z", - "is_business": True, + "is_business": true, "company": "Sample company", "name": "John Doe", "name_parts": {"full_name": "John Doe"}, @@ -305,7 +305,7 @@ List of all orders "country": "Testikistan", "internal_reference": "", "vat_id": "EU123456789", - "vat_id_validated": False + "vat_id_validated": false }, "positions": [ { @@ -437,7 +437,7 @@ Fetching individual orders "invoice_address": { "last_modified": "2017-12-01T10:00:00Z", "company": "Sample company", - "is_business": True, + "is_business": true, "name": "John Doe", "name_parts": {"full_name": "John Doe"}, "street": "Test street 12", @@ -446,7 +446,7 @@ Fetching individual orders "country": "Testikistan", "internal_reference": "", "vat_id": "EU123456789", - "vat_id_validated": False + "vat_id_validated": false }, "positions": [ { @@ -593,7 +593,7 @@ Updating order fields "email": "other@example.org", "locale": "de", "comment": "Foo", - "checkin_attention": True + "checkin_attention": true } **Example response**: @@ -817,7 +817,7 @@ Creating orders ], "payment_provider": "banktransfer", "invoice_address": { - "is_business": False, + "is_business": false, "company": "Sample company", "name_parts": {"full_name": "John Doe"}, "street": "Sesam Street 12", diff --git a/doc/api/resources/questions.rst b/doc/api/resources/questions.rst index bbf272b8e..727d8f089 100644 --- a/doc/api/resources/questions.rst +++ b/doc/api/resources/questions.rst @@ -30,12 +30,12 @@ type string The expected ty * ``D`` – date * ``H`` – time * ``W`` – date and time -required boolean If ``True``, the question needs to be filled out. +required boolean If ``true``, the question needs to be filled out. position integer An integer, used for sorting items list of integers List of item IDs this question is assigned to. identifier string An arbitrary string that can be used for matching with other sources. -ask_during_checkin boolean If ``True``, this question will not be asked while +ask_during_checkin boolean If ``true``, this question will not be asked while buying the ticket, but will show up when redeeming the ticket instead. options list of objects In case of question type ``C`` or ``M``, this lists the @@ -53,7 +53,7 @@ dependency_question integer Internal ID of ``ask_during_checkin``. dependency_value string The value ``dependency_question`` needs to be set to. If ``dependency_question`` is set to a boolean - question, this should be ``"True"`` or ``"False"``. + question, this should be ``"true"`` or ``"false"``. Otherwise, it should be the ``identifier`` of a question option. ===================================== ========================== ======================================================= diff --git a/doc/api/resources/vouchers.rst b/doc/api/resources/vouchers.rst index cd51e1ebe..1999fe0ff 100644 --- a/doc/api/resources/vouchers.rst +++ b/doc/api/resources/vouchers.rst @@ -18,8 +18,8 @@ max_usages integer The maximum num redeemed integer The number of times this voucher already has been redeemed. valid_until datetime The voucher expiration date (or ``null``). -block_quota boolean If ``True``, quota is blocked for this voucher. -allow_ignore_quota boolean If ``True``, this voucher can be redeemed even if a +block_quota boolean If ``true``, quota is blocked for this voucher. +allow_ignore_quota boolean If ``true``, this voucher can be redeemed even if a product is sold out and even if quota is not blocked for this voucher. price_mode string Determines how this voucher affects product prices. diff --git a/doc/api/resources/webhooks.rst b/doc/api/resources/webhooks.rst index ec373a110..83b1ebb4c 100644 --- a/doc/api/resources/webhooks.rst +++ b/doc/api/resources/webhooks.rst @@ -17,11 +17,11 @@ The webhook resource contains the following public fields: Field Type Description ===================================== ========================== ======================================================= id integer Internal ID of the webhook -enabled boolean If ``False``, this webhook will not receive any notifications +enabled boolean If ``false``, this webhook will not receive any notifications target_url string The URL to call -all_events boolean If ``True``, this webhook will receive notifications +all_events boolean If ``true``, this webhook will receive notifications on all events of this organizer -limit_events list of strings If ``all_events`` is ``False``, this is a list of +limit_events list of strings If ``all_events`` is ``false``, this is a list of event slugs this webhook is active for action_types list of strings A list of action type filters that limit the notifications sent to this webhook. See below for diff --git a/doc/plugins/pretixdroid.rst b/doc/plugins/pretixdroid.rst index 10c8c94bd..a267f794b 100644 --- a/doc/plugins/pretixdroid.rst +++ b/doc/plugins/pretixdroid.rst @@ -316,7 +316,7 @@ uses to communicate with the pretix server. "total": 42, "version": 3, "event": { - "name": "Demo Converence", + "name": "Demo Conference", "slug": "democon", "date_from": "2016-12-27T17:00:00Z", "date_to": "2016-12-30T18:00:00Z",