Examples: Add X-Example code snippet tag.

klarna · Jul 9, 2019 · ab32497 · ab32497
1 parent b7c55c8
commit ab32497
Show file tree

Hide file tree

Showing 45 changed files with 180 additions and 0 deletions.
diff --git a/docs/examples/CheckoutAPI/create_checkout.php b/docs/examples/CheckoutAPI/create_checkout.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../vendor/autoload.php';
 
+// X-Example: POST /checkout/v3/orders
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -107,3 +109,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /checkout/v3/orders
diff --git a/docs/examples/CheckoutAPI/fetch_checkout.php b/docs/examples/CheckoutAPI/fetch_checkout.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../vendor/autoload.php';
 
+// X-Example: GET /checkout/v3/orders/{order_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -58,3 +60,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /checkout/v3/orders/{order_id}
diff --git a/docs/examples/CheckoutAPI/update_checkout.php b/docs/examples/CheckoutAPI/update_checkout.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../vendor/autoload.php';
 
+// X-Example: POST /checkout/v3/orders/{order_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -99,3 +101,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /checkout/v3/orders/{order_id}
diff --git a/docs/examples/CustomerTokenAPI/Tokens/create_order.php b/docs/examples/CustomerTokenAPI/Tokens/create_order.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /customer-token/v1/tokens/{customerToken}/order
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -102,3 +104,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /customer-token/v1/tokens/{customerToken}/order
diff --git a/docs/examples/CustomerTokenAPI/Tokens/read_token_details.php b/docs/examples/CustomerTokenAPI/Tokens/read_token_details.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /customer-token/v1/tokens/{customerToken}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /customer-token/v1/tokens/{customerToken}
diff --git a/docs/examples/CustomerTokenAPI/Tokens/update_token_status.php b/docs/examples/CustomerTokenAPI/Tokens/update_token_status.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: PATCH /customer-token/v1/tokens/{customerToken}/status
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -55,3 +57,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: PATCH /customer-token/v1/tokens/{customerToken}/status
diff --git a/docs/examples/HostedPaymentPageAPI/Sessions/create_new_hpp_session.php b/docs/examples/HostedPaymentPageAPI/Sessions/create_new_hpp_session.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /hpp/v1/sessions
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -76,3 +78,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /hpp/v1/sessions
diff --git a/docs/examples/HostedPaymentPageAPI/Sessions/disable_session.php b/docs/examples/HostedPaymentPageAPI/Sessions/disable_session.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: DELETE /hpp/v1/sessions/{session_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: DELETE /hpp/v1/sessions/{session_id}
diff --git a/docs/examples/HostedPaymentPageAPI/Sessions/distribute_link.php b/docs/examples/HostedPaymentPageAPI/Sessions/distribute_link.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /hpp/v1/sessions/{session_id}/distribution
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -63,3 +65,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /hpp/v1/sessions/{session_id}/distribution
diff --git a/docs/examples/HostedPaymentPageAPI/Sessions/get_hpp_session_status.php b/docs/examples/HostedPaymentPageAPI/Sessions/get_hpp_session_status.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /hpp/v1/sessions/{session_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /hpp/v1/sessions/{session_id}
diff --git a/docs/examples/InstantShoppingAPI/ButtonKeys/create_button_key.php b/docs/examples/InstantShoppingAPI/ButtonKeys/create_button_key.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /instantshopping/v1/buttons
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -107,3 +109,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /instantshopping/v1/buttons
diff --git a/docs/examples/InstantShoppingAPI/ButtonKeys/see_button_key_options.php b/docs/examples/InstantShoppingAPI/ButtonKeys/see_button_key_options.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /instantshopping/v1/buttons/{button_key}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /instantshopping/v1/buttons/{button_key}
diff --git a/docs/examples/InstantShoppingAPI/ButtonKeys/update_button_key.php b/docs/examples/InstantShoppingAPI/ButtonKeys/update_button_key.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: PUT /instantshopping/v1/buttons/{button_key}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -77,3 +79,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: PUT /instantshopping/v1/buttons/{button_key}
diff --git a/docs/examples/InstantShoppingAPI/Orders/approve_order.php b/docs/examples/InstantShoppingAPI/Orders/approve_order.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /instantshopping/v1/authorizations/{authorization_token}/orders
+
 /**
  * Follow the link to get your credentials => https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -118,3 +120,5 @@
 } catch (Exception $e) {
     echo 'Caught exception => ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /instantshopping/v1/authorizations/{authorization_token}/orders
diff --git a/docs/examples/InstantShoppingAPI/Orders/decline_order.php b/docs/examples/InstantShoppingAPI/Orders/decline_order.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: DELETE /instantshopping/v1/authorizations/{authorization_token}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -58,3 +60,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: DELETE /instantshopping/v1/authorizations/{authorization_token}
diff --git a/docs/examples/InstantShoppingAPI/Orders/retrieve_order.php b/docs/examples/InstantShoppingAPI/Orders/retrieve_order.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /instantshopping/v1/authorizations/{authorization_token}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /instantshopping/v1/authorizations/{authorization_token}
diff --git a/docs/examples/OrderManagementAPI/Captures/add_shipping_info.php b/docs/examples/OrderManagementAPI/Captures/add_shipping_info.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -68,3 +70,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info
diff --git a/docs/examples/OrderManagementAPI/Captures/trigger_send_out.php b/docs/examples/OrderManagementAPI/Captures/trigger_send_out.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -56,3 +58,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out
diff --git a/docs/examples/OrderManagementAPI/Orders/acknowledge_order.php b/docs/examples/OrderManagementAPI/Orders/acknowledge_order.php
@@ -24,6 +24,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/acknowledge
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -56,3 +58,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/acknowledge
diff --git a/docs/examples/OrderManagementAPI/Orders/cancel_order.php b/docs/examples/OrderManagementAPI/Orders/cancel_order.php
@@ -23,6 +23,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/cancel
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -55,3 +57,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/cancel
diff --git a/docs/examples/OrderManagementAPI/Orders/create_capture.php b/docs/examples/OrderManagementAPI/Orders/create_capture.php
@@ -24,6 +24,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/captures
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -83,3 +85,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/captures
diff --git a/docs/examples/OrderManagementAPI/Orders/extend_authorization_time.php b/docs/examples/OrderManagementAPI/Orders/extend_authorization_time.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/extend-authorization-time
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/extend-authorization-time
diff --git a/docs/examples/OrderManagementAPI/Orders/fetch_all_captures.php b/docs/examples/OrderManagementAPI/Orders/fetch_all_captures.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /ordermanagement/v1/orders/{order_id}/captures
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -54,3 +56,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /ordermanagement/v1/orders/{order_id}/captures
diff --git a/docs/examples/OrderManagementAPI/Orders/fetch_capture.php b/docs/examples/OrderManagementAPI/Orders/fetch_capture.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -54,3 +56,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}
diff --git a/docs/examples/OrderManagementAPI/Orders/fetch_order.php b/docs/examples/OrderManagementAPI/Orders/fetch_order.php
@@ -21,6 +21,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: GET /ordermanagement/v1/orders/{order_id}
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -53,3 +55,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: GET /ordermanagement/v1/orders/{order_id}
diff --git a/docs/examples/OrderManagementAPI/Orders/release_remaining_authorization.php b/docs/examples/OrderManagementAPI/Orders/release_remaining_authorization.php
@@ -23,6 +23,8 @@
 
 require_once dirname(__DIR__) . '/../../../vendor/autoload.php';
 
+// X-Example: POST /ordermanagement/v1/orders/{order_id}/release-remaining-authorization
+
 /**
  * Follow the link to get your credentials: https://github.com/klarna/kco_rest_php/#api-credentials
  *
@@ -55,3 +57,5 @@
 } catch (Exception $e) {
     echo 'Caught exception: ' . $e->getMessage() . "\n";
 }
+
+// /X-Example: POST /ordermanagement/v1/orders/{order_id}/release-remaining-authorization