source_code

package
v0.0.0-...-abe38a1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 3, 2024 License: MIT Imports: 23 Imported by: 0

README

Go API client for source_code

Endpoints for interacting with files in the CMS Developer File System. These files include HTML templates, CSS, JS, modules, and other assets which are used to create CMS content.

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: v3
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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 source_code "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(), source_code.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(), source_code.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(), source_code.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), source_code.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class Method HTTP request Description
ContentApi ContentArchive Delete /cms/v3/source-code/{environment}/content/{path} Delete a file
ContentApi ContentCreate Post /cms/v3/source-code/{environment}/content/{path} Create a file
ContentApi GetCmsV3SourceCodeEnvironmentContentPathDownload Get /cms/v3/source-code/{environment}/content/{path} Download a file
ContentApi PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdate Put /cms/v3/source-code/{environment}/content/{path} Create or update a file
ExtractApi ExtractByPath Post /cms/v3/source-code/extract/{path} Extracts a zip file
MetadataApi MetadataGet Get /cms/v3/source-code/{environment}/metadata/{path} Get the metadata for a file
SourceCodeExtractApi ExtractAsync Post /cms/v3/source-code/extract/async
SourceCodeExtractApi ExtractGetAsyncStatus Get /cms/v3/source-code/extract/async/tasks/{taskId}/status
ValidationApi Validate Post /cms/v3/source-code/{environment}/validate/{path} Validate the contents of a file

Documentation For Models

Documentation For Authorization

oauth2_legacy

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)
private_apps_legacy
  • Type: API key
  • API key parameter name: private-app-legacy
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy and passed in as the auth context for each request.

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	ContentApi *ContentApiService

	ExtractApi *ExtractApiService

	MetadataApi *MetadataApiService

	SourceCodeExtractApi *SourceCodeExtractApiService

	ValidationApi *ValidationApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the CMS Source Code API vv3 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ActionResponse 

type ActionResponse struct {
	CompletedAt time.Time          `json:"completedAt"`
	RequestedAt *time.Time         `json:"requestedAt,omitempty"`
	StartedAt   time.Time          `json:"startedAt"`
	Links       *map[string]string `json:"links,omitempty"`
	Status      string             `json:"status"`
}

ActionResponse struct for ActionResponse

func NewActionResponse 

func NewActionResponse(completedAt time.Time, startedAt time.Time, status string) *ActionResponse

NewActionResponse instantiates a new ActionResponse 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

func NewActionResponseWithDefaults 

func NewActionResponseWithDefaults() *ActionResponse

NewActionResponseWithDefaults instantiates a new ActionResponse 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

func (*ActionResponse) GetCompletedAt 

func (o *ActionResponse) GetCompletedAt() time.Time

GetCompletedAt returns the CompletedAt field value

func (*ActionResponse) GetCompletedAtOk 

func (o *ActionResponse) GetCompletedAtOk() (*time.Time, bool)

GetCompletedAtOk returns a tuple with the CompletedAt field value and a boolean to check if the value has been set. 

func (o *ActionResponse) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*ActionResponse) GetLinksOk 

func (o *ActionResponse) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ActionResponse) GetRequestedAt 

func (o *ActionResponse) GetRequestedAt() time.Time

GetRequestedAt returns the RequestedAt field value if set, zero value otherwise.

func (*ActionResponse) GetRequestedAtOk 

func (o *ActionResponse) GetRequestedAtOk() (*time.Time, bool)

GetRequestedAtOk returns a tuple with the RequestedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ActionResponse) GetStartedAt 

func (o *ActionResponse) GetStartedAt() time.Time

GetStartedAt returns the StartedAt field value

func (*ActionResponse) GetStartedAtOk 

func (o *ActionResponse) GetStartedAtOk() (*time.Time, bool)

GetStartedAtOk returns a tuple with the StartedAt field value and a boolean to check if the value has been set.

func (*ActionResponse) GetStatus 

func (o *ActionResponse) GetStatus() string

GetStatus returns the Status field value

func (*ActionResponse) GetStatusOk 

func (o *ActionResponse) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set. 

func (o *ActionResponse) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*ActionResponse) HasRequestedAt 

func (o *ActionResponse) HasRequestedAt() bool

HasRequestedAt returns a boolean if a field has been set.

func (ActionResponse) MarshalJSON 

func (o ActionResponse) MarshalJSON() ([]byte, error)

func (*ActionResponse) SetCompletedAt 

func (o *ActionResponse) SetCompletedAt(v time.Time)

SetCompletedAt sets field value 

func (o *ActionResponse) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*ActionResponse) SetRequestedAt 

func (o *ActionResponse) SetRequestedAt(v time.Time)

SetRequestedAt gets a reference to the given time.Time and assigns it to the RequestedAt field.

func (*ActionResponse) SetStartedAt 

func (o *ActionResponse) SetStartedAt(v time.Time)

SetStartedAt sets field value

func (*ActionResponse) SetStatus 

func (o *ActionResponse) SetStatus(v string)

SetStatus sets field value

type ApiContentArchiveRequest 

type ApiContentArchiveRequest struct {
	ApiService *ContentApiService
	// contains filtered or unexported fields
}

func (ApiContentArchiveRequest) Execute 

func (r ApiContentArchiveRequest) Execute() (*http.Response, error)

type ApiContentCreateRequest 

type ApiContentCreateRequest struct {
	ApiService *ContentApiService
	// contains filtered or unexported fields
}

func (ApiContentCreateRequest) Execute 

func (r ApiContentCreateRequest) Execute() (*AssetFileMetadata, *http.Response, error)

func (ApiContentCreateRequest) File 

func (r ApiContentCreateRequest) File(file *os.File) ApiContentCreateRequest

The file to upload.

type ApiExtractAsyncRequest 

type ApiExtractAsyncRequest struct {
	ApiService *SourceCodeExtractApiService
	// contains filtered or unexported fields
}

func (ApiExtractAsyncRequest) Execute 

func (r ApiExtractAsyncRequest) Execute() (*TaskLocator, *http.Response, error)

func (ApiExtractAsyncRequest) FileExtractRequest 

func (r ApiExtractAsyncRequest) FileExtractRequest(fileExtractRequest FileExtractRequest) ApiExtractAsyncRequest

type ApiExtractByPathRequest 

type ApiExtractByPathRequest struct {
	ApiService *ExtractApiService
	// contains filtered or unexported fields
}

func (ApiExtractByPathRequest) Execute 

func (r ApiExtractByPathRequest) Execute() (*http.Response, error)

type ApiExtractGetAsyncStatusRequest 

type ApiExtractGetAsyncStatusRequest struct {
	ApiService *SourceCodeExtractApiService
	// contains filtered or unexported fields
}

func (ApiExtractGetAsyncStatusRequest) Execute 

func (r ApiExtractGetAsyncStatusRequest) Execute() (*ActionResponse, *http.Response, error)

type ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest 

type ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest struct {
	ApiService *ContentApiService
	// contains filtered or unexported fields
}

func (ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest) Execute 

func (r ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest) Execute() (*Error, *http.Response, error)

type ApiMetadataGetRequest 

type ApiMetadataGetRequest struct {
	ApiService *MetadataApiService
	// contains filtered or unexported fields
}

func (ApiMetadataGetRequest) Execute 

func (r ApiMetadataGetRequest) Execute() (*AssetFileMetadata, *http.Response, error)

func (ApiMetadataGetRequest) Properties 

func (r ApiMetadataGetRequest) Properties(properties string) ApiMetadataGetRequest

type ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest 

type ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest struct {
	ApiService *ContentApiService
	// contains filtered or unexported fields
}

func (ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest) Execute 

func (r ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest) Execute() (*AssetFileMetadata, *http.Response, error)

func (ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest) File 

func (r ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest) File(file *os.File) ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest

The file to upload.

type ApiValidateRequest 

type ApiValidateRequest struct {
	ApiService *ValidationApiService
	// contains filtered or unexported fields
}

func (ApiValidateRequest) Execute 

func (r ApiValidateRequest) Execute() (*Error, *http.Response, error)

func (ApiValidateRequest) File 

func (r ApiValidateRequest) File(file *os.File) ApiValidateRequest

The file to validate.

type AssetFileMetadata 

type AssetFileMetadata struct {
	// Timestamp of when the object was first created.
	CreatedAt int32 `json:"createdAt"`
	// Timestamp of when the object was archived (deleted).
	ArchivedAt *int64 `json:"archivedAt,omitempty"`
	// Determines whether or not this path points to a folder.
	Folder bool `json:"folder"`
	// If the object is a folder, contains the filenames of the files within the folder.
	Children []string `json:"children,omitempty"`
	// The name of the file.
	Name string `json:"name"`
	// The path of the file in the CMS Developer File System.
	Id   string  `json:"id"`
	Hash *string `json:"hash,omitempty"`
	// Timestamp of when the object was last updated.
	UpdatedAt int32 `json:"updatedAt"`
}

AssetFileMetadata The object metadata of a file.

func NewAssetFileMetadata 

func NewAssetFileMetadata(createdAt int32, folder bool, name string, id string, updatedAt int32) *AssetFileMetadata

NewAssetFileMetadata instantiates a new AssetFileMetadata 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

func NewAssetFileMetadataWithDefaults 

func NewAssetFileMetadataWithDefaults() *AssetFileMetadata

NewAssetFileMetadataWithDefaults instantiates a new AssetFileMetadata 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

func (*AssetFileMetadata) GetArchivedAt 

func (o *AssetFileMetadata) GetArchivedAt() int64

GetArchivedAt returns the ArchivedAt field value if set, zero value otherwise.

func (*AssetFileMetadata) GetArchivedAtOk 

func (o *AssetFileMetadata) GetArchivedAtOk() (*int64, bool)

GetArchivedAtOk returns a tuple with the ArchivedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetChildren 

func (o *AssetFileMetadata) GetChildren() []string

GetChildren returns the Children field value if set, zero value otherwise.

func (*AssetFileMetadata) GetChildrenOk 

func (o *AssetFileMetadata) GetChildrenOk() ([]string, bool)

GetChildrenOk returns a tuple with the Children field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetCreatedAt 

func (o *AssetFileMetadata) GetCreatedAt() int32

GetCreatedAt returns the CreatedAt field value

func (*AssetFileMetadata) GetCreatedAtOk 

func (o *AssetFileMetadata) GetCreatedAtOk() (*int32, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetFolder 

func (o *AssetFileMetadata) GetFolder() bool

GetFolder returns the Folder field value

func (*AssetFileMetadata) GetFolderOk 

func (o *AssetFileMetadata) GetFolderOk() (*bool, bool)

GetFolderOk returns a tuple with the Folder field value and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetHash 

func (o *AssetFileMetadata) GetHash() string

GetHash returns the Hash field value if set, zero value otherwise.

func (*AssetFileMetadata) GetHashOk 

func (o *AssetFileMetadata) GetHashOk() (*string, bool)

GetHashOk returns a tuple with the Hash field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetId 

func (o *AssetFileMetadata) GetId() string

GetId returns the Id field value

func (*AssetFileMetadata) GetIdOk 

func (o *AssetFileMetadata) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetName 

func (o *AssetFileMetadata) GetName() string

GetName returns the Name field value

func (*AssetFileMetadata) GetNameOk 

func (o *AssetFileMetadata) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*AssetFileMetadata) GetUpdatedAt 

func (o *AssetFileMetadata) GetUpdatedAt() int32

GetUpdatedAt returns the UpdatedAt field value

func (*AssetFileMetadata) GetUpdatedAtOk 

func (o *AssetFileMetadata) GetUpdatedAtOk() (*int32, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field value and a boolean to check if the value has been set.

func (*AssetFileMetadata) HasArchivedAt 

func (o *AssetFileMetadata) HasArchivedAt() bool

HasArchivedAt returns a boolean if a field has been set.

func (*AssetFileMetadata) HasChildren 

func (o *AssetFileMetadata) HasChildren() bool

HasChildren returns a boolean if a field has been set.

func (*AssetFileMetadata) HasHash 

func (o *AssetFileMetadata) HasHash() bool

HasHash returns a boolean if a field has been set.

func (AssetFileMetadata) MarshalJSON 

func (o AssetFileMetadata) MarshalJSON() ([]byte, error)

func (*AssetFileMetadata) SetArchivedAt 

func (o *AssetFileMetadata) SetArchivedAt(v int64)

SetArchivedAt gets a reference to the given int64 and assigns it to the ArchivedAt field.

func (*AssetFileMetadata) SetChildren 

func (o *AssetFileMetadata) SetChildren(v []string)

SetChildren gets a reference to the given []string and assigns it to the Children field.

func (*AssetFileMetadata) SetCreatedAt 

func (o *AssetFileMetadata) SetCreatedAt(v int32)

SetCreatedAt sets field value

func (*AssetFileMetadata) SetFolder 

func (o *AssetFileMetadata) SetFolder(v bool)

SetFolder sets field value

func (*AssetFileMetadata) SetHash 

func (o *AssetFileMetadata) SetHash(v string)

SetHash gets a reference to the given string and assigns it to the Hash field.

func (*AssetFileMetadata) SetId 

func (o *AssetFileMetadata) SetId(v string)

SetId sets field value

func (*AssetFileMetadata) SetName 

func (o *AssetFileMetadata) SetName(v string)

SetName sets field value

func (*AssetFileMetadata) SetUpdatedAt 

func (o *AssetFileMetadata) SetUpdatedAt(v int32)

SetUpdatedAt sets field value

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type ContentApiService 

type ContentApiService service

ContentApiService ContentApi service

func (*ContentApiService) ContentArchive 

func (a *ContentApiService) ContentArchive(ctx context.Context, environment string, path string) ApiContentArchiveRequest

ContentArchive Delete a file

Deletes the file at the specified path in the specified environment. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environment The environment of the file (\"draft\" or \"published\").
@param path The file system location of the file.
@return ApiContentArchiveRequest

func (*ContentApiService) ContentArchiveExecute 

func (a *ContentApiService) ContentArchiveExecute(r ApiContentArchiveRequest) (*http.Response, error)

Execute executes the request

func (*ContentApiService) ContentCreate 

func (a *ContentApiService) ContentCreate(ctx context.Context, environment string, path string) ApiContentCreateRequest

ContentCreate Create a file

Creates a file at the specified path in the specified environment. Accepts multipart/form-data content type. Throws an error if a file already exists at the specified path. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environment The environment of the file (\"draft\" or \"published\").
@param path The file system location of the file.
@return ApiContentCreateRequest

Deprecated

func (*ContentApiService) ContentCreateExecute 

func (a *ContentApiService) ContentCreateExecute(r ApiContentCreateRequest) (*AssetFileMetadata, *http.Response, error)

Execute executes the request 

@return AssetFileMetadata

Deprecated

func (*ContentApiService) GetCmsV3SourceCodeEnvironmentContentPathDownload 

func (a *ContentApiService) GetCmsV3SourceCodeEnvironmentContentPathDownload(ctx context.Context, environment string, path string) ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest

GetCmsV3SourceCodeEnvironmentContentPathDownload Download a file

Downloads the byte contents of the file at the specified path in the specified environment. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environment The environment of the file (\"draft\" or \"published\").
@param path The file system location of the file.
@return ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest

func (*ContentApiService) GetCmsV3SourceCodeEnvironmentContentPathDownloadExecute 

func (a *ContentApiService) GetCmsV3SourceCodeEnvironmentContentPathDownloadExecute(r ApiGetCmsV3SourceCodeEnvironmentContentPathDownloadRequest) (*Error, *http.Response, error)

Execute executes the request 

@return Error

func (*ContentApiService) PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdate 

func (a *ContentApiService) PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdate(ctx context.Context, environment string, path string) ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest

PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdate Create or update a file

Upserts a file at the specified path in the specified environment. Accepts multipart/form-data content type. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environment The environment of the file (\"draft\" or \"published\").
@param path The file system location of the file.
@return ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest

func (*ContentApiService) PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateExecute 

func (a *ContentApiService) PutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateExecute(r ApiPutCmsV3SourceCodeEnvironmentContentPathCreateOrUpdateRequest) (*AssetFileMetadata, *http.Response, error)

Execute executes the request 

@return AssetFileMetadata

type Error 

type Error struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`
	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *map[string]string `json:"links,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The error category
	Category string `json:"category"`
	// further information about the error
	Errors []ErrorDetail `json:"errors,omitempty"`
}

Error struct for Error

func NewError 

func NewError(correlationId string, message string, category string) *Error

NewError instantiates a new Error 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

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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

func (*Error) GetCategory 

func (o *Error) GetCategory() string

GetCategory returns the Category field value

func (*Error) GetCategoryOk 

func (o *Error) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field value and a boolean to check if the value has been set.

func (*Error) GetContext 

func (o *Error) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*Error) GetContextOk 

func (o *Error) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetCorrelationId 

func (o *Error) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value

func (*Error) GetCorrelationIdOk 

func (o *Error) GetCorrelationIdOk() (*string, bool)

GetCorrelationIdOk returns a tuple with the CorrelationId field value and a boolean to check if the value has been set.

func (*Error) GetErrors 

func (o *Error) GetErrors() []ErrorDetail

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Error) GetErrorsOk 

func (o *Error) GetErrorsOk() ([]ErrorDetail, bool)

GetErrorsOk returns a tuple with the Errors field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *Error) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*Error) GetLinksOk 

func (o *Error) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Error) GetSubCategory 

func (o *Error) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*Error) GetSubCategoryOk 

func (o *Error) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasContext 

func (o *Error) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Error) HasErrors 

func (o *Error) HasErrors() bool

HasErrors returns a boolean if a field has been set. 

func (o *Error) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*Error) HasSubCategory 

func (o *Error) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (Error) MarshalJSON 

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetCategory 

func (o *Error) SetCategory(v string)

SetCategory sets field value

func (*Error) SetContext 

func (o *Error) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*Error) SetCorrelationId 

func (o *Error) SetCorrelationId(v string)

SetCorrelationId sets field value

func (*Error) SetErrors 

func (o *Error) SetErrors(v []ErrorDetail)

SetErrors gets a reference to the given []ErrorDetail and assigns it to the Errors field. 

func (o *Error) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetSubCategory 

func (o *Error) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type ErrorDetail 

type ErrorDetail struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
}

ErrorDetail struct for ErrorDetail

func NewErrorDetail 

func NewErrorDetail(message string) *ErrorDetail

NewErrorDetail instantiates a new ErrorDetail 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

func NewErrorDetailWithDefaults 

func NewErrorDetailWithDefaults() *ErrorDetail

NewErrorDetailWithDefaults instantiates a new ErrorDetail 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

func (*ErrorDetail) GetCode 

func (o *ErrorDetail) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*ErrorDetail) GetCodeOk 

func (o *ErrorDetail) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetContext 

func (o *ErrorDetail) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*ErrorDetail) GetContextOk 

func (o *ErrorDetail) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetIn 

func (o *ErrorDetail) GetIn() string

GetIn returns the In field value if set, zero value otherwise.

func (*ErrorDetail) GetInOk 

func (o *ErrorDetail) GetInOk() (*string, bool)

GetInOk returns a tuple with the In field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetMessage 

func (o *ErrorDetail) GetMessage() string

GetMessage returns the Message field value

func (*ErrorDetail) GetMessageOk 

func (o *ErrorDetail) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*ErrorDetail) GetSubCategory 

func (o *ErrorDetail) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*ErrorDetail) GetSubCategoryOk 

func (o *ErrorDetail) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) HasCode 

func (o *ErrorDetail) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorDetail) HasContext 

func (o *ErrorDetail) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*ErrorDetail) HasIn 

func (o *ErrorDetail) HasIn() bool

HasIn returns a boolean if a field has been set.

func (*ErrorDetail) HasSubCategory 

func (o *ErrorDetail) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (ErrorDetail) MarshalJSON 

func (o ErrorDetail) MarshalJSON() ([]byte, error)

func (*ErrorDetail) SetCode 

func (o *ErrorDetail) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*ErrorDetail) SetContext 

func (o *ErrorDetail) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*ErrorDetail) SetIn 

func (o *ErrorDetail) SetIn(v string)

SetIn gets a reference to the given string and assigns it to the In field.

func (*ErrorDetail) SetMessage 

func (o *ErrorDetail) SetMessage(v string)

SetMessage sets field value

func (*ErrorDetail) SetSubCategory 

func (o *ErrorDetail) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type ExtractApiService 

type ExtractApiService service

ExtractApiService ExtractApi service

func (*ExtractApiService) ExtractByPath 

func (a *ExtractApiService) ExtractByPath(ctx context.Context, path string) ApiExtractByPathRequest

ExtractByPath Extracts a zip file

Extracts a zip file in the file system. The zip file will be extracted in-place and not be deleted automatically. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param path The file system location of the zip file.
@return ApiExtractByPathRequest

Deprecated

func (*ExtractApiService) ExtractByPathExecute 

func (a *ExtractApiService) ExtractByPathExecute(r ApiExtractByPathRequest) (*http.Response, error)

Execute executes the request Deprecated

type FileExtractRequest 

type FileExtractRequest struct {
	Path string `json:"path"`
}

FileExtractRequest struct for FileExtractRequest

func NewFileExtractRequest 

func NewFileExtractRequest(path string) *FileExtractRequest

NewFileExtractRequest instantiates a new FileExtractRequest 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

func NewFileExtractRequestWithDefaults 

func NewFileExtractRequestWithDefaults() *FileExtractRequest

NewFileExtractRequestWithDefaults instantiates a new FileExtractRequest 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

func (*FileExtractRequest) GetPath 

func (o *FileExtractRequest) GetPath() string

GetPath returns the Path field value

func (*FileExtractRequest) GetPathOk 

func (o *FileExtractRequest) GetPathOk() (*string, bool)

GetPathOk returns a tuple with the Path field value and a boolean to check if the value has been set.

func (FileExtractRequest) MarshalJSON 

func (o FileExtractRequest) MarshalJSON() ([]byte, error)

func (*FileExtractRequest) SetPath 

func (o *FileExtractRequest) SetPath(v string)

SetPath sets field value

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type MetadataApiService 

type MetadataApiService service

MetadataApiService MetadataApi service

func (*MetadataApiService) MetadataGet 

func (a *MetadataApiService) MetadataGet(ctx context.Context, environment string, path string) ApiMetadataGetRequest

MetadataGet Get the metadata for a file

Gets the metadata object for the file at the specified path in the specified environment. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environment The environment of the file (\"draft\" or \"published\").
@param path The file system location of the file.
@return ApiMetadataGetRequest

func (*MetadataApiService) MetadataGetExecute 

func (a *MetadataApiService) MetadataGetExecute(r ApiMetadataGetRequest) (*AssetFileMetadata, *http.Response, error)

Execute executes the request 

@return AssetFileMetadata

type NullableActionResponse 

type NullableActionResponse struct {
	// contains filtered or unexported fields
}

func NewNullableActionResponse 

func NewNullableActionResponse(val *ActionResponse) *NullableActionResponse

func (NullableActionResponse) Get 

func (v NullableActionResponse) Get() *ActionResponse

func (NullableActionResponse) IsSet 

func (v NullableActionResponse) IsSet() bool

func (NullableActionResponse) MarshalJSON 

func (v NullableActionResponse) MarshalJSON() ([]byte, error)

func (*NullableActionResponse) Set 

func (v *NullableActionResponse) Set(val *ActionResponse)

func (*NullableActionResponse) UnmarshalJSON 

func (v *NullableActionResponse) UnmarshalJSON(src []byte) error

func (*NullableActionResponse) Unset 

func (v *NullableActionResponse) Unset()

type NullableAssetFileMetadata 

type NullableAssetFileMetadata struct {
	// contains filtered or unexported fields
}

func NewNullableAssetFileMetadata 

func NewNullableAssetFileMetadata(val *AssetFileMetadata) *NullableAssetFileMetadata

func (NullableAssetFileMetadata) Get 

func (v NullableAssetFileMetadata) Get() *AssetFileMetadata

func (NullableAssetFileMetadata) IsSet 

func (v NullableAssetFileMetadata) IsSet() bool

func (NullableAssetFileMetadata) MarshalJSON 

func (v NullableAssetFileMetadata) MarshalJSON() ([]byte, error)

func (*NullableAssetFileMetadata) Set 

func (v *NullableAssetFileMetadata) Set(val *AssetFileMetadata)

func (*NullableAssetFileMetadata) UnmarshalJSON 

func (v *NullableAssetFileMetadata) UnmarshalJSON(src []byte) error

func (*NullableAssetFileMetadata) Unset 

func (v *NullableAssetFileMetadata) Unset()

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableError 

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorDetail 

type NullableErrorDetail struct {
	// contains filtered or unexported fields
}

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

func (NullableErrorDetail) IsSet 

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON 

func (v NullableErrorDetail) MarshalJSON() ([]byte, error)

func (*NullableErrorDetail) Set 

func (v *NullableErrorDetail) Set(val *ErrorDetail)

func (*NullableErrorDetail) UnmarshalJSON 

func (v *NullableErrorDetail) UnmarshalJSON(src []byte) error

func (*NullableErrorDetail) Unset 

func (v *NullableErrorDetail) Unset()

type NullableFileExtractRequest 

type NullableFileExtractRequest struct {
	// contains filtered or unexported fields
}

func NewNullableFileExtractRequest 

func NewNullableFileExtractRequest(val *FileExtractRequest) *NullableFileExtractRequest

func (NullableFileExtractRequest) Get 

func (v NullableFileExtractRequest) Get() *FileExtractRequest

func (NullableFileExtractRequest) IsSet 

func (v NullableFileExtractRequest) IsSet() bool

func (NullableFileExtractRequest) MarshalJSON 

func (v NullableFileExtractRequest) MarshalJSON() ([]byte, error)

func (*NullableFileExtractRequest) Set 

func (v *NullableFileExtractRequest) Set(val *FileExtractRequest)

func (*NullableFileExtractRequest) UnmarshalJSON 

func (v *NullableFileExtractRequest) UnmarshalJSON(src []byte) error

func (*NullableFileExtractRequest) Unset 

func (v *NullableFileExtractRequest) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTaskLocator 

type NullableTaskLocator struct {
	// contains filtered or unexported fields
}

func NewNullableTaskLocator 

func NewNullableTaskLocator(val *TaskLocator) *NullableTaskLocator

func (NullableTaskLocator) Get 

func (v NullableTaskLocator) Get() *TaskLocator

func (NullableTaskLocator) IsSet 

func (v NullableTaskLocator) IsSet() bool

func (NullableTaskLocator) MarshalJSON 

func (v NullableTaskLocator) MarshalJSON() ([]byte, error)

func (*NullableTaskLocator) Set 

func (v *NullableTaskLocator) Set(val *TaskLocator)

func (*NullableTaskLocator) UnmarshalJSON 

func (v *NullableTaskLocator) UnmarshalJSON(src []byte) error

func (*NullableTaskLocator) Unset 

func (v *NullableTaskLocator) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SourceCodeExtractApiService 

type SourceCodeExtractApiService service

SourceCodeExtractApiService SourceCodeExtractApi service

func (*SourceCodeExtractApiService) ExtractAsync 

func (a *SourceCodeExtractApiService) ExtractAsync(ctx context.Context) ApiExtractAsyncRequest

ExtractAsync Method for ExtractAsync 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiExtractAsyncRequest

func (*SourceCodeExtractApiService) ExtractAsyncExecute 

func (a *SourceCodeExtractApiService) ExtractAsyncExecute(r ApiExtractAsyncRequest) (*TaskLocator, *http.Response, error)

Execute executes the request 

@return TaskLocator

func (*SourceCodeExtractApiService) ExtractGetAsyncStatus 

func (a *SourceCodeExtractApiService) ExtractGetAsyncStatus(ctx context.Context, taskId int32) ApiExtractGetAsyncStatusRequest

ExtractGetAsyncStatus Method for ExtractGetAsyncStatus 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param taskId
@return ApiExtractGetAsyncStatusRequest

func (*SourceCodeExtractApiService) ExtractGetAsyncStatusExecute 

func (a *SourceCodeExtractApiService) ExtractGetAsyncStatusExecute(r ApiExtractGetAsyncStatusRequest) (*ActionResponse, *http.Response, error)

Execute executes the request 

@return ActionResponse

type TaskLocator 

type TaskLocator struct {
	Links *map[string]string `json:"links,omitempty"`
	Id    string             `json:"id"`
}

TaskLocator struct for TaskLocator

func NewTaskLocator 

func NewTaskLocator(id string) *TaskLocator

NewTaskLocator instantiates a new TaskLocator 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

func NewTaskLocatorWithDefaults 

func NewTaskLocatorWithDefaults() *TaskLocator

NewTaskLocatorWithDefaults instantiates a new TaskLocator 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

func (*TaskLocator) GetId 

func (o *TaskLocator) GetId() string

GetId returns the Id field value

func (*TaskLocator) GetIdOk 

func (o *TaskLocator) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set. 

func (o *TaskLocator) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*TaskLocator) GetLinksOk 

func (o *TaskLocator) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *TaskLocator) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (TaskLocator) MarshalJSON 

func (o TaskLocator) MarshalJSON() ([]byte, error)

func (*TaskLocator) SetId 

func (o *TaskLocator) SetId(v string)

SetId sets field value 

func (o *TaskLocator) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

type ValidationApiService 

type ValidationApiService service

ValidationApiService ValidationApi service

func (*ValidationApiService) Validate 

func (a *ValidationApiService) Validate(ctx context.Context, path string) ApiValidateRequest

Validate Validate the contents of a file

Validates the file contents passed to the endpoint given a specified path and environment. Accepts multipart/form-data content type. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param path The file system location of the file.
@return ApiValidateRequest

func (*ValidationApiService) ValidateExecute 

func (a *ValidationApiService) ValidateExecute(r ApiValidateRequest) (*Error, *http.Response, error)

Execute executes the request 

@return Error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.