tutorial-essentials.md

Tutorial Essentials

These are the most common methods for working with the API tutorial.

tutorial_essentials_api = client.tutorial_essentials

Class Name

TutorialEssentialsApi

Developer Tutorial

This method tests whether users who are working through the Getting Started guides have set up their configurations correctly.

def developer_tutorial

Authentication

This endpoint requires oauth2_authorization_code OR oauth2_client_credentials

Requires scope

oauth2_authorization_code

ai, create, delete, edit, email, interact, private, promo_codes, public, purchase, purchased, scim, stats, upload, video_files

oauth2_client_credentials

ai, create, delete, edit, email, interact, private, promo_codes, public, purchase, purchased, scim, stats, upload, video_files

Response Type

200

This method returns an ApiResponse instance.

Example Usage

result = tutorial_essentials_api.developer_tutorial

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end