File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -68,7 +68,7 @@ class Client
6868 * Configure the API client with the required settings to access
6969 * the API for a store.
7070 *
71- * Accepts both OAuth and Basic Auth credentials
71+ * Accepts OAuth and (for now!) Basic Auth credentials
7272 *
7373 * @param array $settings
7474 */
@@ -119,6 +119,9 @@ public static function configureOAuth($settings)
119119 * - username
120120 * - api_key
121121 *
122+ * @deprecated Please migrate to OAuth
123+ * @see https://developer.bigcommerce.com/api/guides/oauth-transition
124+ *
122125 * @param array $settings
123126 * @throws \Exception
124127 */
Original file line number Diff line number Diff line change @@ -154,6 +154,7 @@ public function failOnError($option = true)
154154 /**
155155 * Sets the HTTP basic authentication.
156156 *
157+ * @deprecated Use OAuth for authentication
157158 * @param string $username
158159 * @param string $password
159160 */
@@ -530,6 +531,8 @@ public function getBody()
530531 /**
531532 * Access given header from the response.
532533 *
534+ * @param string $header Header name to retrieve
535+ *
533536 * @return string|void
534537 */
535538 public function getHeader ($ header )
You can’t perform that action at this time.
0 commit comments