From 5121d4385d07eb1322957a0931d806fa5d829ce5 Mon Sep 17 00:00:00 2001 From: Jess Frazelle Date: Mon, 31 Jul 2023 18:23:25 -0700 Subject: [PATCH] updates Signed-off-by: Jess Frazelle --- VERSION.txt | 2 +- cmd/tmpl/function-example.tmpl | 2 +- examples_test.go | 575 ++++++++++++++++++++++++++++----- kittycad.go.patch.json | 150 ++++----- 4 files changed, 577 insertions(+), 152 deletions(-) diff --git a/VERSION.txt b/VERSION.txt index cc9a95d..ee5e3e7 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -v0.2.20 +v0.2.21 diff --git a/cmd/tmpl/function-example.tmpl b/cmd/tmpl/function-example.tmpl index d9c7c8d..66798f4 100644 --- a/cmd/tmpl/function-example.tmpl +++ b/cmd/tmpl/function-example.tmpl @@ -1,4 +1,4 @@ -// Create a client with your token. +// {{.Description}} func Example{{.Tag}}Service_{{.Name}}() { client, err := {{.PackageName}}.NewClientFromEnv("your apps user agent") if err != nil { diff --git a/examples_test.go b/examples_test.go index 894fa1f..a6454d9 100644 --- a/examples_test.go +++ b/examples_test.go @@ -49,7 +49,7 @@ func ExampleNewClientFromEnv() { fmt.Printf("%#v", result) } -// Create a client with your token. +// GetSchema: Get OpenAPI schema. func ExampleMetaService_GetSchema() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -62,7 +62,7 @@ func ExampleMetaService_GetSchema() { } -// Create a client with your token. +// GetAiPluginManifest: Get AI plugin manifest. func ExampleMetaService_GetAiPluginManifest() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -78,7 +78,9 @@ func ExampleMetaService_GetAiPluginManifest() { } -// Create a client with your token. +// Getdata: Get the metadata about our currently running server. +// This includes information on any of our other distributed systems it is connected to. +// You must be a KittyCAD employee to perform this request. func ExampleMetaService_Getdata() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -94,7 +96,14 @@ func ExampleMetaService_Getdata() { } -// Create a client with your token. +// CreateImageTo3D: Generate a 3D model from an image. +// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better. +// +// Parameters +// +// - `inputFormat`: An enumeration. +// - `outputFormat`: The valid types of output file formats. +// - `body` func ExampleAiService_CreateImageTo3D() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -110,7 +119,13 @@ func ExampleAiService_CreateImageTo3D() { } -// Create a client with your token. +// CreateTextTo3D: Generate a 3D model from text. +// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better. +// +// Parameters +// +// - `outputFormat`: The valid types of output file formats. +// - `prompt` func ExampleAiService_CreateTextTo3D() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -126,7 +141,12 @@ func ExampleAiService_CreateTextTo3D() { } -// Create a client with your token. +// GetMetrics: Get API call metrics. +// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed. +// +// Parameters +// +// - `groupBy`: The field of an API call to group by. func ExampleAPICallService_GetMetrics() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -142,7 +162,18 @@ func ExampleAPICallService_GetMetrics() { } -// Create a client with your token. +// List: List API calls. +// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleAPICallService_List() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -158,7 +189,14 @@ func ExampleAPICallService_List() { } -// Create a client with your token. +// Get: Get details of an API call. +// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user. +// If the user is not authenticated to view the specified API call, then it is not returned. +// Only KittyCAD employees can view API calls for other users. +// +// Parameters +// +// - `id` func ExampleAPICallService_Get() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -174,7 +212,13 @@ func ExampleAPICallService_Get() { } -// Create a client with your token. +// GithubCallback: Listen for callbacks to GitHub app authentication. +// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos. +// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos. +// +// Parameters +// +// - `body` func ExampleAppService_GithubCallback() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -187,7 +231,9 @@ func ExampleAppService_GithubCallback() { } -// Create a client with your token. +// GithubConsent: Get the consent URL for GitHub app authentication. +// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos. +// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos. func ExampleAppService_GithubConsent() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -203,7 +249,12 @@ func ExampleAppService_GithubConsent() { } -// Create a client with your token. +// GithubWebhook: Listen for GitHub webhooks. +// These come from the GitHub app. +// +// Parameters +// +// - `body` func ExampleAppService_GithubWebhook() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -216,7 +267,21 @@ func ExampleAppService_GithubWebhook() { } -// Create a client with your token. +// ListAsyncOperations: List async operations. +// For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint. +// This endpoint requires authentication by a KittyCAD employee. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. +// +// - `status`: The status of an async API call. func ExampleAPICallService_ListAsyncOperations() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -232,7 +297,15 @@ func ExampleAPICallService_ListAsyncOperations() { } -// Create a client with your token. +// GetAsyncOperation: Get an async operation. +// Get the status and output of an async operation. +// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user. +// If the user is not authenticated to view the specified async operation, then it is not returned. +// Only KittyCAD employees with the proper access can view async operations for other users. +// +// Parameters +// +// - `id` func ExampleAPICallService_GetAsyncOperation() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -248,7 +321,10 @@ func ExampleAPICallService_GetAsyncOperation() { } -// Create a client with your token. +// AuthEmail: Create an email verification request for a user. +// Parameters +// +// - `body`: The body of the form for email authentication. func ExampleHiddenService_AuthEmail() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -264,7 +340,12 @@ func ExampleHiddenService_AuthEmail() { } -// Create a client with your token. +// AuthEmailCallback: Listen for callbacks for email verification for users. +// Parameters +// +// - `callbackUrl` +// - `email` +// - `token` func ExampleHiddenService_AuthEmailCallback() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -277,7 +358,10 @@ func ExampleHiddenService_AuthEmailCallback() { } -// Create a client with your token. +// GetPhysics: Get a physics constant. +// Parameters +// +// - `constant`: The valid types of phys constant names. func ExampleConstantService_GetPhysics() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -293,7 +377,18 @@ func ExampleConstantService_GetPhysics() { } -// Create a client with your token. +// CreateCenterOfMass: Get CAD file center of mass. +// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. +// Currently, this endpoint returns the cartesian co-ordinate in world space measure units. +// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. +// Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `outputUnit`: The valid types of length units. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateCenterOfMass() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -309,7 +404,17 @@ func ExampleFileService_CreateCenterOfMass() { } -// Create a client with your token. +// CreateConversion: Convert CAD file with defaults. +// If you wish to specify the conversion options, use the `/file/conversion` endpoint instead. +// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously. +// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `outputFormat`: The valid types of output file formats. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -325,7 +430,20 @@ func ExampleFileService_CreateConversion() { } -// Create a client with your token. +// CreateDensity: Get CAD file density. +// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. +// Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit. +// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. +// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `materialMass` +// - `materialMassUnit`: The valid types of mass units. +// - `outputUnit`: The valid types for density units. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateDensity() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -341,7 +459,12 @@ func ExampleFileService_CreateDensity() { } -// Create a client with your token. +// CreateFileExecution: Execute a KittyCAD program in a specific language. +// Parameters +// +// - `lang`: The language code is written in. +// - `output` +// - `body` func ExampleExecutorService_CreateFileExecution() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -357,7 +480,20 @@ func ExampleExecutorService_CreateFileExecution() { } -// Create a client with your token. +// CreateMass: Get CAD file mass. +// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. +// Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density. +// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. +// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `materialDensity` +// - `materialDensityUnit`: The valid types for density units. +// - `outputUnit`: The valid types of mass units. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateMass() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -373,7 +509,18 @@ func ExampleFileService_CreateMass() { } -// Create a client with your token. +// CreateSurfaceArea: Get CAD file surface area. +// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. +// Currently, this endpoint returns the square measure units. +// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. +// Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `outputUnit`: The valid types of area units. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateSurfaceArea() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -389,7 +536,18 @@ func ExampleFileService_CreateSurfaceArea() { } -// Create a client with your token. +// CreateVolume: Get CAD file volume. +// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. +// Currently, this endpoint returns the cubic measure units. +// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. +// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. +// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. +// +// Parameters +// +// - `outputUnit`: The valid types of volume units. +// - `srcFormat`: The valid types of source file formats. +// - `body` func ExampleFileService_CreateVolume() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -405,7 +563,8 @@ func ExampleFileService_CreateVolume() { } -// Create a client with your token. +// Logout: This endpoint removes the session cookie for a user. +// This is used in logout scenarios. func ExampleHiddenService_Logout() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -418,7 +577,12 @@ func ExampleHiddenService_Logout() { } -// Create a client with your token. +// Cmd: Submit one modeling operation. +// Response depends on which command was submitted, so unfortunately the OpenAPI schema can't generate the right response type. +// +// Parameters +// +// - `body`: A graphics command submitted to the KittyCAD engine via the Modeling API. func ExampleModelingService_Cmd() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -431,7 +595,10 @@ func ExampleModelingService_Cmd() { } -// Create a client with your token. +// CmdBatch: Submit many modeling operations. +// Parameters +// +// - `body`: A batch set of graphics commands submitted to the KittyCAD engine via the Modeling API. func ExampleModelingService_CmdBatch() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -447,7 +614,12 @@ func ExampleModelingService_CmdBatch() { } -// Create a client with your token. +// DeviceAuthRequest: Start an OAuth 2.0 Device Authorization Grant. +// This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted. +// +// Parameters +// +// - `body`: The request parameters for the OAuth 2.0 Device Authorization Grant flow. func ExampleOauth2Service_DeviceAuthRequest() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -460,7 +632,12 @@ func ExampleOauth2Service_DeviceAuthRequest() { } -// Create a client with your token. +// DeviceAuthConfirm: Confirm an OAuth 2.0 Device Authorization Grant. +// This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`. +// +// Parameters +// +// - `body`: The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant. func ExampleOauth2Service_DeviceAuthConfirm() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -473,7 +650,12 @@ func ExampleOauth2Service_DeviceAuthConfirm() { } -// Create a client with your token. +// DeviceAccessToken: Request a device access token. +// This endpoint should be polled by the client until the user code is verified and the grant is confirmed. +// +// Parameters +// +// - `body`: The form for a device access token request. func ExampleOauth2Service_DeviceAccessToken() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -486,7 +668,12 @@ func ExampleOauth2Service_DeviceAccessToken() { } -// Create a client with your token. +// DeviceAuthVerify: Verify an OAuth 2.0 Device Authorization Grant. +// This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website. +// +// Parameters +// +// - `userCode` func ExampleOauth2Service_DeviceAuthVerify() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -499,7 +686,12 @@ func ExampleOauth2Service_DeviceAuthVerify() { } -// Create a client with your token. +// ProviderCallback: Listen for callbacks for the OAuth 2.0 provider. +// Parameters +// +// - `provider`: An account provider. +// - `code` +// - `state` func ExampleOauth2Service_ProviderCallback() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -512,7 +704,11 @@ func ExampleOauth2Service_ProviderCallback() { } -// Create a client with your token. +// ProviderConsent: Get the consent URL and other information for the OAuth 2.0 provider. +// Parameters +// +// - `provider`: An account provider. +// - `callbackUrl` func ExampleOauth2Service_ProviderConsent() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -528,7 +724,8 @@ func ExampleOauth2Service_ProviderConsent() { } -// Create a client with your token. +// GetOpenaiSchema: Get AI plugin OpenAPI schema. +// This is the same as the OpenAPI schema, BUT it has some modifications to make it compatible with OpenAI. For example, descriptions must be < 300 chars. func ExampleMetaService_GetOpenaiSchema() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -541,7 +738,7 @@ func ExampleMetaService_GetOpenaiSchema() { } -// Create a client with your token. +// Ping: Return pong. func ExampleMetaService_Ping() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -557,7 +754,14 @@ func ExampleMetaService_Ping() { } -// Create a client with your token. +// GetAngleConversion: Convert angle units. +// Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of angle formats. +// - `outputUnit`: The valid types of angle formats. +// - `value` func ExampleUnitService_GetAngleConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -573,7 +777,14 @@ func ExampleUnitService_GetAngleConversion() { } -// Create a client with your token. +// GetAreaConversion: Convert area units. +// Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of area units. +// - `outputUnit`: The valid types of area units. +// - `value` func ExampleUnitService_GetAreaConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -589,7 +800,14 @@ func ExampleUnitService_GetAreaConversion() { } -// Create a client with your token. +// GetCurrentConversion: Convert current units. +// Convert a current unit value to another current unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of current units. +// - `outputUnit`: The valid types of current units. +// - `value` func ExampleUnitService_GetCurrentConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -605,7 +823,14 @@ func ExampleUnitService_GetCurrentConversion() { } -// Create a client with your token. +// GetEnergyConversion: Convert energy units. +// Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of energy units. +// - `outputUnit`: The valid types of energy units. +// - `value` func ExampleUnitService_GetEnergyConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -621,7 +846,14 @@ func ExampleUnitService_GetEnergyConversion() { } -// Create a client with your token. +// GetForceConversion: Convert force units. +// Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of force units. +// - `outputUnit`: The valid types of force units. +// - `value` func ExampleUnitService_GetForceConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -637,7 +869,14 @@ func ExampleUnitService_GetForceConversion() { } -// Create a client with your token. +// GetFrequencyConversion: Convert frequency units. +// Convert a frequency unit value to another frequency unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of frequency units. +// - `outputUnit`: The valid types of frequency units. +// - `value` func ExampleUnitService_GetFrequencyConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -653,7 +892,14 @@ func ExampleUnitService_GetFrequencyConversion() { } -// Create a client with your token. +// GetLengthConversion: Convert length units. +// Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of length units. +// - `outputUnit`: The valid types of length units. +// - `value` func ExampleUnitService_GetLengthConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -669,7 +915,14 @@ func ExampleUnitService_GetLengthConversion() { } -// Create a client with your token. +// GetMassConversion: Convert mass units. +// Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of mass units. +// - `outputUnit`: The valid types of mass units. +// - `value` func ExampleUnitService_GetMassConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -685,7 +938,14 @@ func ExampleUnitService_GetMassConversion() { } -// Create a client with your token. +// GetPowerConversion: Convert power units. +// Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of power units. +// - `outputUnit`: The valid types of power units. +// - `value` func ExampleUnitService_GetPowerConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -701,7 +961,14 @@ func ExampleUnitService_GetPowerConversion() { } -// Create a client with your token. +// GetPressureConversion: Convert pressure units. +// Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of pressure units. +// - `outputUnit`: The valid types of pressure units. +// - `value` func ExampleUnitService_GetPressureConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -717,7 +984,14 @@ func ExampleUnitService_GetPressureConversion() { } -// Create a client with your token. +// GetTemperatureConversion: Convert temperature units. +// Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of temperature units. +// - `outputUnit`: The valid types of temperature units. +// - `value` func ExampleUnitService_GetTemperatureConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -733,7 +1007,14 @@ func ExampleUnitService_GetTemperatureConversion() { } -// Create a client with your token. +// GetTorqueConversion: Convert torque units. +// Convert a torque unit value to another torque unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of torque units. +// - `outputUnit`: The valid types of torque units. +// - `value` func ExampleUnitService_GetTorqueConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -749,7 +1030,14 @@ func ExampleUnitService_GetTorqueConversion() { } -// Create a client with your token. +// GetVolumeConversion: Convert volume units. +// Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions. +// +// Parameters +// +// - `inputUnit`: The valid types of volume units. +// - `outputUnit`: The valid types of volume units. +// - `value` func ExampleUnitService_GetVolumeConversion() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -765,7 +1053,9 @@ func ExampleUnitService_GetVolumeConversion() { } -// Create a client with your token. +// GetSelf: Get your user. +// Get the user information for the authenticated user. +// Alternatively, you can also use the `/users/me` endpoint. func ExampleUserService_GetSelf() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -781,7 +1071,12 @@ func ExampleUserService_GetSelf() { } -// Create a client with your token. +// UpdateSelf: Update your user. +// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user. +// +// Parameters +// +// - `body`: The user-modifiable parts of a User. func ExampleUserService_UpdateSelf() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -797,7 +1092,9 @@ func ExampleUserService_UpdateSelf() { } -// Create a client with your token. +// DeleteSelf: Delete your user. +// This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database. +// This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance. func ExampleUserService_DeleteSelf() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -810,7 +1107,19 @@ func ExampleUserService_DeleteSelf() { } -// Create a client with your token. +// UserList: List API calls for your user. +// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user. +// The API calls are returned in order of creation, with the most recently created API calls first. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleAPICallService_UserList() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -826,7 +1135,12 @@ func ExampleAPICallService_UserList() { } -// Create a client with your token. +// GetForUser: Get an API call for a user. +// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user. +// +// Parameters +// +// - `id` func ExampleAPICallService_GetForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -842,7 +1156,19 @@ func ExampleAPICallService_GetForUser() { } -// Create a client with your token. +// ListForUser: List API tokens for your user. +// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user. +// The API tokens are returned in order of creation, with the most recently created API tokens first. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleAPITokenService_ListForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -858,7 +1184,8 @@ func ExampleAPITokenService_ListForUser() { } -// Create a client with your token. +// CreateForUser: Create a new API token for your user. +// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user. func ExampleAPITokenService_CreateForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -874,7 +1201,12 @@ func ExampleAPITokenService_CreateForUser() { } -// Create a client with your token. +// GetForUser: Get an API token for your user. +// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user. +// +// Parameters +// +// - `token` func ExampleAPITokenService_GetForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -890,7 +1222,13 @@ func ExampleAPITokenService_GetForUser() { } -// Create a client with your token. +// DeleteForUser: Delete an API token for your user. +// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user. +// This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes. +// +// Parameters +// +// - `token` func ExampleAPITokenService_DeleteForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -903,7 +1241,9 @@ func ExampleAPITokenService_DeleteForUser() { } -// Create a client with your token. +// GetSelfExtended: Get extended information about your user. +// Get the user information for the authenticated user. +// Alternatively, you can also use the `/users-extended/me` endpoint. func ExampleUserService_GetSelfExtended() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -919,7 +1259,8 @@ func ExampleUserService_GetSelfExtended() { } -// Create a client with your token. +// GetFrontHashSelf: Get your user's front verification hash. +// This info is sent to front when initialing the front chat, it prevents impersonations using js hacks in the browser func ExampleUserService_GetFrontHashSelf() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -935,7 +1276,8 @@ func ExampleUserService_GetFrontHashSelf() { } -// Create a client with your token. +// GetOnboardingSelf: Get your user's onboarding status. +// Checks key part of their api usage to determine their onboarding progress func ExampleUserService_GetOnboardingSelf() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -951,7 +1293,9 @@ func ExampleUserService_GetOnboardingSelf() { } -// Create a client with your token. +// GetInformationForUser: Get payment info about your user. +// This includes billing address, phone, and name. +// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user. func ExamplePaymentService_GetInformationForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -967,7 +1311,13 @@ func ExamplePaymentService_GetInformationForUser() { } -// Create a client with your token. +// CreateInformationForUser: Create payment info for your user. +// This includes billing address, phone, and name. +// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user. +// +// Parameters +// +// - `body`: The billing information for payments. func ExamplePaymentService_CreateInformationForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -983,7 +1333,13 @@ func ExamplePaymentService_CreateInformationForUser() { } -// Create a client with your token. +// UpdateInformationForUser: Update payment info for your user. +// This includes billing address, phone, and name. +// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user. +// +// Parameters +// +// - `body`: The billing information for payments. func ExamplePaymentService_UpdateInformationForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -999,7 +1355,9 @@ func ExamplePaymentService_UpdateInformationForUser() { } -// Create a client with your token. +// DeleteInformationForUser: Delete payment info for your user. +// This includes billing address, phone, and name. +// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user. func ExamplePaymentService_DeleteInformationForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1012,7 +1370,8 @@ func ExamplePaymentService_DeleteInformationForUser() { } -// Create a client with your token. +// GetBalanceForUser: Get balance for your user. +// This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user. func ExamplePaymentService_GetBalanceForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1028,7 +1387,8 @@ func ExamplePaymentService_GetBalanceForUser() { } -// Create a client with your token. +// CreateIntentForUser: Create a payment intent for your user. +// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user. func ExamplePaymentService_CreateIntentForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1044,7 +1404,8 @@ func ExamplePaymentService_CreateIntentForUser() { } -// Create a client with your token. +// ListInvoicesForUser: List invoices for your user. +// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user. func ExamplePaymentService_ListInvoicesForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1060,7 +1421,8 @@ func ExamplePaymentService_ListInvoicesForUser() { } -// Create a client with your token. +// ListMethodsForUser: List payment methods for your user. +// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user. func ExamplePaymentService_ListMethodsForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1076,7 +1438,12 @@ func ExamplePaymentService_ListMethodsForUser() { } -// Create a client with your token. +// DeleteMethodForUser: Delete a payment method for your user. +// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user. +// +// Parameters +// +// - `id` func ExamplePaymentService_DeleteMethodForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1089,7 +1456,8 @@ func ExamplePaymentService_DeleteMethodForUser() { } -// Create a client with your token. +// ValidateCustomerTaxInformationForUser: Validate a customer's information is correct and valid for automatic tax. +// This endpoint requires authentication by any KittyCAD user. It will return an error if the customer's information is not valid for automatic tax. Otherwise, it will return an empty successful response. func ExamplePaymentService_ValidateCustomerTaxInformationForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1102,7 +1470,12 @@ func ExamplePaymentService_ValidateCustomerTaxInformationForUser() { } -// Create a client with your token. +// GetSessionFor: Get a session for your user. +// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user. +// +// Parameters +// +// - `token` func ExampleUserService_GetSessionFor() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1118,7 +1491,18 @@ func ExampleUserService_GetSessionFor() { } -// Create a client with your token. +// List: List users. +// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleUserService_List() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1134,7 +1518,18 @@ func ExampleUserService_List() { } -// Create a client with your token. +// ListExtended: List users with extended information. +// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first. +// +// Parameters +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleUserService_ListExtended() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1150,7 +1545,14 @@ func ExampleUserService_ListExtended() { } -// Create a client with your token. +// GetExtended: Get extended information about a user. +// To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user. +// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint. +// To get information about any KittyCAD user, you must be a KittyCAD employee. +// +// Parameters +// +// - `id` func ExampleUserService_GetExtended() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1166,7 +1568,14 @@ func ExampleUserService_GetExtended() { } -// Create a client with your token. +// Get: Get a user. +// To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user. +// Alternatively, to get information about the authenticated user, use `/user` endpoint. +// To get information about any KittyCAD user, you must be a KittyCAD employee. +// +// Parameters +// +// - `id` func ExampleUserService_Get() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { @@ -1182,7 +1591,23 @@ func ExampleUserService_Get() { } -// Create a client with your token. +// ListForUser: List API calls for a user. +// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if "me" is passed as the user id. +// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user. +// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id. +// The API calls are returned in order of creation, with the most recently created API calls first. +// +// Parameters +// +// - `id` +// +// - `limit` +// +// - `pageToken` +// +// - `sortBy`: Supported set of sort modes for scanning by created_at only. +// +// Currently, we only support scanning in ascending order. func ExampleAPICallService_ListForUser() { client, err := kittycad.NewClientFromEnv("your apps user agent") if err != nil { diff --git a/kittycad.go.patch.json b/kittycad.go.patch.json index a896e46..4a5ec40 100644 --- a/kittycad.go.patch.json +++ b/kittycad.go.patch.json @@ -9,7 +9,7 @@ }, { "value": { - "example": "// GetSchema: Get OpenAPI schema.\n// \n// Create a client with your token.\nfunc ExampleMetaService_GetSchema() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Meta.GetSchema(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// GetSchema: Get OpenAPI schema.\n// \n// GetSchema: Get OpenAPI schema.\nfunc ExampleMetaService_GetSchema() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Meta.GetSchema(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.GetSchema" }, "op": "add", @@ -17,7 +17,7 @@ }, { "value": { - "example": "// GetAiPluginManifest: Get AI plugin manifest.\n// \n// Create a client with your token.\nfunc ExampleMetaService_GetAiPluginManifest() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.GetAiPluginManifest()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetAiPluginManifest: Get AI plugin manifest.\n// \n// GetAiPluginManifest: Get AI plugin manifest.\nfunc ExampleMetaService_GetAiPluginManifest() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.GetAiPluginManifest()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.GetAiPluginManifest" }, "op": "add", @@ -25,7 +25,7 @@ }, { "value": { - "example": "// Getdata: Get the metadata about our currently running server.\n// \n// This includes information on any of our other distributed systems it is connected to.\n// You must be a KittyCAD employee to perform this request.\n// \n// Create a client with your token.\nfunc ExampleMetaService_Getdata() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.Getdata()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// Getdata: Get the metadata about our currently running server.\n// \n// This includes information on any of our other distributed systems it is connected to.\n// You must be a KittyCAD employee to perform this request.\n// \n// Getdata: Get the metadata about our currently running server.\n// This includes information on any of our other distributed systems it is connected to.\n// You must be a KittyCAD employee to perform this request.\nfunc ExampleMetaService_Getdata() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.Getdata()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Getdata" }, "op": "add", @@ -33,7 +33,7 @@ }, { "value": { - "example": "// CreateImageTo3D: Generate a 3D model from an image.\n// \n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n// \n// \n// Parameters\n// \n// \t- `inputFormat`: An enumeration.\n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleAiService_CreateImageTo3D() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Ai.CreateImageTo3D(kittycad.ImageTypePng, \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateImageTo3D: Generate a 3D model from an image.\n// \n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n// \n// \n// Parameters\n// \n// \t- `inputFormat`: An enumeration.\n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `body`\n// \n// CreateImageTo3D: Generate a 3D model from an image.\n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n//\n// Parameters\n//\n// - `inputFormat`: An enumeration.\n// - `outputFormat`: The valid types of output file formats.\n// - `body`\nfunc ExampleAiService_CreateImageTo3D() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Ai.CreateImageTo3D(kittycad.ImageTypePng, \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#AiService.CreateImageTo3D" }, "op": "add", @@ -41,7 +41,7 @@ }, { "value": { - "example": "// CreateTextTo3D: Generate a 3D model from text.\n// \n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n// \n// \n// Parameters\n// \n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `prompt`\n// \n// Create a client with your token.\nfunc ExampleAiService_CreateTextTo3D() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Ai.CreateTextTo3D(\"\", \"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateTextTo3D: Generate a 3D model from text.\n// \n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n// \n// \n// Parameters\n// \n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `prompt`\n// \n// CreateTextTo3D: Generate a 3D model from text.\n// This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.\n//\n// Parameters\n//\n// - `outputFormat`: The valid types of output file formats.\n// - `prompt`\nfunc ExampleAiService_CreateTextTo3D() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Ai.CreateTextTo3D(\"\", \"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#AiService.CreateTextTo3D" }, "op": "add", @@ -49,7 +49,7 @@ }, { "value": { - "example": "// GetMetrics: Get API call metrics.\n// \n// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n// \n// \n// Parameters\n// \n// \t- `groupBy`: The field of an API call to group by.\n// \n// Create a client with your token.\nfunc ExampleAPICallService_GetMetrics() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetMetrics(\"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetMetrics: Get API call metrics.\n// \n// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n// \n// \n// Parameters\n// \n// \t- `groupBy`: The field of an API call to group by.\n// \n// GetMetrics: Get API call metrics.\n// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n//\n// Parameters\n//\n// - `groupBy`: The field of an API call to group by.\nfunc ExampleAPICallService_GetMetrics() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetMetrics(\"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetMetrics" }, "op": "add", @@ -57,7 +57,7 @@ }, { "value": { - "example": "// List: List API calls.\n// \n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleAPICallService_List() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.List(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// List: List API calls.\n// \n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// List: List API calls.\n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleAPICallService_List() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.List(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.List" }, "op": "add", @@ -65,7 +65,7 @@ }, { "value": { - "example": "// Get: Get details of an API call.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// If the user is not authenticated to view the specified API call, then it is not returned.\n// Only KittyCAD employees can view API calls for other users.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExampleAPICallService_Get() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.Get(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// Get: Get details of an API call.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// If the user is not authenticated to view the specified API call, then it is not returned.\n// Only KittyCAD employees can view API calls for other users.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Get: Get details of an API call.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// If the user is not authenticated to view the specified API call, then it is not returned.\n// Only KittyCAD employees can view API calls for other users.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleAPICallService_Get() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.Get(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.Get" }, "op": "add", @@ -73,7 +73,7 @@ }, { "value": { - "example": "// GithubCallback: Listen for callbacks to GitHub app authentication.\n// \n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\n// \n// \n// Parameters\n// \n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleAppService_GithubCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.App.GithubCallback(\"\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// GithubCallback: Listen for callbacks to GitHub app authentication.\n// \n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\n// \n// \n// Parameters\n// \n// \t- `body`\n// \n// GithubCallback: Listen for callbacks to GitHub app authentication.\n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\n//\n// Parameters\n//\n// - `body`\nfunc ExampleAppService_GithubCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.App.GithubCallback(\"\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#AppService.GithubCallback" }, "op": "add", @@ -81,7 +81,7 @@ }, { "value": { - "example": "// GithubConsent: Get the consent URL for GitHub app authentication.\n// \n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\n// \n// Create a client with your token.\nfunc ExampleAppService_GithubConsent() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.App.GithubConsent()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GithubConsent: Get the consent URL for GitHub app authentication.\n// \n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\n// \n// GithubConsent: Get the consent URL for GitHub app authentication.\n// This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\n// The user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.\nfunc ExampleAppService_GithubConsent() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.App.GithubConsent()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#AppService.GithubConsent" }, "op": "add", @@ -89,7 +89,7 @@ }, { "value": { - "example": "// GithubWebhook: Listen for GitHub webhooks.\n// \n// These come from the GitHub app.\n// \n// \n// Parameters\n// \n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleAppService_GithubWebhook() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.App.GithubWebhook([]byte(\"some-binary\")); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// GithubWebhook: Listen for GitHub webhooks.\n// \n// These come from the GitHub app.\n// \n// \n// Parameters\n// \n// \t- `body`\n// \n// GithubWebhook: Listen for GitHub webhooks.\n// These come from the GitHub app.\n//\n// Parameters\n//\n// - `body`\nfunc ExampleAppService_GithubWebhook() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.App.GithubWebhook([]byte(\"some-binary\")); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#AppService.GithubWebhook" }, "op": "add", @@ -97,7 +97,7 @@ }, { "value": { - "example": "// ListAsyncOperations: List async operations.\n// \n// For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.\n// This endpoint requires authentication by a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \t- `status`: The status of an async API call.\n// \n// Create a client with your token.\nfunc ExampleAPICallService_ListAsyncOperations() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.ListAsyncOperations(123, \"some-string\", \"\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListAsyncOperations: List async operations.\n// \n// For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.\n// This endpoint requires authentication by a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \t- `status`: The status of an async API call.\n// \n// ListAsyncOperations: List async operations.\n// For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.\n// This endpoint requires authentication by a KittyCAD employee.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\n//\n// - `status`: The status of an async API call.\nfunc ExampleAPICallService_ListAsyncOperations() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.ListAsyncOperations(123, \"some-string\", \"\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListAsyncOperations" }, "op": "add", @@ -105,7 +105,7 @@ }, { "value": { - "example": "// GetAsyncOperation: Get an async operation.\n// \n// Get the status and output of an async operation.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n// If the user is not authenticated to view the specified async operation, then it is not returned.\n// Only KittyCAD employees with the proper access can view async operations for other users.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExampleAPICallService_GetAsyncOperation() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetAsyncOperation(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetAsyncOperation: Get an async operation.\n// \n// Get the status and output of an async operation.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n// If the user is not authenticated to view the specified async operation, then it is not returned.\n// Only KittyCAD employees with the proper access can view async operations for other users.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// GetAsyncOperation: Get an async operation.\n// Get the status and output of an async operation.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n// If the user is not authenticated to view the specified async operation, then it is not returned.\n// Only KittyCAD employees with the proper access can view async operations for other users.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleAPICallService_GetAsyncOperation() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetAsyncOperation(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetAsyncOperation" }, "op": "add", @@ -113,7 +113,7 @@ }, { "value": { - "example": "// AuthEmail: Create an email verification request for a user.\n// \n// \n// Parameters\n// \n// \t- `body`: The body of the form for email authentication.\n// \n// Create a client with your token.\nfunc ExampleHiddenService_AuthEmail() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Hidden.AuthEmail(kittycad.EmailAuthenticationForm{CallbackUrl: kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}, Email: \"example@example.com\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// AuthEmail: Create an email verification request for a user.\n// \n// \n// Parameters\n// \n// \t- `body`: The body of the form for email authentication.\n// \n// AuthEmail: Create an email verification request for a user.\n// Parameters\n//\n// - `body`: The body of the form for email authentication.\nfunc ExampleHiddenService_AuthEmail() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Hidden.AuthEmail(kittycad.EmailAuthenticationForm{CallbackUrl: kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}, Email: \"example@example.com\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.AuthEmail" }, "op": "add", @@ -121,7 +121,7 @@ }, { "value": { - "example": "// AuthEmailCallback: Listen for callbacks for email verification for users.\n// \n// \n// Parameters\n// \n// \t- `callbackUrl`\n// \t- `email`\n// \t- `token`\n// \n// Create a client with your token.\nfunc ExampleHiddenService_AuthEmailCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.AuthEmailCallback(kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}, \"example@example.com\", \"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// AuthEmailCallback: Listen for callbacks for email verification for users.\n// \n// \n// Parameters\n// \n// \t- `callbackUrl`\n// \t- `email`\n// \t- `token`\n// \n// AuthEmailCallback: Listen for callbacks for email verification for users.\n// Parameters\n//\n// - `callbackUrl`\n// - `email`\n// - `token`\nfunc ExampleHiddenService_AuthEmailCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.AuthEmailCallback(kittycad.URL{\u0026url.URL{Scheme: \"https\", Host: \"example.com\"}}, \"example@example.com\", \"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.AuthEmailCallback" }, "op": "add", @@ -129,7 +129,7 @@ }, { "value": { - "example": "// GetPhysics: Get a physics constant.\n// \n// \n// Parameters\n// \n// \t- `constant`: The valid types of phys constant names.\n// \n// Create a client with your token.\nfunc ExampleConstantService_GetPhysics() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Constant.GetPhysics(\"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetPhysics: Get a physics constant.\n// \n// \n// Parameters\n// \n// \t- `constant`: The valid types of phys constant names.\n// \n// GetPhysics: Get a physics constant.\n// Parameters\n//\n// - `constant`: The valid types of phys constant names.\nfunc ExampleConstantService_GetPhysics() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Constant.GetPhysics(\"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#ConstantService.GetPhysics" }, "op": "add", @@ -137,7 +137,7 @@ }, { "value": { - "example": "// CreateCenterOfMass: Get CAD file center of mass.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cartesian co-ordinate in world space measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of length units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateCenterOfMass() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateCenterOfMass(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateCenterOfMass: Get CAD file center of mass.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cartesian co-ordinate in world space measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of length units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateCenterOfMass: Get CAD file center of mass.\n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cartesian co-ordinate in world space measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `outputUnit`: The valid types of length units.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateCenterOfMass() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateCenterOfMass(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateCenterOfMass" }, "op": "add", @@ -145,7 +145,7 @@ }, { "value": { - "example": "// CreateConversion: Convert CAD file with defaults.\n// \n// If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.\n// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateConversion(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateConversion: Convert CAD file with defaults.\n// \n// If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.\n// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputFormat`: The valid types of output file formats.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateConversion: Convert CAD file with defaults.\n// If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.\n// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `outputFormat`: The valid types of output file formats.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateConversion(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateConversion" }, "op": "add", @@ -153,7 +153,7 @@ }, { "value": { - "example": "// CreateDensity: Get CAD file density.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `materialMass`\n// \t- `materialMassUnit`: The valid types of mass units.\n// \t- `outputUnit`: The valid types for density units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateDensity() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateDensity(123.45, \"\", \"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateDensity: Get CAD file density.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `materialMass`\n// \t- `materialMassUnit`: The valid types of mass units.\n// \t- `outputUnit`: The valid types for density units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateDensity: Get CAD file density.\n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `materialMass`\n// - `materialMassUnit`: The valid types of mass units.\n// - `outputUnit`: The valid types for density units.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateDensity() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateDensity(123.45, \"\", \"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateDensity" }, "op": "add", @@ -161,7 +161,7 @@ }, { "value": { - "example": "// CreateFileExecution: Execute a KittyCAD program in a specific language.\n// \n// \n// Parameters\n// \n// \t- `lang`: The language code is written in.\n// \t- `output`\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleExecutorService_CreateFileExecution() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Executor.CreateFileExecution(\"\", \"some-string\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateFileExecution: Execute a KittyCAD program in a specific language.\n// \n// \n// Parameters\n// \n// \t- `lang`: The language code is written in.\n// \t- `output`\n// \t- `body`\n// \n// CreateFileExecution: Execute a KittyCAD program in a specific language.\n// Parameters\n//\n// - `lang`: The language code is written in.\n// - `output`\n// - `body`\nfunc ExampleExecutorService_CreateFileExecution() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Executor.CreateFileExecution(\"\", \"some-string\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#ExecutorService.CreateFileExecution" }, "op": "add", @@ -169,7 +169,7 @@ }, { "value": { - "example": "// CreateMass: Get CAD file mass.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `materialDensity`\n// \t- `materialDensityUnit`: The valid types for density units.\n// \t- `outputUnit`: The valid types of mass units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateMass() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateMass(123.45, \"\", \"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateMass: Get CAD file mass.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `materialDensity`\n// \t- `materialDensityUnit`: The valid types for density units.\n// \t- `outputUnit`: The valid types of mass units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateMass: Get CAD file mass.\n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `materialDensity`\n// - `materialDensityUnit`: The valid types for density units.\n// - `outputUnit`: The valid types of mass units.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateMass() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateMass(123.45, \"\", \"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateMass" }, "op": "add", @@ -177,7 +177,7 @@ }, { "value": { - "example": "// CreateSurfaceArea: Get CAD file surface area.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the square measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of area units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateSurfaceArea() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateSurfaceArea(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateSurfaceArea: Get CAD file surface area.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the square measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of area units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateSurfaceArea: Get CAD file surface area.\n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the square measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `outputUnit`: The valid types of area units.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateSurfaceArea() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateSurfaceArea(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateSurfaceArea" }, "op": "add", @@ -185,7 +185,7 @@ }, { "value": { - "example": "// CreateVolume: Get CAD file volume.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cubic measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of volume units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// Create a client with your token.\nfunc ExampleFileService_CreateVolume() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateVolume(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateVolume: Get CAD file volume.\n// \n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cubic measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n// \n// \n// Parameters\n// \n// \t- `outputUnit`: The valid types of volume units.\n// \t- `srcFormat`: The valid types of source file formats.\n// \t- `body`\n// \n// CreateVolume: Get CAD file volume.\n// We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n// Currently, this endpoint returns the cubic measure units.\n// In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n//\n// Parameters\n//\n// - `outputUnit`: The valid types of volume units.\n// - `srcFormat`: The valid types of source file formats.\n// - `body`\nfunc ExampleFileService_CreateVolume() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.File.CreateVolume(\"\", \"\", []byte(\"some-binary\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateVolume" }, "op": "add", @@ -193,7 +193,7 @@ }, { "value": { - "example": "// Logout: This endpoint removes the session cookie for a user.\n// \n// This is used in logout scenarios.\n// \n// Create a client with your token.\nfunc ExampleHiddenService_Logout() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.Logout(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// Logout: This endpoint removes the session cookie for a user.\n// \n// This is used in logout scenarios.\n// \n// Logout: This endpoint removes the session cookie for a user.\n// This is used in logout scenarios.\nfunc ExampleHiddenService_Logout() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Hidden.Logout(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.Logout" }, "op": "add", @@ -201,7 +201,7 @@ }, { "value": { - "example": "// Cmd: Submit one modeling operation.\n// \n// Response depends on which command was submitted, so unfortunately the OpenAPI schema can't generate the right response type.\n// \n// \n// Parameters\n// \n// \t- `body`: A graphics command submitted to the KittyCAD engine via the Modeling API.\n// \n// Create a client with your token.\nfunc ExampleModelingService_Cmd() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Modeling.Cmd(kittycad.ModelingCmdReq{Cmd: \"\", CmdID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), FileID: \"some-string\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// Cmd: Submit one modeling operation.\n// \n// Response depends on which command was submitted, so unfortunately the OpenAPI schema can't generate the right response type.\n// \n// \n// Parameters\n// \n// \t- `body`: A graphics command submitted to the KittyCAD engine via the Modeling API.\n// \n// Cmd: Submit one modeling operation.\n// Response depends on which command was submitted, so unfortunately the OpenAPI schema can't generate the right response type.\n//\n// Parameters\n//\n// - `body`: A graphics command submitted to the KittyCAD engine via the Modeling API.\nfunc ExampleModelingService_Cmd() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Modeling.Cmd(kittycad.ModelingCmdReq{Cmd: \"\", CmdID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), FileID: \"some-string\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#ModelingService.Cmd" }, "op": "add", @@ -209,7 +209,7 @@ }, { "value": { - "example": "// CmdBatch: Submit many modeling operations.\n// \n// \n// Parameters\n// \n// \t- `body`: A batch set of graphics commands submitted to the KittyCAD engine via the Modeling API.\n// \n// Create a client with your token.\nfunc ExampleModelingService_CmdBatch() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Modeling.CmdBatch(kittycad.ModelingCmdReqBatch{Cmds: map[string]kittycad.ModelingCmdReq{\"example\": kittycad.ModelingCmdReq{Cmd: \"\", CmdID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), FileID: \"some-string\"}}, FileID: \"some-string\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CmdBatch: Submit many modeling operations.\n// \n// \n// Parameters\n// \n// \t- `body`: A batch set of graphics commands submitted to the KittyCAD engine via the Modeling API.\n// \n// CmdBatch: Submit many modeling operations.\n// Parameters\n//\n// - `body`: A batch set of graphics commands submitted to the KittyCAD engine via the Modeling API.\nfunc ExampleModelingService_CmdBatch() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Modeling.CmdBatch(kittycad.ModelingCmdReqBatch{Cmds: map[string]kittycad.ModelingCmdReq{\"example\": kittycad.ModelingCmdReq{Cmd: \"\", CmdID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), FileID: \"some-string\"}}, FileID: \"some-string\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#ModelingService.CmdBatch" }, "op": "add", @@ -217,7 +217,7 @@ }, { "value": { - "example": "// DeviceAuthRequest: Start an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.\n// \n// \n// Parameters\n// \n// \t- `body`: The request parameters for the OAuth 2.0 Device Authorization Grant flow.\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_DeviceAuthRequest() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthRequest(kittycad.DeviceAuthRequestForm{ClientID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\")}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeviceAuthRequest: Start an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.\n// \n// \n// Parameters\n// \n// \t- `body`: The request parameters for the OAuth 2.0 Device Authorization Grant flow.\n// \n// DeviceAuthRequest: Start an OAuth 2.0 Device Authorization Grant.\n// This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.\n//\n// Parameters\n//\n// - `body`: The request parameters for the OAuth 2.0 Device Authorization Grant flow.\nfunc ExampleOauth2Service_DeviceAuthRequest() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthRequest(kittycad.DeviceAuthRequestForm{ClientID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\")}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.DeviceAuthRequest" }, "op": "add", @@ -225,7 +225,7 @@ }, { "value": { - "example": "// DeviceAuthConfirm: Confirm an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.\n// \n// \n// Parameters\n// \n// \t- `body`: The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant.\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_DeviceAuthConfirm() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthConfirm(kittycad.DeviceAuthVerifyParams{UserCode: \"some-string\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeviceAuthConfirm: Confirm an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.\n// \n// \n// Parameters\n// \n// \t- `body`: The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant.\n// \n// DeviceAuthConfirm: Confirm an OAuth 2.0 Device Authorization Grant.\n// This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.\n//\n// Parameters\n//\n// - `body`: The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant.\nfunc ExampleOauth2Service_DeviceAuthConfirm() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthConfirm(kittycad.DeviceAuthVerifyParams{UserCode: \"some-string\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.DeviceAuthConfirm" }, "op": "add", @@ -233,7 +233,7 @@ }, { "value": { - "example": "// DeviceAccessToken: Request a device access token.\n// \n// This endpoint should be polled by the client until the user code is verified and the grant is confirmed.\n// \n// \n// Parameters\n// \n// \t- `body`: The form for a device access token request.\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_DeviceAccessToken() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAccessToken(kittycad.DeviceAccessTokenRequestForm{ClientID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), DeviceCode: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), GrantType: \"\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeviceAccessToken: Request a device access token.\n// \n// This endpoint should be polled by the client until the user code is verified and the grant is confirmed.\n// \n// \n// Parameters\n// \n// \t- `body`: The form for a device access token request.\n// \n// DeviceAccessToken: Request a device access token.\n// This endpoint should be polled by the client until the user code is verified and the grant is confirmed.\n//\n// Parameters\n//\n// - `body`: The form for a device access token request.\nfunc ExampleOauth2Service_DeviceAccessToken() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAccessToken(kittycad.DeviceAccessTokenRequestForm{ClientID: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), DeviceCode: kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"), GrantType: \"\"}); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.DeviceAccessToken" }, "op": "add", @@ -241,7 +241,7 @@ }, { "value": { - "example": "// DeviceAuthVerify: Verify an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.\n// \n// \n// Parameters\n// \n// \t- `userCode`\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_DeviceAuthVerify() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthVerify(\"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeviceAuthVerify: Verify an OAuth 2.0 Device Authorization Grant.\n// \n// This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.\n// \n// \n// Parameters\n// \n// \t- `userCode`\n// \n// DeviceAuthVerify: Verify an OAuth 2.0 Device Authorization Grant.\n// This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.\n//\n// Parameters\n//\n// - `userCode`\nfunc ExampleOauth2Service_DeviceAuthVerify() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.DeviceAuthVerify(\"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.DeviceAuthVerify" }, "op": "add", @@ -249,7 +249,7 @@ }, { "value": { - "example": "// ProviderCallback: Listen for callbacks for the OAuth 2.0 provider.\n// \n// \n// Parameters\n// \n// \t- `provider`: An account provider.\n// \t- `code`\n// \t- `state`\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_ProviderCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.ProviderCallback(\"\", \"some-string\", \"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// ProviderCallback: Listen for callbacks for the OAuth 2.0 provider.\n// \n// \n// Parameters\n// \n// \t- `provider`: An account provider.\n// \t- `code`\n// \t- `state`\n// \n// ProviderCallback: Listen for callbacks for the OAuth 2.0 provider.\n// Parameters\n//\n// - `provider`: An account provider.\n// - `code`\n// - `state`\nfunc ExampleOauth2Service_ProviderCallback() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Oauth2.ProviderCallback(\"\", \"some-string\", \"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.ProviderCallback" }, "op": "add", @@ -257,7 +257,7 @@ }, { "value": { - "example": "// ProviderConsent: Get the consent URL and other information for the OAuth 2.0 provider.\n// \n// \n// Parameters\n// \n// \t- `provider`: An account provider.\n// \t- `callbackUrl`\n// \n// Create a client with your token.\nfunc ExampleOauth2Service_ProviderConsent() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Oauth2.ProviderConsent(\"\", \"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ProviderConsent: Get the consent URL and other information for the OAuth 2.0 provider.\n// \n// \n// Parameters\n// \n// \t- `provider`: An account provider.\n// \t- `callbackUrl`\n// \n// ProviderConsent: Get the consent URL and other information for the OAuth 2.0 provider.\n// Parameters\n//\n// - `provider`: An account provider.\n// - `callbackUrl`\nfunc ExampleOauth2Service_ProviderConsent() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Oauth2.ProviderConsent(\"\", \"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#Oauth2Service.ProviderConsent" }, "op": "add", @@ -265,7 +265,7 @@ }, { "value": { - "example": "// GetOpenaiSchema: Get AI plugin OpenAPI schema.\n// \n// This is the same as the OpenAPI schema, BUT it has some modifications to make it compatible with OpenAI. For example, descriptions must be \u003c 300 chars.\n// \n// Create a client with your token.\nfunc ExampleMetaService_GetOpenaiSchema() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Meta.GetOpenaiSchema(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// GetOpenaiSchema: Get AI plugin OpenAPI schema.\n// \n// This is the same as the OpenAPI schema, BUT it has some modifications to make it compatible with OpenAI. For example, descriptions must be \u003c 300 chars.\n// \n// GetOpenaiSchema: Get AI plugin OpenAPI schema.\n// This is the same as the OpenAPI schema, BUT it has some modifications to make it compatible with OpenAI. For example, descriptions must be \u003c 300 chars.\nfunc ExampleMetaService_GetOpenaiSchema() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Meta.GetOpenaiSchema(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.GetOpenaiSchema" }, "op": "add", @@ -273,7 +273,7 @@ }, { "value": { - "example": "// Ping: Return pong.\n// \n// Create a client with your token.\nfunc ExampleMetaService_Ping() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.Ping()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// Ping: Return pong.\n// \n// Ping: Return pong.\nfunc ExampleMetaService_Ping() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Meta.Ping()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Ping" }, "op": "add", @@ -281,7 +281,7 @@ }, { "value": { - "example": "// GetAngleConversion: Convert angle units.\n// \n// Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of angle formats.\n// \t- `outputUnit`: The valid types of angle formats.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetAngleConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetAngleConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetAngleConversion: Convert angle units.\n// \n// Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of angle formats.\n// \t- `outputUnit`: The valid types of angle formats.\n// \t- `value`\n// \n// GetAngleConversion: Convert angle units.\n// Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of angle formats.\n// - `outputUnit`: The valid types of angle formats.\n// - `value`\nfunc ExampleUnitService_GetAngleConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetAngleConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetAngleConversion" }, "op": "add", @@ -289,7 +289,7 @@ }, { "value": { - "example": "// GetAreaConversion: Convert area units.\n// \n// Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of area units.\n// \t- `outputUnit`: The valid types of area units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetAreaConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetAreaConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetAreaConversion: Convert area units.\n// \n// Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of area units.\n// \t- `outputUnit`: The valid types of area units.\n// \t- `value`\n// \n// GetAreaConversion: Convert area units.\n// Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of area units.\n// - `outputUnit`: The valid types of area units.\n// - `value`\nfunc ExampleUnitService_GetAreaConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetAreaConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetAreaConversion" }, "op": "add", @@ -297,7 +297,7 @@ }, { "value": { - "example": "// GetCurrentConversion: Convert current units.\n// \n// Convert a current unit value to another current unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of current units.\n// \t- `outputUnit`: The valid types of current units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetCurrentConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetCurrentConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetCurrentConversion: Convert current units.\n// \n// Convert a current unit value to another current unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of current units.\n// \t- `outputUnit`: The valid types of current units.\n// \t- `value`\n// \n// GetCurrentConversion: Convert current units.\n// Convert a current unit value to another current unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of current units.\n// - `outputUnit`: The valid types of current units.\n// - `value`\nfunc ExampleUnitService_GetCurrentConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetCurrentConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetCurrentConversion" }, "op": "add", @@ -305,7 +305,7 @@ }, { "value": { - "example": "// GetEnergyConversion: Convert energy units.\n// \n// Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of energy units.\n// \t- `outputUnit`: The valid types of energy units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetEnergyConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetEnergyConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetEnergyConversion: Convert energy units.\n// \n// Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of energy units.\n// \t- `outputUnit`: The valid types of energy units.\n// \t- `value`\n// \n// GetEnergyConversion: Convert energy units.\n// Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of energy units.\n// - `outputUnit`: The valid types of energy units.\n// - `value`\nfunc ExampleUnitService_GetEnergyConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetEnergyConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetEnergyConversion" }, "op": "add", @@ -313,7 +313,7 @@ }, { "value": { - "example": "// GetForceConversion: Convert force units.\n// \n// Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of force units.\n// \t- `outputUnit`: The valid types of force units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetForceConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetForceConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetForceConversion: Convert force units.\n// \n// Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of force units.\n// \t- `outputUnit`: The valid types of force units.\n// \t- `value`\n// \n// GetForceConversion: Convert force units.\n// Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of force units.\n// - `outputUnit`: The valid types of force units.\n// - `value`\nfunc ExampleUnitService_GetForceConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetForceConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetForceConversion" }, "op": "add", @@ -321,7 +321,7 @@ }, { "value": { - "example": "// GetFrequencyConversion: Convert frequency units.\n// \n// Convert a frequency unit value to another frequency unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of frequency units.\n// \t- `outputUnit`: The valid types of frequency units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetFrequencyConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetFrequencyConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetFrequencyConversion: Convert frequency units.\n// \n// Convert a frequency unit value to another frequency unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of frequency units.\n// \t- `outputUnit`: The valid types of frequency units.\n// \t- `value`\n// \n// GetFrequencyConversion: Convert frequency units.\n// Convert a frequency unit value to another frequency unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of frequency units.\n// - `outputUnit`: The valid types of frequency units.\n// - `value`\nfunc ExampleUnitService_GetFrequencyConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetFrequencyConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetFrequencyConversion" }, "op": "add", @@ -329,7 +329,7 @@ }, { "value": { - "example": "// GetLengthConversion: Convert length units.\n// \n// Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of length units.\n// \t- `outputUnit`: The valid types of length units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetLengthConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetLengthConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetLengthConversion: Convert length units.\n// \n// Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of length units.\n// \t- `outputUnit`: The valid types of length units.\n// \t- `value`\n// \n// GetLengthConversion: Convert length units.\n// Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of length units.\n// - `outputUnit`: The valid types of length units.\n// - `value`\nfunc ExampleUnitService_GetLengthConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetLengthConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetLengthConversion" }, "op": "add", @@ -337,7 +337,7 @@ }, { "value": { - "example": "// GetMassConversion: Convert mass units.\n// \n// Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of mass units.\n// \t- `outputUnit`: The valid types of mass units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetMassConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetMassConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetMassConversion: Convert mass units.\n// \n// Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of mass units.\n// \t- `outputUnit`: The valid types of mass units.\n// \t- `value`\n// \n// GetMassConversion: Convert mass units.\n// Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of mass units.\n// - `outputUnit`: The valid types of mass units.\n// - `value`\nfunc ExampleUnitService_GetMassConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetMassConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetMassConversion" }, "op": "add", @@ -345,7 +345,7 @@ }, { "value": { - "example": "// GetPowerConversion: Convert power units.\n// \n// Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of power units.\n// \t- `outputUnit`: The valid types of power units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetPowerConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetPowerConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetPowerConversion: Convert power units.\n// \n// Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of power units.\n// \t- `outputUnit`: The valid types of power units.\n// \t- `value`\n// \n// GetPowerConversion: Convert power units.\n// Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of power units.\n// - `outputUnit`: The valid types of power units.\n// - `value`\nfunc ExampleUnitService_GetPowerConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetPowerConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetPowerConversion" }, "op": "add", @@ -353,7 +353,7 @@ }, { "value": { - "example": "// GetPressureConversion: Convert pressure units.\n// \n// Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of pressure units.\n// \t- `outputUnit`: The valid types of pressure units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetPressureConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetPressureConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetPressureConversion: Convert pressure units.\n// \n// Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of pressure units.\n// \t- `outputUnit`: The valid types of pressure units.\n// \t- `value`\n// \n// GetPressureConversion: Convert pressure units.\n// Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of pressure units.\n// - `outputUnit`: The valid types of pressure units.\n// - `value`\nfunc ExampleUnitService_GetPressureConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetPressureConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetPressureConversion" }, "op": "add", @@ -361,7 +361,7 @@ }, { "value": { - "example": "// GetTemperatureConversion: Convert temperature units.\n// \n// Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of temperature units.\n// \t- `outputUnit`: The valid types of temperature units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetTemperatureConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetTemperatureConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetTemperatureConversion: Convert temperature units.\n// \n// Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of temperature units.\n// \t- `outputUnit`: The valid types of temperature units.\n// \t- `value`\n// \n// GetTemperatureConversion: Convert temperature units.\n// Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of temperature units.\n// - `outputUnit`: The valid types of temperature units.\n// - `value`\nfunc ExampleUnitService_GetTemperatureConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetTemperatureConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetTemperatureConversion" }, "op": "add", @@ -369,7 +369,7 @@ }, { "value": { - "example": "// GetTorqueConversion: Convert torque units.\n// \n// Convert a torque unit value to another torque unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of torque units.\n// \t- `outputUnit`: The valid types of torque units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetTorqueConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetTorqueConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetTorqueConversion: Convert torque units.\n// \n// Convert a torque unit value to another torque unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of torque units.\n// \t- `outputUnit`: The valid types of torque units.\n// \t- `value`\n// \n// GetTorqueConversion: Convert torque units.\n// Convert a torque unit value to another torque unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of torque units.\n// - `outputUnit`: The valid types of torque units.\n// - `value`\nfunc ExampleUnitService_GetTorqueConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetTorqueConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetTorqueConversion" }, "op": "add", @@ -377,7 +377,7 @@ }, { "value": { - "example": "// GetVolumeConversion: Convert volume units.\n// \n// Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of volume units.\n// \t- `outputUnit`: The valid types of volume units.\n// \t- `value`\n// \n// Create a client with your token.\nfunc ExampleUnitService_GetVolumeConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetVolumeConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetVolumeConversion: Convert volume units.\n// \n// Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions.\n// \n// \n// Parameters\n// \n// \t- `inputUnit`: The valid types of volume units.\n// \t- `outputUnit`: The valid types of volume units.\n// \t- `value`\n// \n// GetVolumeConversion: Convert volume units.\n// Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters\n//\n// - `inputUnit`: The valid types of volume units.\n// - `outputUnit`: The valid types of volume units.\n// - `value`\nfunc ExampleUnitService_GetVolumeConversion() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Unit.GetVolumeConversion(\"\", \"\", 123.45)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.GetVolumeConversion" }, "op": "add", @@ -385,7 +385,7 @@ }, { "value": { - "example": "// DeleteSelf: Delete your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database.\n// This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.\n// \n// Create a client with your token.\nfunc ExampleUserService_DeleteSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.User.DeleteSelf(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeleteSelf: Delete your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database.\n// This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.\n// \n// DeleteSelf: Delete your user.\n// This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database.\n// This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.\nfunc ExampleUserService_DeleteSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.User.DeleteSelf(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.DeleteSelf" }, "op": "add", @@ -393,7 +393,7 @@ }, { "value": { - "example": "// GetSelf: Get your user.\n// \n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\n// \n// Create a client with your token.\nfunc ExampleUserService_GetSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetSelf: Get your user.\n// \n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\n// \n// GetSelf: Get your user.\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\nfunc ExampleUserService_GetSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelf" }, "op": "add", @@ -401,7 +401,7 @@ }, { "value": { - "example": "// UpdateSelf: Update your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The user-modifiable parts of a User.\n// \n// Create a client with your token.\nfunc ExampleUserService_UpdateSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.UpdateSelf(kittycad.UpdateUser{Company: \"some-string\", Discord: \"some-string\", FirstName: \"some-string\", Github: \"some-string\", LastName: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// UpdateSelf: Update your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The user-modifiable parts of a User.\n// \n// UpdateSelf: Update your user.\n// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\n//\n// Parameters\n//\n// - `body`: The user-modifiable parts of a User.\nfunc ExampleUserService_UpdateSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.UpdateSelf(kittycad.UpdateUser{Company: \"some-string\", Discord: \"some-string\", FirstName: \"some-string\", Github: \"some-string\", LastName: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.UpdateSelf" }, "op": "add", @@ -409,7 +409,7 @@ }, { "value": { - "example": "// UserList: List API calls for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleAPICallService_UserList() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.UserList(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// UserList: List API calls for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// UserList: List API calls for your user.\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleAPICallService_UserList() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.UserList(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.UserList" }, "op": "add", @@ -417,7 +417,7 @@ }, { "value": { - "example": "// GetForUser: Get an API call for a user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExampleAPICallService_GetForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetForUser(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetForUser: Get an API call for a user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// GetForUser: Get an API call for a user.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleAPICallService_GetForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.GetForUser(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetForUser" }, "op": "add", @@ -425,7 +425,7 @@ }, { "value": { - "example": "// ListForUser: List API tokens for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleAPITokenService_ListForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.ListForUser(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListForUser: List API tokens for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// ListForUser: List API tokens for your user.\n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleAPITokenService_ListForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.ListForUser(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.ListForUser" }, "op": "add", @@ -433,7 +433,7 @@ }, { "value": { - "example": "// CreateForUser: Create a new API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\n// \n// Create a client with your token.\nfunc ExampleAPITokenService_CreateForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.CreateForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateForUser: Create a new API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\n// \n// CreateForUser: Create a new API token for your user.\n// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\nfunc ExampleAPITokenService_CreateForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.CreateForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.CreateForUser" }, "op": "add", @@ -441,7 +441,7 @@ }, { "value": { - "example": "// DeleteForUser: Delete an API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n// This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// Create a client with your token.\nfunc ExampleAPITokenService_DeleteForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.APIToken.DeleteForUser(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\")); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeleteForUser: Delete an API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n// This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// DeleteForUser: Delete an API token for your user.\n// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n// This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.\n//\n// Parameters\n//\n// - `token`\nfunc ExampleAPITokenService_DeleteForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.APIToken.DeleteForUser(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\")); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.DeleteForUser" }, "op": "add", @@ -449,7 +449,7 @@ }, { "value": { - "example": "// GetForUser: Get an API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// Create a client with your token.\nfunc ExampleAPITokenService_GetForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.GetForUser(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetForUser: Get an API token for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// GetForUser: Get an API token for your user.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters\n//\n// - `token`\nfunc ExampleAPITokenService_GetForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APIToken.GetForUser(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.GetForUser" }, "op": "add", @@ -457,7 +457,7 @@ }, { "value": { - "example": "// GetSelfExtended: Get extended information about your user.\n// \n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users-extended/me` endpoint.\n// \n// Create a client with your token.\nfunc ExampleUserService_GetSelfExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSelfExtended()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetSelfExtended: Get extended information about your user.\n// \n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users-extended/me` endpoint.\n// \n// GetSelfExtended: Get extended information about your user.\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users-extended/me` endpoint.\nfunc ExampleUserService_GetSelfExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSelfExtended()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelfExtended" }, "op": "add", @@ -465,7 +465,7 @@ }, { "value": { - "example": "// GetFrontHashSelf: Get your user's front verification hash.\n// \n// This info is sent to front when initialing the front chat, it prevents impersonations using js hacks in the browser\n// \n// Create a client with your token.\nfunc ExampleUserService_GetFrontHashSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetFrontHashSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetFrontHashSelf: Get your user's front verification hash.\n// \n// This info is sent to front when initialing the front chat, it prevents impersonations using js hacks in the browser\n// \n// GetFrontHashSelf: Get your user's front verification hash.\n// This info is sent to front when initialing the front chat, it prevents impersonations using js hacks in the browser\nfunc ExampleUserService_GetFrontHashSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetFrontHashSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetFrontHashSelf" }, "op": "add", @@ -473,7 +473,7 @@ }, { "value": { - "example": "// GetOnboardingSelf: Get your user's onboarding status.\n// \n// Checks key part of their api usage to determine their onboarding progress\n// \n// Create a client with your token.\nfunc ExampleUserService_GetOnboardingSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetOnboardingSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetOnboardingSelf: Get your user's onboarding status.\n// \n// Checks key part of their api usage to determine their onboarding progress\n// \n// GetOnboardingSelf: Get your user's onboarding status.\n// Checks key part of their api usage to determine their onboarding progress\nfunc ExampleUserService_GetOnboardingSelf() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetOnboardingSelf()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetOnboardingSelf" }, "op": "add", @@ -481,7 +481,7 @@ }, { "value": { - "example": "// DeleteInformationForUser: Delete payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_DeleteInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.DeleteInformationForUser(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeleteInformationForUser: Delete payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\n// \n// DeleteInformationForUser: Delete payment info for your user.\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\nfunc ExamplePaymentService_DeleteInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.DeleteInformationForUser(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteInformationForUser" }, "op": "add", @@ -489,7 +489,7 @@ }, { "value": { - "example": "// GetInformationForUser: Get payment info about your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_GetInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.GetInformationForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetInformationForUser: Get payment info about your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\n// \n// GetInformationForUser: Get payment info about your user.\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\nfunc ExamplePaymentService_GetInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.GetInformationForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.GetInformationForUser" }, "op": "add", @@ -497,7 +497,7 @@ }, { "value": { - "example": "// CreateInformationForUser: Create payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The billing information for payments.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_CreateInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.CreateInformationForUser(kittycad.BillingInfo{Address: kittycad.NewAddress{City: \"some-string\", Country: \"\", State: \"some-string\", Street1: \"some-string\", Street2: \"some-string\", UserID: \"some-string\", Zip: \"some-string\"}, Name: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateInformationForUser: Create payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The billing information for payments.\n// \n// CreateInformationForUser: Create payment info for your user.\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\n//\n// Parameters\n//\n// - `body`: The billing information for payments.\nfunc ExamplePaymentService_CreateInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.CreateInformationForUser(kittycad.BillingInfo{Address: kittycad.NewAddress{City: \"some-string\", Country: \"\", State: \"some-string\", Street1: \"some-string\", Street2: \"some-string\", UserID: \"some-string\", Zip: \"some-string\"}, Name: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateInformationForUser" }, "op": "add", @@ -505,7 +505,7 @@ }, { "value": { - "example": "// UpdateInformationForUser: Update payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The billing information for payments.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_UpdateInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.UpdateInformationForUser(kittycad.BillingInfo{Address: kittycad.NewAddress{City: \"some-string\", Country: \"\", State: \"some-string\", Street1: \"some-string\", Street2: \"some-string\", UserID: \"some-string\", Zip: \"some-string\"}, Name: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// UpdateInformationForUser: Update payment info for your user.\n// \n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `body`: The billing information for payments.\n// \n// UpdateInformationForUser: Update payment info for your user.\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\n//\n// Parameters\n//\n// - `body`: The billing information for payments.\nfunc ExamplePaymentService_UpdateInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.UpdateInformationForUser(kittycad.BillingInfo{Address: kittycad.NewAddress{City: \"some-string\", Country: \"\", State: \"some-string\", Street1: \"some-string\", Street2: \"some-string\", UserID: \"some-string\", Zip: \"some-string\"}, Name: \"some-string\", Phone: \"+1-555-555-555\"})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.UpdateInformationForUser" }, "op": "add", @@ -513,7 +513,7 @@ }, { "value": { - "example": "// GetBalanceForUser: Get balance for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_GetBalanceForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.GetBalanceForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetBalanceForUser: Get balance for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user.\n// \n// GetBalanceForUser: Get balance for your user.\n// This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user.\nfunc ExamplePaymentService_GetBalanceForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.GetBalanceForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.GetBalanceForUser" }, "op": "add", @@ -521,7 +521,7 @@ }, { "value": { - "example": "// CreateIntentForUser: Create a payment intent for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_CreateIntentForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.CreateIntentForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// CreateIntentForUser: Create a payment intent for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\n// \n// CreateIntentForUser: Create a payment intent for your user.\n// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\nfunc ExamplePaymentService_CreateIntentForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.CreateIntentForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateIntentForUser" }, "op": "add", @@ -529,7 +529,7 @@ }, { "value": { - "example": "// ListInvoicesForUser: List invoices for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_ListInvoicesForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.ListInvoicesForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListInvoicesForUser: List invoices for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\n// \n// ListInvoicesForUser: List invoices for your user.\n// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\nfunc ExamplePaymentService_ListInvoicesForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.ListInvoicesForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListInvoicesForUser" }, "op": "add", @@ -537,7 +537,7 @@ }, { "value": { - "example": "// ListMethodsForUser: List payment methods for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_ListMethodsForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.ListMethodsForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListMethodsForUser: List payment methods for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\n// \n// ListMethodsForUser: List payment methods for your user.\n// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\nfunc ExamplePaymentService_ListMethodsForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.Payment.ListMethodsForUser()\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListMethodsForUser" }, "op": "add", @@ -545,7 +545,7 @@ }, { "value": { - "example": "// DeleteMethodForUser: Delete a payment method for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExamplePaymentService_DeleteMethodForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.DeleteMethodForUser(\"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// DeleteMethodForUser: Delete a payment method for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// DeleteMethodForUser: Delete a payment method for your user.\n// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n//\n// Parameters\n//\n// - `id`\nfunc ExamplePaymentService_DeleteMethodForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.DeleteMethodForUser(\"some-string\"); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteMethodForUser" }, "op": "add", @@ -553,7 +553,7 @@ }, { "value": { - "example": "// ValidateCustomerTaxInformationForUser: Validate a customer's information is correct and valid for automatic tax.\n// \n// This endpoint requires authentication by any KittyCAD user. It will return an error if the customer's information is not valid for automatic tax. Otherwise, it will return an empty successful response.\n// \n// Create a client with your token.\nfunc ExamplePaymentService_ValidateCustomerTaxInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.ValidateCustomerTaxInformationForUser(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", + "example": "// ValidateCustomerTaxInformationForUser: Validate a customer's information is correct and valid for automatic tax.\n// \n// This endpoint requires authentication by any KittyCAD user. It will return an error if the customer's information is not valid for automatic tax. Otherwise, it will return an empty successful response.\n// \n// ValidateCustomerTaxInformationForUser: Validate a customer's information is correct and valid for automatic tax.\n// This endpoint requires authentication by any KittyCAD user. It will return an error if the customer's information is not valid for automatic tax. Otherwise, it will return an empty successful response.\nfunc ExamplePaymentService_ValidateCustomerTaxInformationForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tif err := client.Payment.ValidateCustomerTaxInformationForUser(); err != nil {\n\t\tpanic(err)\n\t}\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ValidateCustomerTaxInformationForUser" }, "op": "add", @@ -561,7 +561,7 @@ }, { "value": { - "example": "// GetSessionFor: Get a session for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// Create a client with your token.\nfunc ExampleUserService_GetSessionFor() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSessionFor(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetSessionFor: Get a session for your user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n// \n// \n// Parameters\n// \n// \t- `token`\n// \n// GetSessionFor: Get a session for your user.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters\n//\n// - `token`\nfunc ExampleUserService_GetSessionFor() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetSessionFor(kittycad.ParseUUID(\"6ba7b810-9dad-11d1-80b4-00c04fd430c8\"))\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSessionFor" }, "op": "add", @@ -569,7 +569,7 @@ }, { "value": { - "example": "// List: List users.\n// \n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleUserService_List() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.List(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// List: List users.\n// \n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// List: List users.\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleUserService_List() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.List(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.List" }, "op": "add", @@ -577,7 +577,7 @@ }, { "value": { - "example": "// ListExtended: List users with extended information.\n// \n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleUserService_ListExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.ListExtended(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListExtended: List users with extended information.\n// \n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n// \n// \n// Parameters\n// \n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// ListExtended: List users with extended information.\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// Parameters\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleUserService_ListExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.ListExtended(123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.ListExtended" }, "op": "add", @@ -585,7 +585,7 @@ }, { "value": { - "example": "// GetExtended: Get extended information about a user.\n// \n// To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExampleUserService_GetExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetExtended(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// GetExtended: Get extended information about a user.\n// \n// To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// GetExtended: Get extended information about a user.\n// To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleUserService_GetExtended() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.GetExtended(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetExtended" }, "op": "add", @@ -593,7 +593,7 @@ }, { "value": { - "example": "// Get: Get a user.\n// \n// To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Create a client with your token.\nfunc ExampleUserService_Get() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.Get(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// Get: Get a user.\n// \n// To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \n// Get: Get a user.\n// To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n// Alternatively, to get information about the authenticated user, use `/user` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters\n//\n// - `id`\nfunc ExampleUserService_Get() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.User.Get(\"some-string\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.Get" }, "op": "add", @@ -601,7 +601,7 @@ }, { "value": { - "example": "// ListForUser: List API calls for a user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// Create a client with your token.\nfunc ExampleAPICallService_ListForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.ListForUser(\"some-string\", 123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", + "example": "// ListForUser: List API calls for a user.\n// \n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n// \n// \n// Parameters\n// \n// \t- `id`\n// \t- `limit`\n// \t- `pageToken`\n// \t- `sortBy`: Supported set of sort modes for scanning by created_at only.\n// \t\t\n// \t\tCurrently, we only support scanning in ascending order.\n// \n// ListForUser: List API calls for a user.\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// Parameters\n//\n// - `id`\n//\n// - `limit`\n//\n// - `pageToken`\n//\n// - `sortBy`: Supported set of sort modes for scanning by created_at only.\n//\n// Currently, we only support scanning in ascending order.\nfunc ExampleAPICallService_ListForUser() {\n\tclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tresult, err := client.APICall.ListForUser(\"some-string\", 123, \"some-string\", \"\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tfmt.Printf(\"%#v\", result)\n\n}\n", "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListForUser" }, "op": "add",