Categorygithub.com/yzhaoyu/sdk
modulepackage
0.1.1
Repository: https://github.com/yzhaoyu/sdk.git
Documentation: pkg.go.dev

# README

Go API client for openapi

Tencent docs sdk contains DocAPI, SmartsheetAPI, SheetAPI, DriveAPI and OAuthAPI

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.0.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://git.woa.com/tencentdocs/sdk

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://docs.qq.com

ClassMethodHTTP requestDescription
DocAPIApiDocAPIBatchUpdateDocDataPost /openapi/doc/v3/{fileID}/batchUpdate
DocAPIApiDocAPIGetDocFullTextGet /openapi/doc/v3/{fileID}
DriveAPIApiDriveAPICreateFilePost /openapi/drive/v2/files
OAuthAPIApiOAuthAPIGetTokenGet /oauth/v2/token
OAuthAPIApiOAuthAPIRefreshTokenGet /oauth/v2/userinfo
ResourceAPIApiResourceAPIUploadImagePost /openapi/resources/v2/images
SmartsheetAPIApiSmartsheetAPIEditSmartsheetSubSheetPost /openapi/smartbook/v2/files/{fileID}/sheets
SmartsheetAPIApiSmartsheetAPIGetSmartsheetSubSheetGet /openapi/smartbook/v2/files/{fileID}/sheets
SmartsheetAPIApiSmartsheetAPIHandleSmartsheetResourcePost /openapi/smartbook/v2/files/{fileID}/sheets/{sheetID}

Documentation For Models

Documentation For Authorization

OAuth2AuthCode

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://docs.qq.com/oauth/v2/authorize
  • Scopes:
  • ScopeFileCreatable: 开发者调用相关的OpenAPI需要确保Access-Token拥有对应的scope,其值形如scope.file.creatable

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBatchUpdateDocDataReq instantiates a new BatchUpdateDocDataReq object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchUpdateDocDataReqWithDefaults instantiates a new BatchUpdateDocDataReq object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewDeleteContentRequest instantiates a new DeleteContentRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteContentRequestWithDefaults instantiates a new DeleteContentRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDocAPIResponse1 instantiates a new DocAPIResponse1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDocAPIResponse1WithDefaults instantiates a new DocAPIResponse1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDocAPIResponse2 instantiates a new DocAPIResponse2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDocAPIResponse2WithDefaults instantiates a new DocAPIResponse2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDriveapiDriveAPIResponse1 instantiates a new DriveapiDriveAPIResponse1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDriveapiDriveAPIResponse1WithDefaults instantiates a new DriveapiDriveAPIResponse1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDriveapiFileInfo instantiates a new DriveapiFileInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDriveapiFileInfoWithDefaults instantiates a new DriveapiFileInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDriveapiRelativeFiles instantiates a new DriveapiRelativeFiles object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDriveapiRelativeFilesWithDefaults instantiates a new DriveapiRelativeFiles object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEditSubSheetRequest instantiates a new EditSubSheetRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEditSubSheetRequestWithDefaults instantiates a new EditSubSheetRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEditSubSheetResponse instantiates a new EditSubSheetResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEditSubSheetResponseWithDefaults instantiates a new EditSubSheetResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetDocFullTextRsp instantiates a new GetDocFullTextRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetDocFullTextRspWithDefaults instantiates a new GetDocFullTextRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSubSheetResponse instantiates a new GetSubSheetResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSubSheetResponseWithDefaults instantiates a new GetSubSheetResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetTokenRsp instantiates a new GetTokenRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetTokenRspWithDefaults instantiates a new GetTokenRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetUserInfoRsp instantiates a new GetUserInfoRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetUserInfoRspWithDefaults instantiates a new GetUserInfoRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGoogleProtobufBoolValue instantiates a new GoogleProtobufBoolValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGoogleProtobufBoolValueWithDefaults instantiates a new GoogleProtobufBoolValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGoogleProtobufDoubleValue instantiates a new GoogleProtobufDoubleValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGoogleProtobufDoubleValueWithDefaults instantiates a new GoogleProtobufDoubleValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGoogleProtobufStringValue instantiates a new GoogleProtobufStringValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGoogleProtobufStringValueWithDefaults instantiates a new GoogleProtobufStringValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGoogleProtobufUInt32Value instantiates a new GoogleProtobufUInt32Value object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGoogleProtobufUInt32ValueWithDefaults instantiates a new GoogleProtobufUInt32Value object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertImageRequest instantiates a new InsertImageRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertImageRequestWithDefaults instantiates a new InsertImageRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertNumberingRequest instantiates a new InsertNumberingRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertNumberingRequestWithDefaults instantiates a new InsertNumberingRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertPageBreakRequest instantiates a new InsertPageBreakRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertPageBreakRequestWithDefaults instantiates a new InsertPageBreakRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertTableRequest instantiates a new InsertTableRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertTableRequestWithDefaults instantiates a new InsertTableRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertTextRequest instantiates a new InsertTextRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertTextRequestWithDefaults instantiates a new InsertTextRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInsertWebBlockRequest instantiates a new InsertWebBlockRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInsertWebBlockRequestWithDefaults instantiates a new InsertWebBlockRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocation instantiates a new Location object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationWithDefaults instantiates a new Location object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNode instantiates a new Node object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNodeWithDefaults instantiates a new Node object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOAuthAPIResponse1 instantiates a new OAuthAPIResponse1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOAuthAPIResponse1WithDefaults instantiates a new OAuthAPIResponse1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOAuthAPIResponse2 instantiates a new OAuthAPIResponse2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOAuthAPIResponse2WithDefaults instantiates a new OAuthAPIResponse2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOAuthAPIResponse3 instantiates a new OAuthAPIResponse3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOAuthAPIResponse3WithDefaults instantiates a new OAuthAPIResponse3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewParagraphBorder instantiates a new ParagraphBorder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewParagraphBorderWithDefaults instantiates a new ParagraphBorder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewParagraphStyle instantiates a new ParagraphStyle object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewParagraphStyleWithDefaults instantiates a new ParagraphStyle object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRange instantiates a new Range object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRangeWithDefaults instantiates a new Range object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshTokenRsp instantiates a new RefreshTokenRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshTokenRspWithDefaults instantiates a new RefreshTokenRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewReplaceTextRequest instantiates a new ReplaceTextRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewReplaceTextRequestWithDefaults instantiates a new ReplaceTextRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRequest instantiates a new Request object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRequestWithDefaults instantiates a new Request object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewResourcesAPIResponse1 instantiates a new ResourcesAPIResponse1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewResourcesAPIResponse1WithDefaults instantiates a new ResourcesAPIResponse1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewShading instantiates a new Shading object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewShadingWithDefaults instantiates a new Shading object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSheetData instantiates a new SheetData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSheetDataWithDefaults instantiates a new SheetData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSheetProperties instantiates a new SheetProperties object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSheetPropertiesWithDefaults instantiates a new SheetProperties object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddField instantiates a new SmartsheetAddField object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddFieldsRequest instantiates a new SmartsheetAddFieldsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddFieldsRequestWithDefaults instantiates a new SmartsheetAddFieldsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddFieldsResponse instantiates a new SmartsheetAddFieldsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddFieldsResponseWithDefaults instantiates a new SmartsheetAddFieldsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddFieldWithDefaults instantiates a new SmartsheetAddField object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddRecord instantiates a new SmartsheetAddRecord object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddRecordsRequest instantiates a new SmartsheetAddRecordsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddRecordsRequestWithDefaults instantiates a new SmartsheetAddRecordsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddRecordsResponse instantiates a new SmartsheetAddRecordsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddRecordsResponseWithDefaults instantiates a new SmartsheetAddRecordsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddRecordWithDefaults instantiates a new SmartsheetAddRecord object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddSheetReq instantiates a new SmartsheetAddSheetReq object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddSheetReqWithDefaults instantiates a new SmartsheetAddSheetReq object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddSheetRsp instantiates a new SmartsheetAddSheetRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddSheetRspWithDefaults instantiates a new SmartsheetAddSheetRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddViewRequest instantiates a new SmartsheetAddViewRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddViewRequestWithDefaults instantiates a new SmartsheetAddViewRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAddViewResponse instantiates a new SmartsheetAddViewResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAddViewResponseWithDefaults instantiates a new SmartsheetAddViewResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAPIResponse1 instantiates a new SmartsheetAPIResponse1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAPIResponse1WithDefaults instantiates a new SmartsheetAPIResponse1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAPIResponse2 instantiates a new SmartsheetAPIResponse2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAPIResponse2WithDefaults instantiates a new SmartsheetAPIResponse2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetAPIResponse3 instantiates a new SmartsheetAPIResponse3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetAPIResponse3WithDefaults instantiates a new SmartsheetAPIResponse3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetCheckboxFieldProperty instantiates a new SmartsheetCheckboxFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetCheckboxFieldPropertyWithDefaults instantiates a new SmartsheetCheckboxFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetCommonRecord instantiates a new SmartsheetCommonRecord object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetCommonRecordWithDefaults instantiates a new SmartsheetCommonRecord object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetCreatedTimeFieldProperty instantiates a new SmartsheetCreatedTimeFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetCreatedTimeFieldPropertyWithDefaults instantiates a new SmartsheetCreatedTimeFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetDateTimeFieldProperty instantiates a new SmartsheetDateTimeFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetDateTimeFieldPropertyWithDefaults instantiates a new SmartsheetDateTimeFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetDeleteFieldsRequest instantiates a new SmartsheetDeleteFieldsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetDeleteFieldsRequestWithDefaults instantiates a new SmartsheetDeleteFieldsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetDeleteRecordsRequest instantiates a new SmartsheetDeleteRecordsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetDeleteRecordsRequestWithDefaults instantiates a new SmartsheetDeleteRecordsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetDeleteSheetReq instantiates a new SmartsheetDeleteSheetReq object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetDeleteSheetReqWithDefaults instantiates a new SmartsheetDeleteSheetReq object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetDeleteViewsRequest instantiates a new SmartsheetDeleteViewsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetDeleteViewsRequestWithDefaults instantiates a new SmartsheetDeleteViewsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetField instantiates a new SmartsheetField object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetFieldWithDefaults instantiates a new SmartsheetField object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetFieldsRequest instantiates a new SmartsheetGetFieldsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetFieldsRequestWithDefaults instantiates a new SmartsheetGetFieldsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetFieldsResponse instantiates a new SmartsheetGetFieldsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetFieldsResponseWithDefaults instantiates a new SmartsheetGetFieldsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetRecordsRequest instantiates a new SmartsheetGetRecordsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetRecordsRequestWithDefaults instantiates a new SmartsheetGetRecordsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetRecordsRsp instantiates a new SmartsheetGetRecordsRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetRecordsRspWithDefaults instantiates a new SmartsheetGetRecordsRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetViewsRequest instantiates a new SmartsheetGetViewsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetViewsRequestWithDefaults instantiates a new SmartsheetGetViewsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetGetViewsResponse instantiates a new SmartsheetGetViewsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetGetViewsResponseWithDefaults instantiates a new SmartsheetGetViewsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetModifiedTimeFieldProperty instantiates a new SmartsheetModifiedTimeFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetModifiedTimeFieldPropertyWithDefaults instantiates a new SmartsheetModifiedTimeFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetNumberFieldProperty instantiates a new SmartsheetNumberFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetNumberFieldPropertyWithDefaults instantiates a new SmartsheetNumberFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetOption instantiates a new SmartsheetOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetOptionWithDefaults instantiates a new SmartsheetOption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetProgressFieldProperty instantiates a new SmartsheetProgressFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetProgressFieldPropertyWithDefaults instantiates a new SmartsheetProgressFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetRecord instantiates a new SmartsheetRecord object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetRecordWithDefaults instantiates a new SmartsheetRecord object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetResourceRequest instantiates a new SmartsheetResourceRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetResourceRequestWithDefaults instantiates a new SmartsheetResourceRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetResourceResponse instantiates a new SmartsheetResourceResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetResourceResponseWithDefaults instantiates a new SmartsheetResourceResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetSelectFieldProperty instantiates a new SmartsheetSelectFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetSelectFieldPropertyWithDefaults instantiates a new SmartsheetSelectFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetSingleSelectFieldProperty instantiates a new SmartsheetSingleSelectFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetSingleSelectFieldPropertyWithDefaults instantiates a new SmartsheetSingleSelectFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetSort instantiates a new SmartsheetSort object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetSortWithDefaults instantiates a new SmartsheetSort object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetUpdateFieldsRequest instantiates a new SmartsheetUpdateFieldsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetUpdateFieldsRequestWithDefaults instantiates a new SmartsheetUpdateFieldsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetUpdateFieldsResponse instantiates a new SmartsheetUpdateFieldsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetUpdateFieldsResponseWithDefaults instantiates a new SmartsheetUpdateFieldsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetUpdateRecordsRequest instantiates a new SmartsheetUpdateRecordsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetUpdateRecordsRequestWithDefaults instantiates a new SmartsheetUpdateRecordsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetUpdateRecordsResponse instantiates a new SmartsheetUpdateRecordsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetUpdateRecordsResponseWithDefaults instantiates a new SmartsheetUpdateRecordsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetUrlFieldProperty instantiates a new SmartsheetUrlFieldProperty object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetUrlFieldPropertyWithDefaults instantiates a new SmartsheetUrlFieldProperty object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmartsheetView instantiates a new SmartsheetView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmartsheetViewWithDefaults instantiates a new SmartsheetView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTabStop instantiates a new TabStop object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTabStopWithDefaults instantiates a new TabStop object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUploadImageRsp instantiates a new UploadImageRsp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUploadImageRspWithDefaults instantiates a new UploadImageRsp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Tencent Docs SDK API v0.0.1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
BatchUpdateDocDataReq BatchUpdateDocDataReq 批量更新 Doc 文档请求参数.
Configuration stores the configuration of the API client.
DeleteContentRequest struct for DeleteContentRequest.
DocAPIResponse1 struct for DocAPIResponse1.
DocAPIResponse2 struct for DocAPIResponse2.
DriveapiDriveAPIResponse1 struct for DriveapiDriveAPIResponse1.
DriveapiFileInfo struct for DriveapiFileInfo.
DriveapiRelativeFiles struct for DriveapiRelativeFiles.
EditSubSheetRequest EditSheetRequest 编辑子表请求,创建、删除 Smartsheet 子表.
EditSubSheetResponse EditSheetResponse 编辑子表响应,创建、删除 Smartsheet 子表.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetDocFullTextRsp struct for GetDocFullTextRsp.
GetSubSheetResponse GetSubSheetResponse 查询 Smartsheet 子表信息响应.
GetTokenRsp struct for GetTokenRsp.
GetUserInfoRsp struct for GetUserInfoRsp.
GoogleProtobufBoolValue Wrapper message for `bool`.
GoogleProtobufDoubleValue Wrapper message for `double`.
GoogleProtobufStringValue Wrapper message for `string`.
GoogleProtobufUInt32Value Wrapper message for `uint32`.
InsertImageRequest struct for InsertImageRequest.
InsertNumberingRequest struct for InsertNumberingRequest.
InsertPageBreakRequest struct for InsertPageBreakRequest.
InsertTableRequest struct for InsertTableRequest.
InsertTextRequest struct for InsertTextRequest.
InsertWebBlockRequest struct for InsertWebBlockRequest.
Location struct for Location.
Node struct for Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OAuthAPIResponse1 struct for OAuthAPIResponse1.
OAuthAPIResponse2 struct for OAuthAPIResponse2.
OAuthAPIResponse3 struct for OAuthAPIResponse3.
ParagraphBorder struct for ParagraphBorder.
ParagraphStyle struct for ParagraphStyle.
Range struct for Range.
RefreshTokenRsp struct for RefreshTokenRsp.
ReplaceTextRequest struct for ReplaceTextRequest.
Request struct for Request.
ResourcesAPIResponse1 struct for ResourcesAPIResponse1.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Shading struct for Shading.
SheetData struct for SheetData.
SheetProperties struct for SheetProperties.
SmartsheetAddField struct for SmartsheetAddField.
SmartsheetAddFieldsRequest 新增字段请求.
SmartsheetAddFieldsResponse 新增字段回包.
SmartsheetAddRecord struct for SmartsheetAddRecord.
SmartsheetAddRecordsRequest 在指定表格和子表中创建一到多条新记录请求.
SmartsheetAddRecordsResponse 在指定表格和子表中创建一到多条新记录回包.
SmartsheetAddSheetReq struct for SmartsheetAddSheetReq.
SmartsheetAddSheetRsp struct for SmartsheetAddSheetRsp.
SmartsheetAddViewRequest 新建视图请求,创建一个视图.
SmartsheetAddViewResponse 新建视图回包.
SmartsheetAPIResponse1 struct for SmartsheetAPIResponse1.
SmartsheetAPIResponse2 struct for SmartsheetAPIResponse2.
SmartsheetAPIResponse3 struct for SmartsheetAPIResponse3.
SmartsheetCheckboxFieldProperty struct for SmartsheetCheckboxFieldProperty.
SmartsheetCommonRecord struct for SmartsheetCommonRecord.
SmartsheetCreatedTimeFieldProperty struct for SmartsheetCreatedTimeFieldProperty.
SmartsheetDateTimeFieldProperty struct for SmartsheetDateTimeFieldProperty.
SmartsheetDeleteFieldsRequest 删除字段请求.
SmartsheetDeleteRecordsRequest 删除指定表格和子表中的一到多条记录请求.
SmartsheetDeleteSheetReq struct for SmartsheetDeleteSheetReq.
SmartsheetDeleteViewsRequest 删除指定表格指定子表中的指定视图请求.
SmartsheetField struct for SmartsheetField.
SmartsheetGetFieldsRequest 获取指定表格和子表中的所有字段请求.
SmartsheetGetFieldsResponse 获取指定表格和子表中的所有字段回包.
SmartsheetGetRecordsRequest 获取指定表格和子表下指定视图中的所有记录、指定返回记录里要包含的字段、获取指定筛选条件和指定数量的记录三个接口合一.
SmartsheetGetRecordsRsp 对外的查询记录回包.
SmartsheetGetViewsRequest 获取所有视图请求.
SmartsheetGetViewsResponse 获取指定表格指定子表中的所有视图回包.
SmartsheetModifiedTimeFieldProperty struct for SmartsheetModifiedTimeFieldProperty.
SmartsheetNumberFieldProperty struct for SmartsheetNumberFieldProperty.
SmartsheetOption struct for SmartsheetOption.
SmartsheetProgressFieldProperty struct for SmartsheetProgressFieldProperty.
SmartsheetRecord struct for SmartsheetRecord.
SmartsheetResourceRequest SmartsheetResourceRequest 处理 Smartsheet 视图、记录、字段资源的请求参数.
SmartsheetResourceResponse SmartsheetResourceResponse 处理 Smartsheet 视图、记录、字段资源的响应参数.
SmartsheetSelectFieldProperty struct for SmartsheetSelectFieldProperty.
SmartsheetSingleSelectFieldProperty struct for SmartsheetSingleSelectFieldProperty.
SmartsheetSort struct for SmartsheetSort.
SmartsheetUpdateFieldsRequest 更新字段请求.
SmartsheetUpdateFieldsResponse 更新字段回包.
SmartsheetUpdateRecordsRequest 更新指定表格和子表中的一到多条记录请求.
SmartsheetUpdateRecordsResponse 更新指定表格和子表中的一到多条记录回包.
SmartsheetUrlFieldProperty struct for SmartsheetUrlFieldProperty.
SmartsheetView struct for SmartsheetView.
TabStop struct for TabStop.
UploadImageRsp struct for UploadImageRsp.

# Type aliases

DocAPIApiService DocAPIApi service.
DriveAPIApiService DriveAPIApi service.
OAuthAPIApiService OAuthAPIApi service.
ResourceAPIApiService ResourceAPIApi service.
ServerConfigurations stores multiple ServerConfiguration items.
SmartsheetAPIApiService SmartsheetAPIApi service.