taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

patch-private-tokenfamilies-TOKEN_FAMILY_SLUG.rst (1179B)

      1 .. http:patch:: [/instances/$INSTANCES]/private/tokenfamilies/$TOKEN_FAMILY_SLUG
      2 
      3   This is used to update a token family.
      4 
      5   **Required permission:** ``tokenfamilies-write``
      6 
      7   **Request:**
      8 
      9   The request must be a `TokenFamilyUpdateRequest`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`204 No Content`:
     14     The token family was successsful updated.
     15 
     16   :http:statuscode:`404 Not found`:
     17     The merchant backend is unaware of the token family or instance.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: TokenFamilyUpdateRequest
     22 
     23     interface TokenFamilyUpdateRequest {
     24 
     25       // Human-readable name for the token family.
     26       name: string;
     27 
     28       // Human-readable description for the token family.
     29       description: string;
     30 
     31       // Optional map from IETF BCP 47 language tags to localized descriptions.
     32       description_i18n: { [lang_tag: string]: string };
     33 
     34       // Additional meta data, such as the ``trusted_domains``
     35       // or ``expected_domains``. Depends on the ``kind``.
     36       extra_data?: object;
     37 
     38       // Start time of the token family's validity period.
     39       valid_after: Timestamp;
     40 
     41       // End time of the token family's validity period.
     42       valid_before: Timestamp;
     43 
     44    }