feat(api): update examples (#21)

stainless-app[bot] · stainless-app[bot] · commit 48bf7138ab06 · 2025-02-12T12:49:55.000Z
diff --git a/README.md b/README.md
@@ -52,11 +52,11 @@ func main() {
 	client := gitpod.NewClient(
 		option.WithBearerToken("My Bearer Token"), // defaults to os.LookupEnv("GITPOD_API_KEY")
 	)
-	runner, err := client.Runners.New(context.TODO(), gitpod.RunnerNewParams{})
+	response, err := client.Identity.GetAuthenticatedIdentity(context.TODO(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err != nil {
 		panic(err.Error())
 	}
-	fmt.Printf("%+v\n", runner.AccessToken)
+	fmt.Printf("%+v\n", response.OrganizationID)
 }
 
 ```
@@ -145,7 +145,7 @@ client := gitpod.NewClient(
 	option.WithHeader("X-Some-Header", "custom_header_info"),
 )
 
-client.Runners.New(context.TODO(), ...,
+client.Identity.GetAuthenticatedIdentity(context.TODO(), ...,
 	// Override the header
 	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
 	// Add an undocumented field to the request body, using sjson syntax
@@ -162,11 +162,11 @@ This library provides some conveniences for working with paginated list endpoint
 You can use `.ListAutoPaging()` methods to iterate through items across all pages:
 
 ```go
-iter := client.Environments.Automations.Services.ListAutoPaging(context.TODO(), gitpod.EnvironmentAutomationServiceListParams{})
+iter := client.Environments.ListAutoPaging(context.TODO(), gitpod.EnvironmentListParams{})
 // Automatically fetches more pages as needed.
 for iter.Next() {
-	service := iter.Current()
-	fmt.Printf("%+v\n", service)
+	environment := iter.Current()
+	fmt.Printf("%+v\n", environment)
 }
 if err := iter.Err(); err != nil {
 	panic(err.Error())
@@ -177,10 +177,10 @@ Or you can use simple `.List()` methods to fetch a single page and receive a sta
 with additional helper methods like `.GetNextPage()`, e.g.:
 
 ```go
-page, err := client.Environments.Automations.Services.List(context.TODO(), gitpod.EnvironmentAutomationServiceListParams{})
+page, err := client.Environments.List(context.TODO(), gitpod.EnvironmentListParams{})
 for page != nil {
-	for _, service := range page.Services {
-		fmt.Printf("%+v\n", service)
+	for _, environment := range page.Environments {
+		fmt.Printf("%+v\n", environment)
 	}
 	page, err = page.GetNextPage()
 }
@@ -199,14 +199,14 @@ When the API returns a non-success status code, we return an error with type
 To handle errors, we recommend that you use the `errors.As` pattern:
 
 ```go
-_, err := client.Runners.New(context.TODO(), gitpod.RunnerNewParams{})
+_, err := client.Identity.GetAuthenticatedIdentity(context.TODO(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 if err != nil {
 	var apierr *gitpod.Error
 	if errors.As(err, &apierr) {
 		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
 		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
 	}
-	panic(err.Error()) // GET "/gitpod.v1.RunnerService/CreateRunner": 400 Bad Request { ... }
+	panic(err.Error()) // GET "/gitpod.v1.IdentityService/GetAuthenticatedIdentity": 400 Bad Request { ... }
 }
 ```
 
@@ -224,9 +224,9 @@ To set a per-retry timeout, use `option.WithRequestTimeout()`.
 // This sets the timeout for the request, including all the retries.
 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
 defer cancel()
-client.Runners.New(
+client.Identity.GetAuthenticatedIdentity(
 	ctx,
-	gitpod.RunnerNewParams{},
+	gitpod.IdentityGetAuthenticatedIdentityParams{},
 	// This sets the per-retry timeout
 	option.WithRequestTimeout(20*time.Second),
 )
@@ -260,9 +260,9 @@ client := gitpod.NewClient(
 )
 
 // Override per-request:
-client.Runners.New(
+client.Identity.GetAuthenticatedIdentity(
 	context.TODO(),
-	gitpod.RunnerNewParams{},
+	gitpod.IdentityGetAuthenticatedIdentityParams{},
 	option.WithMaxRetries(5),
 )
 ```
@@ -275,15 +275,15 @@ you need to examine response headers, status codes, or other details.
 ```go
 // Create a variable to store the HTTP response
 var response *http.Response
-runner, err := client.Runners.New(
+response, err := client.Identity.GetAuthenticatedIdentity(
 	context.TODO(),
-	gitpod.RunnerNewParams{},
+	gitpod.IdentityGetAuthenticatedIdentityParams{},
 	option.WithResponseInto(&response),
 )
 if err != nil {
 	// handle error
 }
-fmt.Printf("%+v\n", runner)
+fmt.Printf("%+v\n", response)
 
 fmt.Printf("Status Code: %d\n", response.StatusCode)
 fmt.Printf("Headers: %+#v\n", response.Header)
diff --git a/client_test.go b/client_test.go
@@ -37,7 +37,7 @@ func TestUserAgentHeader(t *testing.T) {
 			},
 		}),
 	)
-	client.Runners.New(context.Background(), gitpod.RunnerNewParams{})
+	client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if userAgent != fmt.Sprintf("Gitpod/Go %s", internal.PackageVersion) {
 		t.Errorf("Expected User-Agent to be correct, but got: %#v", userAgent)
 	}
@@ -60,7 +60,7 @@ func TestRetryAfter(t *testing.T) {
 			},
 		}),
 	)
-	_, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
@@ -94,7 +94,7 @@ func TestDeleteRetryCountHeader(t *testing.T) {
 		}),
 		option.WithHeaderDel("X-Stainless-Retry-Count"),
 	)
-	_, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
@@ -123,7 +123,7 @@ func TestOverwriteRetryCountHeader(t *testing.T) {
 		}),
 		option.WithHeader("X-Stainless-Retry-Count", "42"),
 	)
-	_, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
@@ -151,7 +151,7 @@ func TestRetryAfterMs(t *testing.T) {
 			},
 		}),
 	)
-	_, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
@@ -173,7 +173,7 @@ func TestContextCancel(t *testing.T) {
 	)
 	cancelCtx, cancel := context.WithCancel(context.Background())
 	cancel()
-	_, err := client.Runners.New(cancelCtx, gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(cancelCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("Expected there to be a cancel error")
 	}
@@ -192,7 +192,7 @@ func TestContextCancelDelay(t *testing.T) {
 	)
 	cancelCtx, cancel := context.WithTimeout(context.Background(), 2*time.Millisecond)
 	defer cancel()
-	_, err := client.Runners.New(cancelCtx, gitpod.RunnerNewParams{})
+	_, err := client.Identity.GetAuthenticatedIdentity(cancelCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err == nil {
 		t.Error("expected there to be a cancel error")
 	}
@@ -217,7 +217,7 @@ func TestContextDeadline(t *testing.T) {
 				},
 			}),
 		)
-		_, err := client.Runners.New(deadlineCtx, gitpod.RunnerNewParams{})
+		_, err := client.Identity.GetAuthenticatedIdentity(deadlineCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})
 		if err == nil {
 			t.Error("expected there to be a deadline error")
 		}
diff --git a/paginationauto_test.go b/paginationauto_test.go
@@ -24,11 +24,11 @@ func TestAutoPagination(t *testing.T) {
 		option.WithBaseURL(baseURL),
 		option.WithBearerToken("My Bearer Token"),
 	)
-	iter := client.Environments.Automations.Services.ListAutoPaging(context.TODO(), gitpod.EnvironmentAutomationServiceListParams{})
+	iter := client.Environments.ListAutoPaging(context.TODO(), gitpod.EnvironmentListParams{})
 	// Prism mock isn't going to give us real pagination
 	for i := 0; i < 3 && iter.Next(); i++ {
-		service := iter.Current()
-		t.Logf("%+v\n", service.ID)
+		environment := iter.Current()
+		t.Logf("%+v\n", environment.ID)
 	}
 	if err := iter.Err(); err != nil {
 		t.Fatalf("err should be nil: %s", err.Error())
diff --git a/paginationmanual_test.go b/paginationmanual_test.go
@@ -24,21 +24,21 @@ func TestManualPagination(t *testing.T) {
 		option.WithBaseURL(baseURL),
 		option.WithBearerToken("My Bearer Token"),
 	)
-	page, err := client.Environments.Automations.Services.List(context.TODO(), gitpod.EnvironmentAutomationServiceListParams{})
+	page, err := client.Environments.List(context.TODO(), gitpod.EnvironmentListParams{})
 	if err != nil {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
-	for _, service := range page.Services {
-		t.Logf("%+v\n", service.ID)
+	for _, environment := range page.Environments {
+		t.Logf("%+v\n", environment.ID)
 	}
 	// Prism mock isn't going to give us real pagination
 	page, err = page.GetNextPage()
 	if err != nil {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 	if page != nil {
-		for _, service := range page.Services {
-			t.Logf("%+v\n", service.ID)
+		for _, environment := range page.Environments {
+			t.Logf("%+v\n", environment.ID)
 		}
 	}
 }
diff --git a/usage_test.go b/usage_test.go
@@ -24,9 +24,9 @@ func TestUsage(t *testing.T) {
 		option.WithBaseURL(baseURL),
 		option.WithBearerToken("My Bearer Token"),
 	)
-	runner, err := client.Runners.New(context.TODO(), gitpod.RunnerNewParams{})
+	response, err := client.Identity.GetAuthenticatedIdentity(context.TODO(), gitpod.IdentityGetAuthenticatedIdentityParams{})
 	if err != nil {
 		t.Error(err)
 	}
-	t.Logf("%+v\n", runner.AccessToken)
+	t.Logf("%+v\n", response.OrganizationID)
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func TestUserAgentHeader(t *testing.T) {`
`37`	`37`	`},`
`38`	`38`	`}),`
`39`	`39`	`)`
`40`		`- client.Runners.New(context.Background(), gitpod.RunnerNewParams{})`
	`40`	`+ client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`41`	`41`	`if userAgent != fmt.Sprintf("Gitpod/Go %s", internal.PackageVersion) {`
`42`	`42`	`t.Errorf("Expected User-Agent to be correct, but got: %#v", userAgent)`
`43`	`43`	`}`
`@@ -60,7 +60,7 @@ func TestRetryAfter(t *testing.T) {`
`60`	`60`	`},`
`61`	`61`	`}),`
`62`	`62`	`)`
`63`		`- _, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})`
	`63`	`+ _, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`64`	`64`	`if err == nil {`
`65`	`65`	`t.Error("Expected there to be a cancel error")`
`66`	`66`	`}`
`@@ -94,7 +94,7 @@ func TestDeleteRetryCountHeader(t *testing.T) {`
`94`	`94`	`}),`
`95`	`95`	`option.WithHeaderDel("X-Stainless-Retry-Count"),`
`96`	`96`	`)`
`97`		`- _, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})`
	`97`	`+ _, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`98`	`98`	`if err == nil {`
`99`	`99`	`t.Error("Expected there to be a cancel error")`
`100`	`100`	`}`
`@@ -123,7 +123,7 @@ func TestOverwriteRetryCountHeader(t *testing.T) {`
`123`	`123`	`}),`
`124`	`124`	`option.WithHeader("X-Stainless-Retry-Count", "42"),`
`125`	`125`	`)`
`126`		`- _, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})`
	`126`	`+ _, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`127`	`127`	`if err == nil {`
`128`	`128`	`t.Error("Expected there to be a cancel error")`
`129`	`129`	`}`
`@@ -151,7 +151,7 @@ func TestRetryAfterMs(t *testing.T) {`
`151`	`151`	`},`
`152`	`152`	`}),`
`153`	`153`	`)`
`154`		`- _, err := client.Runners.New(context.Background(), gitpod.RunnerNewParams{})`
	`154`	`+ _, err := client.Identity.GetAuthenticatedIdentity(context.Background(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`155`	`155`	`if err == nil {`
`156`	`156`	`t.Error("Expected there to be a cancel error")`
`157`	`157`	`}`
`@@ -173,7 +173,7 @@ func TestContextCancel(t *testing.T) {`
`173`	`173`	`)`
`174`	`174`	`cancelCtx, cancel := context.WithCancel(context.Background())`
`175`	`175`	`cancel()`
`176`		`- _, err := client.Runners.New(cancelCtx, gitpod.RunnerNewParams{})`
	`176`	`+ _, err := client.Identity.GetAuthenticatedIdentity(cancelCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})`
`177`	`177`	`if err == nil {`
`178`	`178`	`t.Error("Expected there to be a cancel error")`
`179`	`179`	`}`
`@@ -192,7 +192,7 @@ func TestContextCancelDelay(t *testing.T) {`
`192`	`192`	`)`
`193`	`193`	`cancelCtx, cancel := context.WithTimeout(context.Background(), 2*time.Millisecond)`
`194`	`194`	`defer cancel()`
`195`		`- _, err := client.Runners.New(cancelCtx, gitpod.RunnerNewParams{})`
	`195`	`+ _, err := client.Identity.GetAuthenticatedIdentity(cancelCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})`
`196`	`196`	`if err == nil {`
`197`	`197`	`t.Error("expected there to be a cancel error")`
`198`	`198`	`}`
`@@ -217,7 +217,7 @@ func TestContextDeadline(t *testing.T) {`
`217`	`217`	`},`
`218`	`218`	`}),`
`219`	`219`	`)`
`220`		`- _, err := client.Runners.New(deadlineCtx, gitpod.RunnerNewParams{})`
	`220`	`+ _, err := client.Identity.GetAuthenticatedIdentity(deadlineCtx, gitpod.IdentityGetAuthenticatedIdentityParams{})`
`221`	`221`	`if err == nil {`
`222`	`222`	`t.Error("expected there to be a deadline error")`
`223`	`223`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,21 +24,21 @@ func TestManualPagination(t *testing.T) {`
`24`	`24`	`option.WithBaseURL(baseURL),`
`25`	`25`	`option.WithBearerToken("My Bearer Token"),`
`26`	`26`	`)`
`27`		`- page, err := client.Environments.Automations.Services.List(context.TODO(), gitpod.EnvironmentAutomationServiceListParams{})`
	`27`	`+ page, err := client.Environments.List(context.TODO(), gitpod.EnvironmentListParams{})`
`28`	`28`	`if err != nil {`
`29`	`29`	`t.Fatalf("err should be nil: %s", err.Error())`
`30`	`30`	`}`
`31`		`- for _, service := range page.Services {`
`32`		`- t.Logf("%+v\n", service.ID)`
	`31`	`+ for _, environment := range page.Environments {`
	`32`	`+ t.Logf("%+v\n", environment.ID)`
`33`	`33`	`}`
`34`	`34`	`// Prism mock isn't going to give us real pagination`
`35`	`35`	`page, err = page.GetNextPage()`
`36`	`36`	`if err != nil {`
`37`	`37`	`t.Fatalf("err should be nil: %s", err.Error())`
`38`	`38`	`}`
`39`	`39`	`if page != nil {`
`40`		`- for _, service := range page.Services {`
`41`		`- t.Logf("%+v\n", service.ID)`
	`40`	`+ for _, environment := range page.Environments {`
	`41`	`+ t.Logf("%+v\n", environment.ID)`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@ func TestUsage(t *testing.T) {`
`24`	`24`	`option.WithBaseURL(baseURL),`
`25`	`25`	`option.WithBearerToken("My Bearer Token"),`
`26`	`26`	`)`
`27`		`- runner, err := client.Runners.New(context.TODO(), gitpod.RunnerNewParams{})`
	`27`	`+ response, err := client.Identity.GetAuthenticatedIdentity(context.TODO(), gitpod.IdentityGetAuthenticatedIdentityParams{})`
`28`	`28`	`if err != nil {`
`29`	`29`	`t.Error(err)`
`30`	`30`	`}`
`31`		`- t.Logf("%+v\n", runner.AccessToken)`
	`31`	`+ t.Logf("%+v\n", response.OrganizationID)`
`32`	`32`	`}`