templatefox

package module
v1.6.1 Latest Latest
Warning

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

 Go to latest Published: Feb 15, 2026 License: MIT Imports: 20 Imported by: 0

README

TemplateFox Go SDK

Official Go SDK for TemplateFox - Generate PDFs from HTML templates via API.

Go Reference

Installation

go get github.com/TemplateFoxPDF/gosdk

Quick Start

package main

import (
    "context"
    "fmt"
    "log"

    templatefox "github.com/TemplateFoxPDF/gosdk"
)

func main() {
    // Initialize the client
    config := templatefox.NewConfiguration()
    config.AddDefaultHeader("x-api-key", "your-api-key")

    client := templatefox.NewAPIClient(config)
    ctx := context.Background()

    // Generate a PDF
    request := templatefox.CreatePdfRequest{
        TemplateId: "YOUR_TEMPLATE_ID",
        Data: map[string]interface{}{
            "name":           "John Doe",
            "invoice_number": "INV-001",
            "total_amount":   150.00,
        },
    }

    response, _, err := client.PDFApi.CreatePdf(ctx, request)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("PDF URL: %s\n", *response.Url)
    fmt.Printf("Credits remaining: %d\n", *response.CreditsRemaining)
}

Features

  • Template-based PDF generation - Create templates with dynamic variables, generate PDFs with your data
  • Multiple export options - Get a signed URL (default) or raw binary PDF
  • S3 integration - Upload generated PDFs directly to your own S3-compatible storage
  • Context support - Full context.Context support for cancellation and timeouts

API Methods

PDF Generation
request := templatefox.CreatePdfRequest{
    TemplateId: "TEMPLATE_ID",
    Data: map[string]interface{}{
        "name": "John Doe",
    },
    ExportType: templatefox.PtrString("url"),  // "url" or "binary"
    Expiration: templatefox.PtrInt32(86400),   // URL expiration in seconds
    Filename:   templatefox.PtrString("invoice-001"),
}

response, _, err := client.PDFApi.CreatePdf(ctx, request)
Templates
// List all templates
templates, _, err := client.TemplatesApi.ListTemplates(ctx)
for _, t := range templates.Templates {
    fmt.Printf("%s: %s\n", t.Id, t.Name)
}

// Get template fields
fields, _, err := client.TemplatesApi.GetTemplateFields(ctx, "TEMPLATE_ID")
for _, f := range fields {
    fmt.Printf("%s: %s (required: %t)\n", f.Key, f.Type, f.Required)
}
Account
// Get account info
account, _, err := client.AccountApi.GetAccount(ctx)
fmt.Printf("Credits: %d\n", account.Credits)
fmt.Printf("Email: %s\n", *account.Email)

// List transactions (with optional params)
transactions, _, err := client.AccountApi.ListTransactions(ctx).
    Limit(100).
    Offset(0).
    Execute()
for _, tx := range transactions.Transactions {
    fmt.Printf("%s: %d credits\n", tx.TransactionType, tx.Credits)
}
S3 Integration
// Save S3 configuration
s3Config := templatefox.S3ConfigRequest{
    EndpointUrl:     "https://s3.amazonaws.com",
    AccessKeyId:     "AKIAIOSFODNN7EXAMPLE",
    SecretAccessKey: templatefox.PtrString("your-secret-key"),
    BucketName:      "my-pdf-bucket",
    DefaultPrefix:   templatefox.PtrString("generated/pdfs/"),
}

_, _, err := client.IntegrationsApi.SaveS3Config(ctx, s3Config)

// Test connection
test, _, err := client.IntegrationsApi.TestS3Connection(ctx)
fmt.Printf("Connection: %s\n", test.Message)

Configuration

config := templatefox.NewConfiguration()
config.Servers = templatefox.ServerConfigurations{
    {URL: "https://api.pdftemplateapi.com"},
}
config.AddDefaultHeader("x-api-key", os.Getenv("TEMPLATEFOX_API_KEY"))

client := templatefox.NewAPIClient(config)

Error Handling

response, httpResp, err := client.PDFApi.CreatePdf(ctx, request)

if err != nil {
    if httpResp != nil {
        switch httpResp.StatusCode {
        case 402:
            log.Println("Insufficient credits")
        case 403:
            log.Println("Access denied - check your API key")
        case 404:
            log.Println("Template not found")
        default:
            log.Printf("Error: %v", err)
        }
    } else {
        log.Printf("Error: %v", err)
    }
    return
}

Documentation

Support

License

MIT License - see LICENSE for details.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// 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")
)
View Source 
var AllowedAppRoutersV1PdfAsyncExportTypeEnumValues = []AppRoutersV1PdfAsyncExportType{
	"url",
}

All allowed values of AppRoutersV1PdfAsyncExportType enum

View Source 
var AllowedAppRoutersV1PdfExportTypeEnumValues = []AppRoutersV1PdfExportType{
	"url",
	"binary",
}

All allowed values of AppRoutersV1PdfExportType enum

View Source 
var AllowedJobStatusEnumValues = []JobStatus{
	"pending",
	"processing",
	"completed",
	"failed",
}

All allowed values of JobStatus enum

Functions

func CacheExpires 

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

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

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

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 {
	AccountAPI AccountAPI

	IntegrationsAPI IntegrationsAPI

	PDFAPI PDFAPI

	PDFAsyncAPI PDFAsyncAPI

	TemplatesAPI TemplatesAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the TemplateFox API API v1.6.1 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 AccountAPI 

type AccountAPI interface {

	/*
		GetAccount Get account info

		Get account information including remaining credits.

	**Authentication:** API Key required (`x-api-key` header) or JWT token

	**Usage:** Check credit balance before performing operations.

	**No credits consumed:** This is a read-only endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// GetAccountExecute executes the request
	//  @return AccountInfoResponse
	GetAccountExecute(r AccountAPIGetAccountRequest) (*AccountInfoResponse, *http.Response, error)

	/*
		ListTransactions List transactions

		List transaction history for the authenticated user.

	**Authentication:** API Key required (`x-api-key` header) or JWT token

	**Pagination:** Use `limit` and `offset` query parameters.

	**Transaction types:**
	- `PDFGEN`: PDF generation (consumes credits)
	- `REFUND`: Credit refund (on failed generation)
	- `PURCHASE`: Credit purchase
	- `BONUS`: Bonus credits

	**Credits field:**
	- Positive value = credits consumed
	- Negative value = credits added

	**No credits consumed:** This is a read-only endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// ListTransactionsExecute executes the request
	//  @return TransactionsResponse
	ListTransactionsExecute(r AccountAPIListTransactionsRequest) (*TransactionsResponse, *http.Response, error)
}

type AccountAPIGetAccountRequest 

type AccountAPIGetAccountRequest struct {
	ApiService AccountAPI
	// contains filtered or unexported fields
}

func (AccountAPIGetAccountRequest) Execute 

func (r AccountAPIGetAccountRequest) Execute() (*AccountInfoResponse, *http.Response, error)

type AccountAPIListTransactionsRequest 

type AccountAPIListTransactionsRequest struct {
	ApiService AccountAPI
	// contains filtered or unexported fields
}

func (AccountAPIListTransactionsRequest) Execute 

func (r AccountAPIListTransactionsRequest) Execute() (*TransactionsResponse, *http.Response, error)

func (AccountAPIListTransactionsRequest) Limit 

func (r AccountAPIListTransactionsRequest) Limit(limit int32) AccountAPIListTransactionsRequest

Number of records to return

func (AccountAPIListTransactionsRequest) Offset 

func (r AccountAPIListTransactionsRequest) Offset(offset int32) AccountAPIListTransactionsRequest

Number of records to skip

type AccountAPIService 

type AccountAPIService service

AccountAPIService AccountAPI service

func (*AccountAPIService) GetAccount 

func (a *AccountAPIService) GetAccount(ctx context.Context) AccountAPIGetAccountRequest

GetAccount Get account info

Get account information including remaining credits.

**Authentication:** API Key required (`x-api-key` header) or JWT token

**Usage:** Check credit balance before performing operations.

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*AccountAPIService) GetAccountExecute 

func (a *AccountAPIService) GetAccountExecute(r AccountAPIGetAccountRequest) (*AccountInfoResponse, *http.Response, error)

Execute executes the request 

@return AccountInfoResponse

func (*AccountAPIService) ListTransactions 

func (a *AccountAPIService) ListTransactions(ctx context.Context) AccountAPIListTransactionsRequest

ListTransactions List transactions

List transaction history for the authenticated user.

**Authentication:** API Key required (`x-api-key` header) or JWT token

**Pagination:** Use `limit` and `offset` query parameters.

**Transaction types:** - `PDFGEN`: PDF generation (consumes credits) - `REFUND`: Credit refund (on failed generation) - `PURCHASE`: Credit purchase - `BONUS`: Bonus credits

**Credits field:** - Positive value = credits consumed - Negative value = credits added

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*AccountAPIService) ListTransactionsExecute 

func (a *AccountAPIService) ListTransactionsExecute(r AccountAPIListTransactionsRequest) (*TransactionsResponse, *http.Response, error)

Execute executes the request 

@return TransactionsResponse

type AccountInfoResponse 

type AccountInfoResponse struct {
	// Remaining credits
	Credits int32          `json:"credits"`
	Email   NullableString `json:"email,omitempty"`
}

AccountInfoResponse Response for account info endpoint

func NewAccountInfoResponse 

func NewAccountInfoResponse(credits int32) *AccountInfoResponse

NewAccountInfoResponse instantiates a new AccountInfoResponse 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 NewAccountInfoResponseWithDefaults 

func NewAccountInfoResponseWithDefaults() *AccountInfoResponse

NewAccountInfoResponseWithDefaults instantiates a new AccountInfoResponse 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 (*AccountInfoResponse) GetCredits 

func (o *AccountInfoResponse) GetCredits() int32

GetCredits returns the Credits field value

func (*AccountInfoResponse) GetCreditsOk 

func (o *AccountInfoResponse) GetCreditsOk() (*int32, bool)

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

func (*AccountInfoResponse) GetEmail 

func (o *AccountInfoResponse) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise (both if not set or set to explicit null).

func (*AccountInfoResponse) GetEmailOk 

func (o *AccountInfoResponse) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*AccountInfoResponse) HasEmail 

func (o *AccountInfoResponse) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (AccountInfoResponse) MarshalJSON 

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

func (*AccountInfoResponse) SetCredits 

func (o *AccountInfoResponse) SetCredits(v int32)

SetCredits sets field value

func (*AccountInfoResponse) SetEmail 

func (o *AccountInfoResponse) SetEmail(v string)

SetEmail gets a reference to the given NullableString and assigns it to the Email field.

func (*AccountInfoResponse) SetEmailNil 

func (o *AccountInfoResponse) SetEmailNil()

SetEmailNil sets the value for Email to be an explicit nil

func (AccountInfoResponse) ToMap 

func (o AccountInfoResponse) ToMap() (map[string]interface{}, error)

func (*AccountInfoResponse) UnmarshalJSON 

func (o *AccountInfoResponse) UnmarshalJSON(data []byte) (err error)

func (*AccountInfoResponse) UnsetEmail 

func (o *AccountInfoResponse) UnsetEmail()

UnsetEmail ensures that no value is present for Email, not even an explicit nil

type AppRoutersV1PdfAsyncExportType added in v1.5.0 

type AppRoutersV1PdfAsyncExportType string

AppRoutersV1PdfAsyncExportType PDF export type options for async generation 

const (
	URL AppRoutersV1PdfAsyncExportType = "url"
)

List of app__routers__v1__pdf_async__ExportType

func NewAppRoutersV1PdfAsyncExportTypeFromValue added in v1.5.0 

func NewAppRoutersV1PdfAsyncExportTypeFromValue(v string) (*AppRoutersV1PdfAsyncExportType, error)

NewAppRoutersV1PdfAsyncExportTypeFromValue returns a pointer to a valid AppRoutersV1PdfAsyncExportType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AppRoutersV1PdfAsyncExportType) IsValid added in v1.5.0 

func (v AppRoutersV1PdfAsyncExportType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AppRoutersV1PdfAsyncExportType) Ptr added in v1.5.0 

func (v AppRoutersV1PdfAsyncExportType) Ptr() *AppRoutersV1PdfAsyncExportType

Ptr returns reference to app__routers__v1__pdf_async__ExportType value

func (*AppRoutersV1PdfAsyncExportType) UnmarshalJSON added in v1.5.0 

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

type AppRoutersV1PdfExportType added in v1.5.0 

type AppRoutersV1PdfExportType string

AppRoutersV1PdfExportType PDF export type options 

const (
	URL    AppRoutersV1PdfExportType = "url"
	BINARY AppRoutersV1PdfExportType = "binary"
)

List of app__routers__v1__pdf__ExportType

func NewAppRoutersV1PdfExportTypeFromValue added in v1.5.0 

func NewAppRoutersV1PdfExportTypeFromValue(v string) (*AppRoutersV1PdfExportType, error)

NewAppRoutersV1PdfExportTypeFromValue returns a pointer to a valid AppRoutersV1PdfExportType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AppRoutersV1PdfExportType) IsValid added in v1.5.0 

func (v AppRoutersV1PdfExportType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AppRoutersV1PdfExportType) Ptr added in v1.5.0 

func (v AppRoutersV1PdfExportType) Ptr() *AppRoutersV1PdfExportType

Ptr returns reference to app__routers__v1__pdf__ExportType value

func (*AppRoutersV1PdfExportType) UnmarshalJSON added in v1.5.0 

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

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 CreateAsyncPdfRequest added in v1.5.0 

type CreateAsyncPdfRequest struct {
	// **Required.** Template short ID (12 characters)
	TemplateId string `json:"template_id"`
	// **Required.** Key-value data to render in the template.
	Data map[string]interface{} `json:"data"`
	// Export format. Currently only `url` is supported for async.
	ExportType *AppRoutersV1PdfAsyncExportType `json:"export_type,omitempty"`
	// URL expiration in seconds (60-604800). Default: 86400 (24 hours).
	Expiration *int32         `json:"expiration,omitempty"`
	Filename   NullableString `json:"filename,omitempty" validate:"regexp=^[a-zA-Z0-9_\\\\-\\\\.]+$"`
	// Upload to your configured S3 bucket instead of CDN.
	StoreS3       *bool          `json:"store_s3,omitempty"`
	S3Filepath    NullableString `json:"s3_filepath,omitempty" validate:"regexp=^[a-zA-Z0-9_\\\\-\\\\.\\/]+$"`
	S3Bucket      NullableString `json:"s3_bucket,omitempty" validate:"regexp=^[a-z0-9][a-z0-9.\\\\-]*[a-z0-9]$"`
	WebhookUrl    NullableString `json:"webhook_url,omitempty"`
	WebhookSecret NullableString `json:"webhook_secret,omitempty"`
}

CreateAsyncPdfRequest Request model for async PDF generation

func NewCreateAsyncPdfRequest added in v1.5.0 

func NewCreateAsyncPdfRequest(templateId string, data map[string]interface{}) *CreateAsyncPdfRequest

NewCreateAsyncPdfRequest instantiates a new CreateAsyncPdfRequest 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 NewCreateAsyncPdfRequestWithDefaults added in v1.5.0 

func NewCreateAsyncPdfRequestWithDefaults() *CreateAsyncPdfRequest

NewCreateAsyncPdfRequestWithDefaults instantiates a new CreateAsyncPdfRequest 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 (*CreateAsyncPdfRequest) GetData added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetData() map[string]interface{}

GetData returns the Data field value

func (*CreateAsyncPdfRequest) GetDataOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetDataOk() (map[string]interface{}, bool)

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

func (*CreateAsyncPdfRequest) GetExpiration added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetExpiration() int32

GetExpiration returns the Expiration field value if set, zero value otherwise.

func (*CreateAsyncPdfRequest) GetExpirationOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetExpirationOk() (*int32, bool)

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

func (*CreateAsyncPdfRequest) GetExportType added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetExportType() AppRoutersV1PdfAsyncExportType

GetExportType returns the ExportType field value if set, zero value otherwise.

func (*CreateAsyncPdfRequest) GetExportTypeOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetExportTypeOk() (*AppRoutersV1PdfAsyncExportType, bool)

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

func (*CreateAsyncPdfRequest) GetFilename added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetFilename() string

GetFilename returns the Filename field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreateAsyncPdfRequest) GetFilenameOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetFilenameOk() (*string, bool)

GetFilenameOk returns a tuple with the Filename field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreateAsyncPdfRequest) GetS3Bucket added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetS3Bucket() string

GetS3Bucket returns the S3Bucket field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreateAsyncPdfRequest) GetS3BucketOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetS3BucketOk() (*string, bool)

GetS3BucketOk returns a tuple with the S3Bucket field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreateAsyncPdfRequest) GetS3Filepath added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetS3Filepath() string

GetS3Filepath returns the S3Filepath field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreateAsyncPdfRequest) GetS3FilepathOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetS3FilepathOk() (*string, bool)

GetS3FilepathOk returns a tuple with the S3Filepath field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreateAsyncPdfRequest) GetStoreS3 added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetStoreS3() bool

GetStoreS3 returns the StoreS3 field value if set, zero value otherwise.

func (*CreateAsyncPdfRequest) GetStoreS3Ok added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetStoreS3Ok() (*bool, bool)

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

func (*CreateAsyncPdfRequest) GetTemplateId added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetTemplateId() string

GetTemplateId returns the TemplateId field value

func (*CreateAsyncPdfRequest) GetTemplateIdOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetTemplateIdOk() (*string, bool)

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

func (*CreateAsyncPdfRequest) GetWebhookSecret added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetWebhookSecret() string

GetWebhookSecret returns the WebhookSecret field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreateAsyncPdfRequest) GetWebhookSecretOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetWebhookSecretOk() (*string, bool)

GetWebhookSecretOk returns a tuple with the WebhookSecret field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreateAsyncPdfRequest) GetWebhookUrl added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetWebhookUrl() string

GetWebhookUrl returns the WebhookUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreateAsyncPdfRequest) GetWebhookUrlOk added in v1.5.0 

func (o *CreateAsyncPdfRequest) GetWebhookUrlOk() (*string, bool)

GetWebhookUrlOk returns a tuple with the WebhookUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreateAsyncPdfRequest) HasExpiration added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasExpiration() bool

HasExpiration returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasExportType added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasExportType() bool

HasExportType returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasFilename added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasFilename() bool

HasFilename returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasS3Bucket added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasS3Bucket() bool

HasS3Bucket returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasS3Filepath added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasS3Filepath() bool

HasS3Filepath returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasStoreS3 added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasStoreS3() bool

HasStoreS3 returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasWebhookSecret added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasWebhookSecret() bool

HasWebhookSecret returns a boolean if a field has been set.

func (*CreateAsyncPdfRequest) HasWebhookUrl added in v1.5.0 

func (o *CreateAsyncPdfRequest) HasWebhookUrl() bool

HasWebhookUrl returns a boolean if a field has been set.

func (CreateAsyncPdfRequest) MarshalJSON added in v1.5.0 

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

func (*CreateAsyncPdfRequest) SetData added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetData(v map[string]interface{})

SetData sets field value

func (*CreateAsyncPdfRequest) SetExpiration added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetExpiration(v int32)

SetExpiration gets a reference to the given int32 and assigns it to the Expiration field.

func (*CreateAsyncPdfRequest) SetExportType added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetExportType(v AppRoutersV1PdfAsyncExportType)

SetExportType gets a reference to the given AppRoutersV1PdfAsyncExportType and assigns it to the ExportType field.

func (*CreateAsyncPdfRequest) SetFilename added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetFilename(v string)

SetFilename gets a reference to the given NullableString and assigns it to the Filename field.

func (*CreateAsyncPdfRequest) SetFilenameNil added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetFilenameNil()

SetFilenameNil sets the value for Filename to be an explicit nil

func (*CreateAsyncPdfRequest) SetS3Bucket added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetS3Bucket(v string)

SetS3Bucket gets a reference to the given NullableString and assigns it to the S3Bucket field.

func (*CreateAsyncPdfRequest) SetS3BucketNil added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetS3BucketNil()

SetS3BucketNil sets the value for S3Bucket to be an explicit nil

func (*CreateAsyncPdfRequest) SetS3Filepath added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetS3Filepath(v string)

SetS3Filepath gets a reference to the given NullableString and assigns it to the S3Filepath field.

func (*CreateAsyncPdfRequest) SetS3FilepathNil added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetS3FilepathNil()

SetS3FilepathNil sets the value for S3Filepath to be an explicit nil

func (*CreateAsyncPdfRequest) SetStoreS3 added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetStoreS3(v bool)

SetStoreS3 gets a reference to the given bool and assigns it to the StoreS3 field.

func (*CreateAsyncPdfRequest) SetTemplateId added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetTemplateId(v string)

SetTemplateId sets field value

func (*CreateAsyncPdfRequest) SetWebhookSecret added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetWebhookSecret(v string)

SetWebhookSecret gets a reference to the given NullableString and assigns it to the WebhookSecret field.

func (*CreateAsyncPdfRequest) SetWebhookSecretNil added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetWebhookSecretNil()

SetWebhookSecretNil sets the value for WebhookSecret to be an explicit nil

func (*CreateAsyncPdfRequest) SetWebhookUrl added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetWebhookUrl(v string)

SetWebhookUrl gets a reference to the given NullableString and assigns it to the WebhookUrl field.

func (*CreateAsyncPdfRequest) SetWebhookUrlNil added in v1.5.0 

func (o *CreateAsyncPdfRequest) SetWebhookUrlNil()

SetWebhookUrlNil sets the value for WebhookUrl to be an explicit nil

func (CreateAsyncPdfRequest) ToMap added in v1.5.0 

func (o CreateAsyncPdfRequest) ToMap() (map[string]interface{}, error)

func (*CreateAsyncPdfRequest) UnmarshalJSON added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnmarshalJSON(data []byte) (err error)

func (*CreateAsyncPdfRequest) UnsetFilename added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnsetFilename()

UnsetFilename ensures that no value is present for Filename, not even an explicit nil

func (*CreateAsyncPdfRequest) UnsetS3Bucket added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnsetS3Bucket()

UnsetS3Bucket ensures that no value is present for S3Bucket, not even an explicit nil

func (*CreateAsyncPdfRequest) UnsetS3Filepath added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnsetS3Filepath()

UnsetS3Filepath ensures that no value is present for S3Filepath, not even an explicit nil

func (*CreateAsyncPdfRequest) UnsetWebhookSecret added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnsetWebhookSecret()

UnsetWebhookSecret ensures that no value is present for WebhookSecret, not even an explicit nil

func (*CreateAsyncPdfRequest) UnsetWebhookUrl added in v1.5.0 

func (o *CreateAsyncPdfRequest) UnsetWebhookUrl()

UnsetWebhookUrl ensures that no value is present for WebhookUrl, not even an explicit nil

type CreateAsyncPdfResponse added in v1.5.0 

type CreateAsyncPdfResponse struct {
	// Unique job identifier for status polling
	JobId string `json:"job_id"`
	// Initial job status (always 'pending')
	Status JobStatus `json:"status"`
	// Remaining credits after this request
	CreditsRemaining int32 `json:"credits_remaining"`
}

CreateAsyncPdfResponse Response for async PDF creation

func NewCreateAsyncPdfResponse added in v1.5.0 

func NewCreateAsyncPdfResponse(jobId string, status JobStatus, creditsRemaining int32) *CreateAsyncPdfResponse

NewCreateAsyncPdfResponse instantiates a new CreateAsyncPdfResponse 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 NewCreateAsyncPdfResponseWithDefaults added in v1.5.0 

func NewCreateAsyncPdfResponseWithDefaults() *CreateAsyncPdfResponse

NewCreateAsyncPdfResponseWithDefaults instantiates a new CreateAsyncPdfResponse 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 (*CreateAsyncPdfResponse) GetCreditsRemaining added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetCreditsRemaining() int32

GetCreditsRemaining returns the CreditsRemaining field value

func (*CreateAsyncPdfResponse) GetCreditsRemainingOk added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetCreditsRemainingOk() (*int32, bool)

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

func (*CreateAsyncPdfResponse) GetJobId added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetJobId() string

GetJobId returns the JobId field value

func (*CreateAsyncPdfResponse) GetJobIdOk added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetJobIdOk() (*string, bool)

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

func (*CreateAsyncPdfResponse) GetStatus added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetStatus() JobStatus

GetStatus returns the Status field value

func (*CreateAsyncPdfResponse) GetStatusOk added in v1.5.0 

func (o *CreateAsyncPdfResponse) GetStatusOk() (*JobStatus, bool)

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

func (CreateAsyncPdfResponse) MarshalJSON added in v1.5.0 

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

func (*CreateAsyncPdfResponse) SetCreditsRemaining added in v1.5.0 

func (o *CreateAsyncPdfResponse) SetCreditsRemaining(v int32)

SetCreditsRemaining sets field value

func (*CreateAsyncPdfResponse) SetJobId added in v1.5.0 

func (o *CreateAsyncPdfResponse) SetJobId(v string)

SetJobId sets field value

func (*CreateAsyncPdfResponse) SetStatus added in v1.5.0 

func (o *CreateAsyncPdfResponse) SetStatus(v JobStatus)

SetStatus sets field value

func (CreateAsyncPdfResponse) ToMap added in v1.5.0 

func (o CreateAsyncPdfResponse) ToMap() (map[string]interface{}, error)

func (*CreateAsyncPdfResponse) UnmarshalJSON added in v1.5.0 

func (o *CreateAsyncPdfResponse) UnmarshalJSON(data []byte) (err error)

type CreatePdfRequest 

type CreatePdfRequest struct {
	// **Required.** Template short ID (12 characters)
	TemplateId string `json:"template_id"`
	// **Required.** Key-value data to render in the template. Keys must match template variables.
	Data map[string]interface{} `json:"data"`
	// Export format: `url` uploads to CDN and returns URL, `binary` returns raw PDF bytes
	ExportType *AppRoutersV1PdfExportType `json:"export_type,omitempty"`
	// URL expiration in seconds. Min: 60 (1 min), Max: 604800 (7 days). Only applies to `url` export type.
	Expiration *int32         `json:"expiration,omitempty"`
	Filename   NullableString `json:"filename,omitempty" validate:"regexp=^[a-zA-Z0-9_\\\\-\\\\.]+$"`
	// Upload to your configured S3 bucket instead of CDN
	StoreS3    *bool          `json:"store_s3,omitempty"`
	S3Filepath NullableString `json:"s3_filepath,omitempty" validate:"regexp=^[a-zA-Z0-9_\\\\-\\\\.\\/]+$"`
	S3Bucket   NullableString `json:"s3_bucket,omitempty" validate:"regexp=^[a-z0-9][a-z0-9.\\\\-]*[a-z0-9]$"`
}

CreatePdfRequest Request model for PDF generation

func NewCreatePdfRequest 

func NewCreatePdfRequest(templateId string, data map[string]interface{}) *CreatePdfRequest

NewCreatePdfRequest instantiates a new CreatePdfRequest 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 NewCreatePdfRequestWithDefaults 

func NewCreatePdfRequestWithDefaults() *CreatePdfRequest

NewCreatePdfRequestWithDefaults instantiates a new CreatePdfRequest 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 (*CreatePdfRequest) GetData 

func (o *CreatePdfRequest) GetData() map[string]interface{}

GetData returns the Data field value

func (*CreatePdfRequest) GetDataOk 

func (o *CreatePdfRequest) GetDataOk() (map[string]interface{}, bool)

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

func (*CreatePdfRequest) GetExpiration 

func (o *CreatePdfRequest) GetExpiration() int32

GetExpiration returns the Expiration field value if set, zero value otherwise.

func (*CreatePdfRequest) GetExpirationOk 

func (o *CreatePdfRequest) GetExpirationOk() (*int32, bool)

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

func (*CreatePdfRequest) GetExportType 

func (o *CreatePdfRequest) GetExportType() AppRoutersV1PdfExportType

GetExportType returns the ExportType field value if set, zero value otherwise.

func (*CreatePdfRequest) GetExportTypeOk 

func (o *CreatePdfRequest) GetExportTypeOk() (*AppRoutersV1PdfExportType, bool)

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

func (*CreatePdfRequest) GetFilename 

func (o *CreatePdfRequest) GetFilename() string

GetFilename returns the Filename field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreatePdfRequest) GetFilenameOk 

func (o *CreatePdfRequest) GetFilenameOk() (*string, bool)

GetFilenameOk returns a tuple with the Filename field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreatePdfRequest) GetS3Bucket 

func (o *CreatePdfRequest) GetS3Bucket() string

GetS3Bucket returns the S3Bucket field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreatePdfRequest) GetS3BucketOk 

func (o *CreatePdfRequest) GetS3BucketOk() (*string, bool)

GetS3BucketOk returns a tuple with the S3Bucket field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreatePdfRequest) GetS3Filepath 

func (o *CreatePdfRequest) GetS3Filepath() string

GetS3Filepath returns the S3Filepath field value if set, zero value otherwise (both if not set or set to explicit null).

func (*CreatePdfRequest) GetS3FilepathOk 

func (o *CreatePdfRequest) GetS3FilepathOk() (*string, bool)

GetS3FilepathOk returns a tuple with the S3Filepath field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*CreatePdfRequest) GetStoreS3 

func (o *CreatePdfRequest) GetStoreS3() bool

GetStoreS3 returns the StoreS3 field value if set, zero value otherwise.

func (*CreatePdfRequest) GetStoreS3Ok 

func (o *CreatePdfRequest) GetStoreS3Ok() (*bool, bool)

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

func (*CreatePdfRequest) GetTemplateId 

func (o *CreatePdfRequest) GetTemplateId() string

GetTemplateId returns the TemplateId field value

func (*CreatePdfRequest) GetTemplateIdOk 

func (o *CreatePdfRequest) GetTemplateIdOk() (*string, bool)

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

func (*CreatePdfRequest) HasExpiration 

func (o *CreatePdfRequest) HasExpiration() bool

HasExpiration returns a boolean if a field has been set.

func (*CreatePdfRequest) HasExportType 

func (o *CreatePdfRequest) HasExportType() bool

HasExportType returns a boolean if a field has been set.

func (*CreatePdfRequest) HasFilename 

func (o *CreatePdfRequest) HasFilename() bool

HasFilename returns a boolean if a field has been set.

func (*CreatePdfRequest) HasS3Bucket 

func (o *CreatePdfRequest) HasS3Bucket() bool

HasS3Bucket returns a boolean if a field has been set.

func (*CreatePdfRequest) HasS3Filepath 

func (o *CreatePdfRequest) HasS3Filepath() bool

HasS3Filepath returns a boolean if a field has been set.

func (*CreatePdfRequest) HasStoreS3 

func (o *CreatePdfRequest) HasStoreS3() bool

HasStoreS3 returns a boolean if a field has been set.

func (CreatePdfRequest) MarshalJSON 

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

func (*CreatePdfRequest) SetData 

func (o *CreatePdfRequest) SetData(v map[string]interface{})

SetData sets field value

func (*CreatePdfRequest) SetExpiration 

func (o *CreatePdfRequest) SetExpiration(v int32)

SetExpiration gets a reference to the given int32 and assigns it to the Expiration field.

func (*CreatePdfRequest) SetExportType 

func (o *CreatePdfRequest) SetExportType(v AppRoutersV1PdfExportType)

SetExportType gets a reference to the given AppRoutersV1PdfExportType and assigns it to the ExportType field.

func (*CreatePdfRequest) SetFilename 

func (o *CreatePdfRequest) SetFilename(v string)

SetFilename gets a reference to the given NullableString and assigns it to the Filename field.

func (*CreatePdfRequest) SetFilenameNil 

func (o *CreatePdfRequest) SetFilenameNil()

SetFilenameNil sets the value for Filename to be an explicit nil

func (*CreatePdfRequest) SetS3Bucket 

func (o *CreatePdfRequest) SetS3Bucket(v string)

SetS3Bucket gets a reference to the given NullableString and assigns it to the S3Bucket field.

func (*CreatePdfRequest) SetS3BucketNil 

func (o *CreatePdfRequest) SetS3BucketNil()

SetS3BucketNil sets the value for S3Bucket to be an explicit nil

func (*CreatePdfRequest) SetS3Filepath 

func (o *CreatePdfRequest) SetS3Filepath(v string)

SetS3Filepath gets a reference to the given NullableString and assigns it to the S3Filepath field.

func (*CreatePdfRequest) SetS3FilepathNil 

func (o *CreatePdfRequest) SetS3FilepathNil()

SetS3FilepathNil sets the value for S3Filepath to be an explicit nil

func (*CreatePdfRequest) SetStoreS3 

func (o *CreatePdfRequest) SetStoreS3(v bool)

SetStoreS3 gets a reference to the given bool and assigns it to the StoreS3 field.

func (*CreatePdfRequest) SetTemplateId 

func (o *CreatePdfRequest) SetTemplateId(v string)

SetTemplateId sets field value

func (CreatePdfRequest) ToMap 

func (o CreatePdfRequest) ToMap() (map[string]interface{}, error)

func (*CreatePdfRequest) UnmarshalJSON 

func (o *CreatePdfRequest) UnmarshalJSON(data []byte) (err error)

func (*CreatePdfRequest) UnsetFilename 

func (o *CreatePdfRequest) UnsetFilename()

UnsetFilename ensures that no value is present for Filename, not even an explicit nil

func (*CreatePdfRequest) UnsetS3Bucket 

func (o *CreatePdfRequest) UnsetS3Bucket()

UnsetS3Bucket ensures that no value is present for S3Bucket, not even an explicit nil

func (*CreatePdfRequest) UnsetS3Filepath 

func (o *CreatePdfRequest) UnsetS3Filepath()

UnsetS3Filepath ensures that no value is present for S3Filepath, not even an explicit nil

type CreatePdfResponse 

type CreatePdfResponse struct {
	// Signed URL to download the PDF (expires after specified time)
	Url string `json:"url"`
	// Filename of the generated PDF
	Filename string `json:"filename"`
	// Remaining credits after this request
	CreditsRemaining int32 `json:"credits_remaining"`
	// Seconds until URL expires
	ExpiresIn int32 `json:"expires_in"`
}

CreatePdfResponse Response for URL export type

func NewCreatePdfResponse 

func NewCreatePdfResponse(url string, filename string, creditsRemaining int32, expiresIn int32) *CreatePdfResponse

NewCreatePdfResponse instantiates a new CreatePdfResponse 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 NewCreatePdfResponseWithDefaults 

func NewCreatePdfResponseWithDefaults() *CreatePdfResponse

NewCreatePdfResponseWithDefaults instantiates a new CreatePdfResponse 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 (*CreatePdfResponse) GetCreditsRemaining 

func (o *CreatePdfResponse) GetCreditsRemaining() int32

GetCreditsRemaining returns the CreditsRemaining field value

func (*CreatePdfResponse) GetCreditsRemainingOk 

func (o *CreatePdfResponse) GetCreditsRemainingOk() (*int32, bool)

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

func (*CreatePdfResponse) GetExpiresIn 

func (o *CreatePdfResponse) GetExpiresIn() int32

GetExpiresIn returns the ExpiresIn field value

func (*CreatePdfResponse) GetExpiresInOk 

func (o *CreatePdfResponse) GetExpiresInOk() (*int32, bool)

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

func (*CreatePdfResponse) GetFilename 

func (o *CreatePdfResponse) GetFilename() string

GetFilename returns the Filename field value

func (*CreatePdfResponse) GetFilenameOk 

func (o *CreatePdfResponse) GetFilenameOk() (*string, bool)

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

func (*CreatePdfResponse) GetUrl 

func (o *CreatePdfResponse) GetUrl() string

GetUrl returns the Url field value

func (*CreatePdfResponse) GetUrlOk 

func (o *CreatePdfResponse) GetUrlOk() (*string, bool)

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

func (CreatePdfResponse) MarshalJSON 

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

func (*CreatePdfResponse) SetCreditsRemaining 

func (o *CreatePdfResponse) SetCreditsRemaining(v int32)

SetCreditsRemaining sets field value

func (*CreatePdfResponse) SetExpiresIn 

func (o *CreatePdfResponse) SetExpiresIn(v int32)

SetExpiresIn sets field value

func (*CreatePdfResponse) SetFilename 

func (o *CreatePdfResponse) SetFilename(v string)

SetFilename sets field value

func (*CreatePdfResponse) SetUrl 

func (o *CreatePdfResponse) SetUrl(v string)

SetUrl sets field value

func (CreatePdfResponse) ToMap 

func (o CreatePdfResponse) ToMap() (map[string]interface{}, error)

func (*CreatePdfResponse) UnmarshalJSON 

func (o *CreatePdfResponse) UnmarshalJSON(data []byte) (err error)

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 HTTPValidationError 

type HTTPValidationError struct {
	Detail []ValidationError `json:"detail,omitempty"`
}

HTTPValidationError struct for HTTPValidationError

func NewHTTPValidationError 

func NewHTTPValidationError() *HTTPValidationError

NewHTTPValidationError instantiates a new HTTPValidationError 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 NewHTTPValidationErrorWithDefaults 

func NewHTTPValidationErrorWithDefaults() *HTTPValidationError

NewHTTPValidationErrorWithDefaults instantiates a new HTTPValidationError 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 (*HTTPValidationError) GetDetail 

func (o *HTTPValidationError) GetDetail() []ValidationError

GetDetail returns the Detail field value if set, zero value otherwise.

func (*HTTPValidationError) GetDetailOk 

func (o *HTTPValidationError) GetDetailOk() ([]ValidationError, bool)

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

func (*HTTPValidationError) HasDetail 

func (o *HTTPValidationError) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (HTTPValidationError) MarshalJSON 

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

func (*HTTPValidationError) SetDetail 

func (o *HTTPValidationError) SetDetail(v []ValidationError)

SetDetail gets a reference to the given []ValidationError and assigns it to the Detail field.

func (HTTPValidationError) ToMap 

func (o HTTPValidationError) ToMap() (map[string]interface{}, error)

type IntegrationsAPI 

type IntegrationsAPI interface {

	/*
		DeleteS3Config Delete S3 configuration

		Delete S3 storage configuration.

	**Authentication:** API Key required (`x-api-key` header)

	**Usage:** Remove your S3 integration. Generated PDFs will use the default CDN storage after deletion.

	**Warning:** This action is irreversible. You'll need to reconfigure S3 to use it again.

	**No credits consumed:** This is a configuration endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// DeleteS3ConfigExecute executes the request
	//  @return S3SuccessResponse
	DeleteS3ConfigExecute(r IntegrationsAPIDeleteS3ConfigRequest) (*S3SuccessResponse, *http.Response, error)

	/*
		GetS3Config Get S3 configuration

		Get current S3 storage configuration.

	**Authentication:** API Key required (`x-api-key` header)

	**Usage:** Retrieve your S3 integration settings. Secret access key is masked for security.

	**Returns 404** if S3 is not configured.

	**No credits consumed:** This is a read-only endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// GetS3ConfigExecute executes the request
	//  @return S3ConfigResponse
	GetS3ConfigExecute(r IntegrationsAPIGetS3ConfigRequest) (*S3ConfigResponse, *http.Response, error)

	/*
		SaveS3Config Save S3 configuration

		Save or update S3-compatible storage configuration.

	**Authentication:** API Key required (`x-api-key` header)

	**Usage:** Configure your S3-compatible storage to receive generated PDFs directly
	in your own bucket instead of the default CDN.

	**Supported providers:**
	- Amazon S3
	- DigitalOcean Spaces
	- Cloudflare R2
	- MinIO
	- Any S3-compatible storage

	**Secret key behavior:**
	- For new configuration: `secret_access_key` is required
	- For updates: Omit `secret_access_key` to keep existing value

	**No credits consumed:** This is a configuration endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// SaveS3ConfigExecute executes the request
	//  @return S3SuccessResponse
	SaveS3ConfigExecute(r IntegrationsAPISaveS3ConfigRequest) (*S3SuccessResponse, *http.Response, error)

	/*
		TestS3Connection Test S3 connection

		Test S3 connection with stored credentials.

	**Authentication:** API Key required (`x-api-key` header)

	**Usage:** Verify your S3 configuration is working correctly. The test will:
	1. Connect to the endpoint
	2. Verify bucket access
	3. Check write permissions by uploading a small test file

	**Prerequisite:** S3 must be configured first using `POST /v1/integrations/s3`

	**No credits consumed:** This is a diagnostic endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// TestS3ConnectionExecute executes the request
	//  @return S3TestResponse
	TestS3ConnectionExecute(r IntegrationsAPITestS3ConnectionRequest) (*S3TestResponse, *http.Response, error)
}

type IntegrationsAPIDeleteS3ConfigRequest 

type IntegrationsAPIDeleteS3ConfigRequest struct {
	ApiService IntegrationsAPI
	// contains filtered or unexported fields
}

func (IntegrationsAPIDeleteS3ConfigRequest) Execute 

func (r IntegrationsAPIDeleteS3ConfigRequest) Execute() (*S3SuccessResponse, *http.Response, error)

type IntegrationsAPIGetS3ConfigRequest 

type IntegrationsAPIGetS3ConfigRequest struct {
	ApiService IntegrationsAPI
	// contains filtered or unexported fields
}

func (IntegrationsAPIGetS3ConfigRequest) Execute 

func (r IntegrationsAPIGetS3ConfigRequest) Execute() (*S3ConfigResponse, *http.Response, error)

type IntegrationsAPISaveS3ConfigRequest 

type IntegrationsAPISaveS3ConfigRequest struct {
	ApiService IntegrationsAPI
	// contains filtered or unexported fields
}

func (IntegrationsAPISaveS3ConfigRequest) Execute 

func (r IntegrationsAPISaveS3ConfigRequest) Execute() (*S3SuccessResponse, *http.Response, error)

func (IntegrationsAPISaveS3ConfigRequest) S3ConfigRequest 

func (r IntegrationsAPISaveS3ConfigRequest) S3ConfigRequest(s3ConfigRequest S3ConfigRequest) IntegrationsAPISaveS3ConfigRequest

type IntegrationsAPIService 

type IntegrationsAPIService service

IntegrationsAPIService IntegrationsAPI service

func (*IntegrationsAPIService) DeleteS3Config 

func (a *IntegrationsAPIService) DeleteS3Config(ctx context.Context) IntegrationsAPIDeleteS3ConfigRequest

DeleteS3Config Delete S3 configuration

Delete S3 storage configuration.

**Authentication:** API Key required (`x-api-key` header)

**Usage:** Remove your S3 integration. Generated PDFs will use the default CDN storage after deletion.

**Warning:** This action is irreversible. You'll need to reconfigure S3 to use it again.

**No credits consumed:** This is a configuration endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*IntegrationsAPIService) DeleteS3ConfigExecute 

func (a *IntegrationsAPIService) DeleteS3ConfigExecute(r IntegrationsAPIDeleteS3ConfigRequest) (*S3SuccessResponse, *http.Response, error)

Execute executes the request 

@return S3SuccessResponse

func (*IntegrationsAPIService) GetS3Config 

func (a *IntegrationsAPIService) GetS3Config(ctx context.Context) IntegrationsAPIGetS3ConfigRequest

GetS3Config Get S3 configuration

Get current S3 storage configuration.

**Authentication:** API Key required (`x-api-key` header)

**Usage:** Retrieve your S3 integration settings. Secret access key is masked for security.

**Returns 404** if S3 is not configured.

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*IntegrationsAPIService) GetS3ConfigExecute 

func (a *IntegrationsAPIService) GetS3ConfigExecute(r IntegrationsAPIGetS3ConfigRequest) (*S3ConfigResponse, *http.Response, error)

Execute executes the request 

@return S3ConfigResponse

func (*IntegrationsAPIService) SaveS3Config 

func (a *IntegrationsAPIService) SaveS3Config(ctx context.Context) IntegrationsAPISaveS3ConfigRequest

SaveS3Config Save S3 configuration

Save or update S3-compatible storage configuration.

**Authentication:** API Key required (`x-api-key` header)

**Usage:** Configure your S3-compatible storage to receive generated PDFs directly in your own bucket instead of the default CDN.

**Supported providers:** - Amazon S3 - DigitalOcean Spaces - Cloudflare R2 - MinIO - Any S3-compatible storage

**Secret key behavior:** - For new configuration: `secret_access_key` is required - For updates: Omit `secret_access_key` to keep existing value

**No credits consumed:** This is a configuration endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*IntegrationsAPIService) SaveS3ConfigExecute 

func (a *IntegrationsAPIService) SaveS3ConfigExecute(r IntegrationsAPISaveS3ConfigRequest) (*S3SuccessResponse, *http.Response, error)

Execute executes the request 

@return S3SuccessResponse

func (*IntegrationsAPIService) TestS3Connection 

func (a *IntegrationsAPIService) TestS3Connection(ctx context.Context) IntegrationsAPITestS3ConnectionRequest

TestS3Connection Test S3 connection

Test S3 connection with stored credentials.

**Authentication:** API Key required (`x-api-key` header)

**Usage:** Verify your S3 configuration is working correctly. The test will: 1. Connect to the endpoint 2. Verify bucket access 3. Check write permissions by uploading a small test file

**Prerequisite:** S3 must be configured first using `POST /v1/integrations/s3`

**No credits consumed:** This is a diagnostic endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*IntegrationsAPIService) TestS3ConnectionExecute 

func (a *IntegrationsAPIService) TestS3ConnectionExecute(r IntegrationsAPITestS3ConnectionRequest) (*S3TestResponse, *http.Response, error)

Execute executes the request 

@return S3TestResponse

type IntegrationsAPITestS3ConnectionRequest 

type IntegrationsAPITestS3ConnectionRequest struct {
	ApiService IntegrationsAPI
	// contains filtered or unexported fields
}

func (IntegrationsAPITestS3ConnectionRequest) Execute 

func (r IntegrationsAPITestS3ConnectionRequest) Execute() (*S3TestResponse, *http.Response, error)

type JobListResponse added in v1.5.0 

type JobListResponse struct {
	// List of jobs
	Jobs []JobStatusResponse `json:"jobs"`
	// Total number of jobs matching filter
	Total int32 `json:"total"`
	// Page size
	Limit int32 `json:"limit"`
	// Page offset
	Offset int32 `json:"offset"`
}

JobListResponse Response for job list query

func NewJobListResponse added in v1.5.0 

func NewJobListResponse(jobs []JobStatusResponse, total int32, limit int32, offset int32) *JobListResponse

NewJobListResponse instantiates a new JobListResponse 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 NewJobListResponseWithDefaults added in v1.5.0 

func NewJobListResponseWithDefaults() *JobListResponse

NewJobListResponseWithDefaults instantiates a new JobListResponse 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 (*JobListResponse) GetJobs added in v1.5.0 

func (o *JobListResponse) GetJobs() []JobStatusResponse

GetJobs returns the Jobs field value

func (*JobListResponse) GetJobsOk added in v1.5.0 

func (o *JobListResponse) GetJobsOk() ([]JobStatusResponse, bool)

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

func (*JobListResponse) GetLimit added in v1.5.0 

func (o *JobListResponse) GetLimit() int32

GetLimit returns the Limit field value

func (*JobListResponse) GetLimitOk added in v1.5.0 

func (o *JobListResponse) GetLimitOk() (*int32, bool)

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

func (*JobListResponse) GetOffset added in v1.5.0 

func (o *JobListResponse) GetOffset() int32

GetOffset returns the Offset field value

func (*JobListResponse) GetOffsetOk added in v1.5.0 

func (o *JobListResponse) GetOffsetOk() (*int32, bool)

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

func (*JobListResponse) GetTotal added in v1.5.0 

func (o *JobListResponse) GetTotal() int32

GetTotal returns the Total field value

func (*JobListResponse) GetTotalOk added in v1.5.0 

func (o *JobListResponse) GetTotalOk() (*int32, bool)

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

func (JobListResponse) MarshalJSON added in v1.5.0 

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

func (*JobListResponse) SetJobs added in v1.5.0 

func (o *JobListResponse) SetJobs(v []JobStatusResponse)

SetJobs sets field value

func (*JobListResponse) SetLimit added in v1.5.0 

func (o *JobListResponse) SetLimit(v int32)

SetLimit sets field value

func (*JobListResponse) SetOffset added in v1.5.0 

func (o *JobListResponse) SetOffset(v int32)

SetOffset sets field value

func (*JobListResponse) SetTotal added in v1.5.0 

func (o *JobListResponse) SetTotal(v int32)

SetTotal sets field value

func (JobListResponse) ToMap added in v1.5.0 

func (o JobListResponse) ToMap() (map[string]interface{}, error)

func (*JobListResponse) UnmarshalJSON added in v1.5.0 

func (o *JobListResponse) UnmarshalJSON(data []byte) (err error)

type JobStatus added in v1.5.0 

type JobStatus string

JobStatus PDF job status values 

const (
	PENDING    JobStatus = "pending"
	PROCESSING JobStatus = "processing"
	COMPLETED  JobStatus = "completed"
	FAILED     JobStatus = "failed"
)

List of JobStatus

func NewJobStatusFromValue added in v1.5.0 

func NewJobStatusFromValue(v string) (*JobStatus, error)

NewJobStatusFromValue returns a pointer to a valid JobStatus for the value passed as argument, or an error if the value passed is not allowed by the enum

func (JobStatus) IsValid added in v1.5.0 

func (v JobStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (JobStatus) Ptr added in v1.5.0 

func (v JobStatus) Ptr() *JobStatus

Ptr returns reference to JobStatus value

func (*JobStatus) UnmarshalJSON added in v1.5.0 

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

type JobStatusResponse added in v1.5.0 

type JobStatusResponse struct {
	// Job ID
	Id string `json:"id"`
	// Current job status
	Status JobStatus `json:"status"`
	// Template used for generation
	TemplateId string `json:"template_id"`
	// Export type (url)
	ExportType string         `json:"export_type"`
	Filename   NullableString `json:"filename,omitempty"`
	// Whether S3 storage was requested
	StoreS3 bool `json:"store_s3"`
	// Job creation timestamp (ISO 8601)
	CreatedAt string `json:"created_at"`
	// Last update timestamp (ISO 8601)
	UpdatedAt       string         `json:"updated_at"`
	CompletedAt     NullableString `json:"completed_at,omitempty"`
	ResultUrl       NullableString `json:"result_url,omitempty"`
	ResultFilename  NullableString `json:"result_filename,omitempty"`
	ResultExpiresAt NullableString `json:"result_expires_at,omitempty"`
	ResultS3Bucket  NullableString `json:"result_s3_bucket,omitempty"`
	ResultS3Key     NullableString `json:"result_s3_key,omitempty"`
	ErrorMessage    NullableString `json:"error_message,omitempty"`
	ErrorCode       NullableString `json:"error_code,omitempty"`
}

JobStatusResponse Response for job status query

func NewJobStatusResponse added in v1.5.0 

func NewJobStatusResponse(id string, status JobStatus, templateId string, exportType string, storeS3 bool, createdAt string, updatedAt string) *JobStatusResponse

NewJobStatusResponse instantiates a new JobStatusResponse 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 NewJobStatusResponseWithDefaults added in v1.5.0 

func NewJobStatusResponseWithDefaults() *JobStatusResponse

NewJobStatusResponseWithDefaults instantiates a new JobStatusResponse 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 (*JobStatusResponse) GetCompletedAt added in v1.5.0 

func (o *JobStatusResponse) GetCompletedAt() string

GetCompletedAt returns the CompletedAt field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetCompletedAtOk added in v1.5.0 

func (o *JobStatusResponse) GetCompletedAtOk() (*string, bool)

GetCompletedAtOk returns a tuple with the CompletedAt field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetCreatedAt added in v1.5.0 

func (o *JobStatusResponse) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field value

func (*JobStatusResponse) GetCreatedAtOk added in v1.5.0 

func (o *JobStatusResponse) GetCreatedAtOk() (*string, bool)

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

func (*JobStatusResponse) GetErrorCode added in v1.5.0 

func (o *JobStatusResponse) GetErrorCode() string

GetErrorCode returns the ErrorCode field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetErrorCodeOk added in v1.5.0 

func (o *JobStatusResponse) GetErrorCodeOk() (*string, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetErrorMessage added in v1.5.0 

func (o *JobStatusResponse) GetErrorMessage() string

GetErrorMessage returns the ErrorMessage field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetErrorMessageOk added in v1.5.0 

func (o *JobStatusResponse) GetErrorMessageOk() (*string, bool)

GetErrorMessageOk returns a tuple with the ErrorMessage field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetExportType added in v1.5.0 

func (o *JobStatusResponse) GetExportType() string

GetExportType returns the ExportType field value

func (*JobStatusResponse) GetExportTypeOk added in v1.5.0 

func (o *JobStatusResponse) GetExportTypeOk() (*string, bool)

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

func (*JobStatusResponse) GetFilename added in v1.5.0 

func (o *JobStatusResponse) GetFilename() string

GetFilename returns the Filename field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetFilenameOk added in v1.5.0 

func (o *JobStatusResponse) GetFilenameOk() (*string, bool)

GetFilenameOk returns a tuple with the Filename field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetId added in v1.5.0 

func (o *JobStatusResponse) GetId() string

GetId returns the Id field value

func (*JobStatusResponse) GetIdOk added in v1.5.0 

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

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

func (*JobStatusResponse) GetResultExpiresAt added in v1.5.0 

func (o *JobStatusResponse) GetResultExpiresAt() string

GetResultExpiresAt returns the ResultExpiresAt field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetResultExpiresAtOk added in v1.5.0 

func (o *JobStatusResponse) GetResultExpiresAtOk() (*string, bool)

GetResultExpiresAtOk returns a tuple with the ResultExpiresAt field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetResultFilename added in v1.5.0 

func (o *JobStatusResponse) GetResultFilename() string

GetResultFilename returns the ResultFilename field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetResultFilenameOk added in v1.5.0 

func (o *JobStatusResponse) GetResultFilenameOk() (*string, bool)

GetResultFilenameOk returns a tuple with the ResultFilename field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetResultS3Bucket added in v1.5.0 

func (o *JobStatusResponse) GetResultS3Bucket() string

GetResultS3Bucket returns the ResultS3Bucket field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetResultS3BucketOk added in v1.5.0 

func (o *JobStatusResponse) GetResultS3BucketOk() (*string, bool)

GetResultS3BucketOk returns a tuple with the ResultS3Bucket field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetResultS3Key added in v1.5.0 

func (o *JobStatusResponse) GetResultS3Key() string

GetResultS3Key returns the ResultS3Key field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetResultS3KeyOk added in v1.5.0 

func (o *JobStatusResponse) GetResultS3KeyOk() (*string, bool)

GetResultS3KeyOk returns a tuple with the ResultS3Key field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetResultUrl added in v1.5.0 

func (o *JobStatusResponse) GetResultUrl() string

GetResultUrl returns the ResultUrl field value if set, zero value otherwise (both if not set or set to explicit null).

func (*JobStatusResponse) GetResultUrlOk added in v1.5.0 

func (o *JobStatusResponse) GetResultUrlOk() (*string, bool)

GetResultUrlOk returns a tuple with the ResultUrl field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*JobStatusResponse) GetStatus added in v1.5.0 

func (o *JobStatusResponse) GetStatus() JobStatus

GetStatus returns the Status field value

func (*JobStatusResponse) GetStatusOk added in v1.5.0 

func (o *JobStatusResponse) GetStatusOk() (*JobStatus, bool)

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

func (*JobStatusResponse) GetStoreS3 added in v1.5.0 

func (o *JobStatusResponse) GetStoreS3() bool

GetStoreS3 returns the StoreS3 field value

func (*JobStatusResponse) GetStoreS3Ok added in v1.5.0 

func (o *JobStatusResponse) GetStoreS3Ok() (*bool, bool)

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

func (*JobStatusResponse) GetTemplateId added in v1.5.0 

func (o *JobStatusResponse) GetTemplateId() string

GetTemplateId returns the TemplateId field value

func (*JobStatusResponse) GetTemplateIdOk added in v1.5.0 

func (o *JobStatusResponse) GetTemplateIdOk() (*string, bool)

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

func (*JobStatusResponse) GetUpdatedAt added in v1.5.0 

func (o *JobStatusResponse) GetUpdatedAt() string

GetUpdatedAt returns the UpdatedAt field value

func (*JobStatusResponse) GetUpdatedAtOk added in v1.5.0 

func (o *JobStatusResponse) GetUpdatedAtOk() (*string, bool)

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

func (*JobStatusResponse) HasCompletedAt added in v1.5.0 

func (o *JobStatusResponse) HasCompletedAt() bool

HasCompletedAt returns a boolean if a field has been set.

func (*JobStatusResponse) HasErrorCode added in v1.5.0 

func (o *JobStatusResponse) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (*JobStatusResponse) HasErrorMessage added in v1.5.0 

func (o *JobStatusResponse) HasErrorMessage() bool

HasErrorMessage returns a boolean if a field has been set.

func (*JobStatusResponse) HasFilename added in v1.5.0 

func (o *JobStatusResponse) HasFilename() bool

HasFilename returns a boolean if a field has been set.

func (*JobStatusResponse) HasResultExpiresAt added in v1.5.0 

func (o *JobStatusResponse) HasResultExpiresAt() bool

HasResultExpiresAt returns a boolean if a field has been set.

func (*JobStatusResponse) HasResultFilename added in v1.5.0 

func (o *JobStatusResponse) HasResultFilename() bool

HasResultFilename returns a boolean if a field has been set.

func (*JobStatusResponse) HasResultS3Bucket added in v1.5.0 

func (o *JobStatusResponse) HasResultS3Bucket() bool

HasResultS3Bucket returns a boolean if a field has been set.

func (*JobStatusResponse) HasResultS3Key added in v1.5.0 

func (o *JobStatusResponse) HasResultS3Key() bool

HasResultS3Key returns a boolean if a field has been set.

func (*JobStatusResponse) HasResultUrl added in v1.5.0 

func (o *JobStatusResponse) HasResultUrl() bool

HasResultUrl returns a boolean if a field has been set.

func (JobStatusResponse) MarshalJSON added in v1.5.0 

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

func (*JobStatusResponse) SetCompletedAt added in v1.5.0 

func (o *JobStatusResponse) SetCompletedAt(v string)

SetCompletedAt gets a reference to the given NullableString and assigns it to the CompletedAt field.

func (*JobStatusResponse) SetCompletedAtNil added in v1.5.0 

func (o *JobStatusResponse) SetCompletedAtNil()

SetCompletedAtNil sets the value for CompletedAt to be an explicit nil

func (*JobStatusResponse) SetCreatedAt added in v1.5.0 

func (o *JobStatusResponse) SetCreatedAt(v string)

SetCreatedAt sets field value

func (*JobStatusResponse) SetErrorCode added in v1.5.0 

func (o *JobStatusResponse) SetErrorCode(v string)

SetErrorCode gets a reference to the given NullableString and assigns it to the ErrorCode field.

func (*JobStatusResponse) SetErrorCodeNil added in v1.5.0 

func (o *JobStatusResponse) SetErrorCodeNil()

SetErrorCodeNil sets the value for ErrorCode to be an explicit nil

func (*JobStatusResponse) SetErrorMessage added in v1.5.0 

func (o *JobStatusResponse) SetErrorMessage(v string)

SetErrorMessage gets a reference to the given NullableString and assigns it to the ErrorMessage field.

func (*JobStatusResponse) SetErrorMessageNil added in v1.5.0 

func (o *JobStatusResponse) SetErrorMessageNil()

SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil

func (*JobStatusResponse) SetExportType added in v1.5.0 

func (o *JobStatusResponse) SetExportType(v string)

SetExportType sets field value

func (*JobStatusResponse) SetFilename added in v1.5.0 

func (o *JobStatusResponse) SetFilename(v string)

SetFilename gets a reference to the given NullableString and assigns it to the Filename field.

func (*JobStatusResponse) SetFilenameNil added in v1.5.0 

func (o *JobStatusResponse) SetFilenameNil()

SetFilenameNil sets the value for Filename to be an explicit nil

func (*JobStatusResponse) SetId added in v1.5.0 

func (o *JobStatusResponse) SetId(v string)

SetId sets field value

func (*JobStatusResponse) SetResultExpiresAt added in v1.5.0 

func (o *JobStatusResponse) SetResultExpiresAt(v string)

SetResultExpiresAt gets a reference to the given NullableString and assigns it to the ResultExpiresAt field.

func (*JobStatusResponse) SetResultExpiresAtNil added in v1.5.0 

func (o *JobStatusResponse) SetResultExpiresAtNil()

SetResultExpiresAtNil sets the value for ResultExpiresAt to be an explicit nil

func (*JobStatusResponse) SetResultFilename added in v1.5.0 

func (o *JobStatusResponse) SetResultFilename(v string)

SetResultFilename gets a reference to the given NullableString and assigns it to the ResultFilename field.

func (*JobStatusResponse) SetResultFilenameNil added in v1.5.0 

func (o *JobStatusResponse) SetResultFilenameNil()

SetResultFilenameNil sets the value for ResultFilename to be an explicit nil

func (*JobStatusResponse) SetResultS3Bucket added in v1.5.0 

func (o *JobStatusResponse) SetResultS3Bucket(v string)

SetResultS3Bucket gets a reference to the given NullableString and assigns it to the ResultS3Bucket field.

func (*JobStatusResponse) SetResultS3BucketNil added in v1.5.0 

func (o *JobStatusResponse) SetResultS3BucketNil()

SetResultS3BucketNil sets the value for ResultS3Bucket to be an explicit nil

func (*JobStatusResponse) SetResultS3Key added in v1.5.0 

func (o *JobStatusResponse) SetResultS3Key(v string)

SetResultS3Key gets a reference to the given NullableString and assigns it to the ResultS3Key field.

func (*JobStatusResponse) SetResultS3KeyNil added in v1.5.0 

func (o *JobStatusResponse) SetResultS3KeyNil()

SetResultS3KeyNil sets the value for ResultS3Key to be an explicit nil

func (*JobStatusResponse) SetResultUrl added in v1.5.0 

func (o *JobStatusResponse) SetResultUrl(v string)

SetResultUrl gets a reference to the given NullableString and assigns it to the ResultUrl field.

func (*JobStatusResponse) SetResultUrlNil added in v1.5.0 

func (o *JobStatusResponse) SetResultUrlNil()

SetResultUrlNil sets the value for ResultUrl to be an explicit nil

func (*JobStatusResponse) SetStatus added in v1.5.0 

func (o *JobStatusResponse) SetStatus(v JobStatus)

SetStatus sets field value

func (*JobStatusResponse) SetStoreS3 added in v1.5.0 

func (o *JobStatusResponse) SetStoreS3(v bool)

SetStoreS3 sets field value

func (*JobStatusResponse) SetTemplateId added in v1.5.0 

func (o *JobStatusResponse) SetTemplateId(v string)

SetTemplateId sets field value

func (*JobStatusResponse) SetUpdatedAt added in v1.5.0 

func (o *JobStatusResponse) SetUpdatedAt(v string)

SetUpdatedAt sets field value

func (JobStatusResponse) ToMap added in v1.5.0 

func (o JobStatusResponse) ToMap() (map[string]interface{}, error)

func (*JobStatusResponse) UnmarshalJSON added in v1.5.0 

func (o *JobStatusResponse) UnmarshalJSON(data []byte) (err error)

func (*JobStatusResponse) UnsetCompletedAt added in v1.5.0 

func (o *JobStatusResponse) UnsetCompletedAt()

UnsetCompletedAt ensures that no value is present for CompletedAt, not even an explicit nil

func (*JobStatusResponse) UnsetErrorCode added in v1.5.0 

func (o *JobStatusResponse) UnsetErrorCode()

UnsetErrorCode ensures that no value is present for ErrorCode, not even an explicit nil

func (*JobStatusResponse) UnsetErrorMessage added in v1.5.0 

func (o *JobStatusResponse) UnsetErrorMessage()

UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil

func (*JobStatusResponse) UnsetFilename added in v1.5.0 

func (o *JobStatusResponse) UnsetFilename()

UnsetFilename ensures that no value is present for Filename, not even an explicit nil

func (*JobStatusResponse) UnsetResultExpiresAt added in v1.5.0 

func (o *JobStatusResponse) UnsetResultExpiresAt()

UnsetResultExpiresAt ensures that no value is present for ResultExpiresAt, not even an explicit nil

func (*JobStatusResponse) UnsetResultFilename added in v1.5.0 

func (o *JobStatusResponse) UnsetResultFilename()

UnsetResultFilename ensures that no value is present for ResultFilename, not even an explicit nil

func (*JobStatusResponse) UnsetResultS3Bucket added in v1.5.0 

func (o *JobStatusResponse) UnsetResultS3Bucket()

UnsetResultS3Bucket ensures that no value is present for ResultS3Bucket, not even an explicit nil

func (*JobStatusResponse) UnsetResultS3Key added in v1.5.0 

func (o *JobStatusResponse) UnsetResultS3Key()

UnsetResultS3Key ensures that no value is present for ResultS3Key, not even an explicit nil

func (*JobStatusResponse) UnsetResultUrl added in v1.5.0 

func (o *JobStatusResponse) UnsetResultUrl()

UnsetResultUrl ensures that no value is present for ResultUrl, not even an explicit nil

type LocationInner 

type LocationInner struct {
	Int32  *int32
	String *string
}

LocationInner struct for LocationInner

func (LocationInner) MarshalJSON 

func (src LocationInner) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*LocationInner) UnmarshalJSON 

func (dst *LocationInner) UnmarshalJSON(data []byte) error

Unmarshal JSON data into any of the pointers in the struct

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableAccountInfoResponse 

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

func NewNullableAccountInfoResponse 

func NewNullableAccountInfoResponse(val *AccountInfoResponse) *NullableAccountInfoResponse

func (NullableAccountInfoResponse) Get 

func (v NullableAccountInfoResponse) Get() *AccountInfoResponse

func (NullableAccountInfoResponse) IsSet 

func (v NullableAccountInfoResponse) IsSet() bool

func (NullableAccountInfoResponse) MarshalJSON 

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

func (*NullableAccountInfoResponse) Set 

func (v *NullableAccountInfoResponse) Set(val *AccountInfoResponse)

func (*NullableAccountInfoResponse) UnmarshalJSON 

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

func (*NullableAccountInfoResponse) Unset 

func (v *NullableAccountInfoResponse) Unset()

type NullableAppRoutersV1PdfAsyncExportType added in v1.5.0 

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

func NewNullableAppRoutersV1PdfAsyncExportType added in v1.5.0 

func NewNullableAppRoutersV1PdfAsyncExportType(val *AppRoutersV1PdfAsyncExportType) *NullableAppRoutersV1PdfAsyncExportType

func (NullableAppRoutersV1PdfAsyncExportType) Get added in v1.5.0 

func (v NullableAppRoutersV1PdfAsyncExportType) Get() *AppRoutersV1PdfAsyncExportType

func (NullableAppRoutersV1PdfAsyncExportType) IsSet added in v1.5.0 

func (v NullableAppRoutersV1PdfAsyncExportType) IsSet() bool

func (NullableAppRoutersV1PdfAsyncExportType) MarshalJSON added in v1.5.0 

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

func (*NullableAppRoutersV1PdfAsyncExportType) Set added in v1.5.0 

func (v *NullableAppRoutersV1PdfAsyncExportType) Set(val *AppRoutersV1PdfAsyncExportType)

func (*NullableAppRoutersV1PdfAsyncExportType) UnmarshalJSON added in v1.5.0 

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

func (*NullableAppRoutersV1PdfAsyncExportType) Unset added in v1.5.0 

func (v *NullableAppRoutersV1PdfAsyncExportType) Unset()

type NullableAppRoutersV1PdfExportType added in v1.5.0 

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

func NewNullableAppRoutersV1PdfExportType added in v1.5.0 

func NewNullableAppRoutersV1PdfExportType(val *AppRoutersV1PdfExportType) *NullableAppRoutersV1PdfExportType

func (NullableAppRoutersV1PdfExportType) Get added in v1.5.0 

func (v NullableAppRoutersV1PdfExportType) Get() *AppRoutersV1PdfExportType

func (NullableAppRoutersV1PdfExportType) IsSet added in v1.5.0 

func (v NullableAppRoutersV1PdfExportType) IsSet() bool

func (NullableAppRoutersV1PdfExportType) MarshalJSON added in v1.5.0 

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

func (*NullableAppRoutersV1PdfExportType) Set added in v1.5.0 

func (v *NullableAppRoutersV1PdfExportType) Set(val *AppRoutersV1PdfExportType)

func (*NullableAppRoutersV1PdfExportType) UnmarshalJSON added in v1.5.0 

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

func (*NullableAppRoutersV1PdfExportType) Unset added in v1.5.0 

func (v *NullableAppRoutersV1PdfExportType) 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 NullableCreateAsyncPdfRequest added in v1.5.0 

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

func NewNullableCreateAsyncPdfRequest added in v1.5.0 

func NewNullableCreateAsyncPdfRequest(val *CreateAsyncPdfRequest) *NullableCreateAsyncPdfRequest

func (NullableCreateAsyncPdfRequest) Get added in v1.5.0 

func (v NullableCreateAsyncPdfRequest) Get() *CreateAsyncPdfRequest

func (NullableCreateAsyncPdfRequest) IsSet added in v1.5.0 

func (v NullableCreateAsyncPdfRequest) IsSet() bool

func (NullableCreateAsyncPdfRequest) MarshalJSON added in v1.5.0 

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

func (*NullableCreateAsyncPdfRequest) Set added in v1.5.0 

func (v *NullableCreateAsyncPdfRequest) Set(val *CreateAsyncPdfRequest)

func (*NullableCreateAsyncPdfRequest) UnmarshalJSON added in v1.5.0 

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

func (*NullableCreateAsyncPdfRequest) Unset added in v1.5.0 

func (v *NullableCreateAsyncPdfRequest) Unset()

type NullableCreateAsyncPdfResponse added in v1.5.0 

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

func NewNullableCreateAsyncPdfResponse added in v1.5.0 

func NewNullableCreateAsyncPdfResponse(val *CreateAsyncPdfResponse) *NullableCreateAsyncPdfResponse

func (NullableCreateAsyncPdfResponse) Get added in v1.5.0 

func (v NullableCreateAsyncPdfResponse) Get() *CreateAsyncPdfResponse

func (NullableCreateAsyncPdfResponse) IsSet added in v1.5.0 

func (v NullableCreateAsyncPdfResponse) IsSet() bool

func (NullableCreateAsyncPdfResponse) MarshalJSON added in v1.5.0 

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

func (*NullableCreateAsyncPdfResponse) Set added in v1.5.0 

func (v *NullableCreateAsyncPdfResponse) Set(val *CreateAsyncPdfResponse)

func (*NullableCreateAsyncPdfResponse) UnmarshalJSON added in v1.5.0 

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

func (*NullableCreateAsyncPdfResponse) Unset added in v1.5.0 

func (v *NullableCreateAsyncPdfResponse) Unset()

type NullableCreatePdfRequest 

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

func NewNullableCreatePdfRequest 

func NewNullableCreatePdfRequest(val *CreatePdfRequest) *NullableCreatePdfRequest

func (NullableCreatePdfRequest) Get 

func (v NullableCreatePdfRequest) Get() *CreatePdfRequest

func (NullableCreatePdfRequest) IsSet 

func (v NullableCreatePdfRequest) IsSet() bool

func (NullableCreatePdfRequest) MarshalJSON 

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

func (*NullableCreatePdfRequest) Set 

func (v *NullableCreatePdfRequest) Set(val *CreatePdfRequest)

func (*NullableCreatePdfRequest) UnmarshalJSON 

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

func (*NullableCreatePdfRequest) Unset 

func (v *NullableCreatePdfRequest) Unset()

type NullableCreatePdfResponse 

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

func NewNullableCreatePdfResponse 

func NewNullableCreatePdfResponse(val *CreatePdfResponse) *NullableCreatePdfResponse

func (NullableCreatePdfResponse) Get 

func (v NullableCreatePdfResponse) Get() *CreatePdfResponse

func (NullableCreatePdfResponse) IsSet 

func (v NullableCreatePdfResponse) IsSet() bool

func (NullableCreatePdfResponse) MarshalJSON 

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

func (*NullableCreatePdfResponse) Set 

func (v *NullableCreatePdfResponse) Set(val *CreatePdfResponse)

func (*NullableCreatePdfResponse) UnmarshalJSON 

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

func (*NullableCreatePdfResponse) Unset 

func (v *NullableCreatePdfResponse) 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 NullableHTTPValidationError 

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

func NewNullableHTTPValidationError 

func NewNullableHTTPValidationError(val *HTTPValidationError) *NullableHTTPValidationError

func (NullableHTTPValidationError) Get 

func (v NullableHTTPValidationError) Get() *HTTPValidationError

func (NullableHTTPValidationError) IsSet 

func (v NullableHTTPValidationError) IsSet() bool

func (NullableHTTPValidationError) MarshalJSON 

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

func (*NullableHTTPValidationError) Set 

func (v *NullableHTTPValidationError) Set(val *HTTPValidationError)

func (*NullableHTTPValidationError) UnmarshalJSON 

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

func (*NullableHTTPValidationError) Unset 

func (v *NullableHTTPValidationError) 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 NullableJobListResponse added in v1.5.0 

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

func NewNullableJobListResponse added in v1.5.0 

func NewNullableJobListResponse(val *JobListResponse) *NullableJobListResponse

func (NullableJobListResponse) Get added in v1.5.0 

func (v NullableJobListResponse) Get() *JobListResponse

func (NullableJobListResponse) IsSet added in v1.5.0 

func (v NullableJobListResponse) IsSet() bool

func (NullableJobListResponse) MarshalJSON added in v1.5.0 

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

func (*NullableJobListResponse) Set added in v1.5.0 

func (v *NullableJobListResponse) Set(val *JobListResponse)

func (*NullableJobListResponse) UnmarshalJSON added in v1.5.0 

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

func (*NullableJobListResponse) Unset added in v1.5.0 

func (v *NullableJobListResponse) Unset()

type NullableJobStatus added in v1.5.0 

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

func NewNullableJobStatus added in v1.5.0 

func NewNullableJobStatus(val *JobStatus) *NullableJobStatus

func (NullableJobStatus) Get added in v1.5.0 

func (v NullableJobStatus) Get() *JobStatus

func (NullableJobStatus) IsSet added in v1.5.0 

func (v NullableJobStatus) IsSet() bool

func (NullableJobStatus) MarshalJSON added in v1.5.0 

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

func (*NullableJobStatus) Set added in v1.5.0 

func (v *NullableJobStatus) Set(val *JobStatus)

func (*NullableJobStatus) UnmarshalJSON added in v1.5.0 

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

func (*NullableJobStatus) Unset added in v1.5.0 

func (v *NullableJobStatus) Unset()

type NullableJobStatusResponse added in v1.5.0 

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

func NewNullableJobStatusResponse added in v1.5.0 

func NewNullableJobStatusResponse(val *JobStatusResponse) *NullableJobStatusResponse

func (NullableJobStatusResponse) Get added in v1.5.0 

func (v NullableJobStatusResponse) Get() *JobStatusResponse

func (NullableJobStatusResponse) IsSet added in v1.5.0 

func (v NullableJobStatusResponse) IsSet() bool

func (NullableJobStatusResponse) MarshalJSON added in v1.5.0 

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

func (*NullableJobStatusResponse) Set added in v1.5.0 

func (v *NullableJobStatusResponse) Set(val *JobStatusResponse)

func (*NullableJobStatusResponse) UnmarshalJSON added in v1.5.0 

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

func (*NullableJobStatusResponse) Unset added in v1.5.0 

func (v *NullableJobStatusResponse) Unset()

type NullableLocationInner 

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

func NewNullableLocationInner 

func NewNullableLocationInner(val *LocationInner) *NullableLocationInner

func (NullableLocationInner) Get 

func (v NullableLocationInner) Get() *LocationInner

func (NullableLocationInner) IsSet 

func (v NullableLocationInner) IsSet() bool

func (NullableLocationInner) MarshalJSON 

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

func (*NullableLocationInner) Set 

func (v *NullableLocationInner) Set(val *LocationInner)

func (*NullableLocationInner) UnmarshalJSON 

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

func (*NullableLocationInner) Unset 

func (v *NullableLocationInner) Unset()

type NullableS3ConfigRequest 

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

func NewNullableS3ConfigRequest 

func NewNullableS3ConfigRequest(val *S3ConfigRequest) *NullableS3ConfigRequest

func (NullableS3ConfigRequest) Get 

func (v NullableS3ConfigRequest) Get() *S3ConfigRequest

func (NullableS3ConfigRequest) IsSet 

func (v NullableS3ConfigRequest) IsSet() bool

func (NullableS3ConfigRequest) MarshalJSON 

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

func (*NullableS3ConfigRequest) Set 

func (v *NullableS3ConfigRequest) Set(val *S3ConfigRequest)

func (*NullableS3ConfigRequest) UnmarshalJSON 

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

func (*NullableS3ConfigRequest) Unset 

func (v *NullableS3ConfigRequest) Unset()

type NullableS3ConfigResponse 

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

func NewNullableS3ConfigResponse 

func NewNullableS3ConfigResponse(val *S3ConfigResponse) *NullableS3ConfigResponse

func (NullableS3ConfigResponse) Get 

func (v NullableS3ConfigResponse) Get() *S3ConfigResponse

func (NullableS3ConfigResponse) IsSet 

func (v NullableS3ConfigResponse) IsSet() bool

func (NullableS3ConfigResponse) MarshalJSON 

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

func (*NullableS3ConfigResponse) Set 

func (v *NullableS3ConfigResponse) Set(val *S3ConfigResponse)

func (*NullableS3ConfigResponse) UnmarshalJSON 

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

func (*NullableS3ConfigResponse) Unset 

func (v *NullableS3ConfigResponse) Unset()

type NullableS3SuccessResponse 

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

func NewNullableS3SuccessResponse 

func NewNullableS3SuccessResponse(val *S3SuccessResponse) *NullableS3SuccessResponse

func (NullableS3SuccessResponse) Get 

func (v NullableS3SuccessResponse) Get() *S3SuccessResponse

func (NullableS3SuccessResponse) IsSet 

func (v NullableS3SuccessResponse) IsSet() bool

func (NullableS3SuccessResponse) MarshalJSON 

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

func (*NullableS3SuccessResponse) Set 

func (v *NullableS3SuccessResponse) Set(val *S3SuccessResponse)

func (*NullableS3SuccessResponse) UnmarshalJSON 

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

func (*NullableS3SuccessResponse) Unset 

func (v *NullableS3SuccessResponse) Unset()

type NullableS3TestResponse 

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

func NewNullableS3TestResponse 

func NewNullableS3TestResponse(val *S3TestResponse) *NullableS3TestResponse

func (NullableS3TestResponse) Get 

func (v NullableS3TestResponse) Get() *S3TestResponse

func (NullableS3TestResponse) IsSet 

func (v NullableS3TestResponse) IsSet() bool

func (NullableS3TestResponse) MarshalJSON 

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

func (*NullableS3TestResponse) Set 

func (v *NullableS3TestResponse) Set(val *S3TestResponse)

func (*NullableS3TestResponse) UnmarshalJSON 

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

func (*NullableS3TestResponse) Unset 

func (v *NullableS3TestResponse) 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 NullableTemplateField 

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

func NewNullableTemplateField 

func NewNullableTemplateField(val *TemplateField) *NullableTemplateField

func (NullableTemplateField) Get 

func (v NullableTemplateField) Get() *TemplateField

func (NullableTemplateField) IsSet 

func (v NullableTemplateField) IsSet() bool

func (NullableTemplateField) MarshalJSON 

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

func (*NullableTemplateField) Set 

func (v *NullableTemplateField) Set(val *TemplateField)

func (*NullableTemplateField) UnmarshalJSON 

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

func (*NullableTemplateField) Unset 

func (v *NullableTemplateField) Unset()

type NullableTemplateFieldSpec added in v1.2.0 

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

func NewNullableTemplateFieldSpec added in v1.2.0 

func NewNullableTemplateFieldSpec(val *TemplateFieldSpec) *NullableTemplateFieldSpec

func (NullableTemplateFieldSpec) Get added in v1.2.0 

func (v NullableTemplateFieldSpec) Get() *TemplateFieldSpec

func (NullableTemplateFieldSpec) IsSet added in v1.2.0 

func (v NullableTemplateFieldSpec) IsSet() bool

func (NullableTemplateFieldSpec) MarshalJSON added in v1.2.0 

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

func (*NullableTemplateFieldSpec) Set added in v1.2.0 

func (v *NullableTemplateFieldSpec) Set(val *TemplateFieldSpec)

func (*NullableTemplateFieldSpec) UnmarshalJSON added in v1.2.0 

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

func (*NullableTemplateFieldSpec) Unset added in v1.2.0 

func (v *NullableTemplateFieldSpec) Unset()

type NullableTemplateListItem 

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

func NewNullableTemplateListItem 

func NewNullableTemplateListItem(val *TemplateListItem) *NullableTemplateListItem

func (NullableTemplateListItem) Get 

func (v NullableTemplateListItem) Get() *TemplateListItem

func (NullableTemplateListItem) IsSet 

func (v NullableTemplateListItem) IsSet() bool

func (NullableTemplateListItem) MarshalJSON 

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

func (*NullableTemplateListItem) Set 

func (v *NullableTemplateListItem) Set(val *TemplateListItem)

func (*NullableTemplateListItem) UnmarshalJSON 

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

func (*NullableTemplateListItem) Unset 

func (v *NullableTemplateListItem) Unset()

type NullableTemplatesListResponse 

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

func NewNullableTemplatesListResponse 

func NewNullableTemplatesListResponse(val *TemplatesListResponse) *NullableTemplatesListResponse

func (NullableTemplatesListResponse) Get 

func (v NullableTemplatesListResponse) Get() *TemplatesListResponse

func (NullableTemplatesListResponse) IsSet 

func (v NullableTemplatesListResponse) IsSet() bool

func (NullableTemplatesListResponse) MarshalJSON 

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

func (*NullableTemplatesListResponse) Set 

func (v *NullableTemplatesListResponse) Set(val *TemplatesListResponse)

func (*NullableTemplatesListResponse) UnmarshalJSON 

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

func (*NullableTemplatesListResponse) Unset 

func (v *NullableTemplatesListResponse) 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 NullableTransaction 

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

func NewNullableTransaction 

func NewNullableTransaction(val *Transaction) *NullableTransaction

func (NullableTransaction) Get 

func (v NullableTransaction) Get() *Transaction

func (NullableTransaction) IsSet 

func (v NullableTransaction) IsSet() bool

func (NullableTransaction) MarshalJSON 

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

func (*NullableTransaction) Set 

func (v *NullableTransaction) Set(val *Transaction)

func (*NullableTransaction) UnmarshalJSON 

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

func (*NullableTransaction) Unset 

func (v *NullableTransaction) Unset()

type NullableTransactionsResponse 

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

func NewNullableTransactionsResponse 

func NewNullableTransactionsResponse(val *TransactionsResponse) *NullableTransactionsResponse

func (NullableTransactionsResponse) Get 

func (v NullableTransactionsResponse) Get() *TransactionsResponse

func (NullableTransactionsResponse) IsSet 

func (v NullableTransactionsResponse) IsSet() bool

func (NullableTransactionsResponse) MarshalJSON 

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

func (*NullableTransactionsResponse) Set 

func (v *NullableTransactionsResponse) Set(val *TransactionsResponse)

func (*NullableTransactionsResponse) UnmarshalJSON 

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

func (*NullableTransactionsResponse) Unset 

func (v *NullableTransactionsResponse) Unset()

type NullableValidationError 

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

func NewNullableValidationError 

func NewNullableValidationError(val *ValidationError) *NullableValidationError

func (NullableValidationError) Get 

func (v NullableValidationError) Get() *ValidationError

func (NullableValidationError) IsSet 

func (v NullableValidationError) IsSet() bool

func (NullableValidationError) MarshalJSON 

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

func (*NullableValidationError) Set 

func (v *NullableValidationError) Set(val *ValidationError)

func (*NullableValidationError) UnmarshalJSON 

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

func (*NullableValidationError) Unset 

func (v *NullableValidationError) Unset()

type PDFAPI 

type PDFAPI interface {

	/*
		CreatePdf Generate PDF from template

		Generate a PDF from a saved template with dynamic data.

	**Authentication:** API Key required (`x-api-key` header)

	## Request Body

	| Field | Type | Required | Description |
	|-------|------|----------|-------------|
	| `template_id` | string | ✅ Yes | Template short ID (12 characters) |
	| `data` | object | ✅ Yes | Key-value data to render in template |
	| `export_type` | string | No | `url` (default) or `binary` |
	| `expiration` | integer | No | URL expiration in seconds (60-604800, default: 86400) |

	## Export Types
	- `url` (default): PDF is uploaded to CDN, returns JSON with URL
	- `binary`: Returns raw PDF bytes directly

	**Credits:** 1 credit deducted per successful generation.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// CreatePdfExecute executes the request
	//  @return CreatePdfResponse
	CreatePdfExecute(r PDFAPICreatePdfRequest) (*CreatePdfResponse, *http.Response, error)
}

type PDFAPICreatePdfRequest 

type PDFAPICreatePdfRequest struct {
	ApiService PDFAPI
	// contains filtered or unexported fields
}

func (PDFAPICreatePdfRequest) CreatePdfRequest 

func (r PDFAPICreatePdfRequest) CreatePdfRequest(createPdfRequest CreatePdfRequest) PDFAPICreatePdfRequest

func (PDFAPICreatePdfRequest) Execute 

func (r PDFAPICreatePdfRequest) Execute() (*CreatePdfResponse, *http.Response, error)

type PDFAPIService 

type PDFAPIService service

PDFAPIService PDFAPI service

func (*PDFAPIService) CreatePdf 

func (a *PDFAPIService) CreatePdf(ctx context.Context) PDFAPICreatePdfRequest

CreatePdf Generate PDF from template

Generate a PDF from a saved template with dynamic data.

**Authentication:** API Key required (`x-api-key` header)

## Request Body

| Field | Type | Required | Description | |-------|------|----------|-------------| | `template_id` | string | ✅ Yes | Template short ID (12 characters) | | `data` | object | ✅ Yes | Key-value data to render in template | | `export_type` | string | No | `url` (default) or `binary` | | `expiration` | integer | No | URL expiration in seconds (60-604800, default: 86400) |

## Export Types - `url` (default): PDF is uploaded to CDN, returns JSON with URL - `binary`: Returns raw PDF bytes directly

**Credits:** 1 credit deducted per successful generation.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*PDFAPIService) CreatePdfExecute 

func (a *PDFAPIService) CreatePdfExecute(r PDFAPICreatePdfRequest) (*CreatePdfResponse, *http.Response, error)

Execute executes the request 

@return CreatePdfResponse

type PDFAsyncAPI added in v1.5.0 

type PDFAsyncAPI interface {

	/*
		CreatePdfAsync Generate PDF asynchronously

		Queue a PDF generation job for async processing.

	**Authentication:** API Key required (`x-api-key` header)

	## How It Works

	1. Submit a job with template and data
	2. Receive a `job_id` immediately
	3. Poll `/v1/pdf/status/{job_id}` for completion
	4. Optionally receive a webhook notification

	## When to Use Async

	Use async generation when:
	- Processing large documents or batches
	- You can't wait for synchronous response
	- You want webhook notifications

	## Webhooks

	If `webhook_url` is provided, we'll POST to it when the job completes or fails:

	“`json
	{
	    "event": "pdf.completed",
	    "job_id": "...",
	    "status": "completed",
	    "result": {
	        "url": "https://...",
	        "filename": "invoice.pdf"
	    }
	}
	“`

	Webhooks include HMAC-SHA256 signature in `X-TemplateFox-Signature` header
	if you provide a `webhook_secret`.

	**Credits:** 1 credit deducted immediately (refunded if job fails permanently).

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

	// CreatePdfAsyncExecute executes the request
	//  @return CreateAsyncPdfResponse
	CreatePdfAsyncExecute(r PDFAsyncAPICreatePdfAsyncRequest) (*CreateAsyncPdfResponse, *http.Response, error)

	/*
		GetPdfJob Get PDF job status

		Get the current status of an async PDF generation job.

	**Authentication:** API Key required (`x-api-key` header)

	## Status Values

	| Status | Description |
	|--------|-------------|
	| `pending` | Job is queued, waiting to be processed |
	| `processing` | Job is being processed |
	| `completed` | PDF generated successfully |
	| `failed` | Job failed (check error_message) |

	## Polling Recommendations

	- Poll every 1-2 seconds for small documents
	- Poll every 5-10 seconds for large documents
	- Consider using webhooks instead of polling

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param jobId
		@return PDFAsyncAPIGetPdfJobRequest
	*/
	GetPdfJob(ctx context.Context, jobId string) PDFAsyncAPIGetPdfJobRequest

	// GetPdfJobExecute executes the request
	//  @return JobStatusResponse
	GetPdfJobExecute(r PDFAsyncAPIGetPdfJobRequest) (*JobStatusResponse, *http.Response, error)

	/*
		ListPdfJobs List PDF jobs

		List async PDF generation jobs for your team.

	**Authentication:** API Key required (`x-api-key` header)

	Supports pagination and filtering by status.

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

	// ListPdfJobsExecute executes the request
	//  @return JobListResponse
	ListPdfJobsExecute(r PDFAsyncAPIListPdfJobsRequest) (*JobListResponse, *http.Response, error)
}

type PDFAsyncAPICreatePdfAsyncRequest added in v1.5.0 

type PDFAsyncAPICreatePdfAsyncRequest struct {
	ApiService PDFAsyncAPI
	// contains filtered or unexported fields
}

func (PDFAsyncAPICreatePdfAsyncRequest) CreateAsyncPdfRequest added in v1.5.0 

func (r PDFAsyncAPICreatePdfAsyncRequest) CreateAsyncPdfRequest(createAsyncPdfRequest CreateAsyncPdfRequest) PDFAsyncAPICreatePdfAsyncRequest

func (PDFAsyncAPICreatePdfAsyncRequest) Execute added in v1.5.0 

func (r PDFAsyncAPICreatePdfAsyncRequest) Execute() (*CreateAsyncPdfResponse, *http.Response, error)

type PDFAsyncAPIGetPdfJobRequest added in v1.6.0 

type PDFAsyncAPIGetPdfJobRequest struct {
	ApiService PDFAsyncAPI
	// contains filtered or unexported fields
}

func (PDFAsyncAPIGetPdfJobRequest) Execute added in v1.6.0 

func (r PDFAsyncAPIGetPdfJobRequest) Execute() (*JobStatusResponse, *http.Response, error)

type PDFAsyncAPIListPdfJobsRequest added in v1.5.0 

type PDFAsyncAPIListPdfJobsRequest struct {
	ApiService PDFAsyncAPI
	// contains filtered or unexported fields
}

func (PDFAsyncAPIListPdfJobsRequest) Execute added in v1.5.0 

func (r PDFAsyncAPIListPdfJobsRequest) Execute() (*JobListResponse, *http.Response, error)

func (PDFAsyncAPIListPdfJobsRequest) Limit added in v1.5.0 

func (r PDFAsyncAPIListPdfJobsRequest) Limit(limit int32) PDFAsyncAPIListPdfJobsRequest

func (PDFAsyncAPIListPdfJobsRequest) Offset added in v1.5.0 

func (r PDFAsyncAPIListPdfJobsRequest) Offset(offset int32) PDFAsyncAPIListPdfJobsRequest

func (PDFAsyncAPIListPdfJobsRequest) Status added in v1.5.0 

func (r PDFAsyncAPIListPdfJobsRequest) Status(status JobStatus) PDFAsyncAPIListPdfJobsRequest

type PDFAsyncAPIService added in v1.5.0 

type PDFAsyncAPIService service

PDFAsyncAPIService PDFAsyncAPI service

func (*PDFAsyncAPIService) CreatePdfAsync added in v1.5.0 

func (a *PDFAsyncAPIService) CreatePdfAsync(ctx context.Context) PDFAsyncAPICreatePdfAsyncRequest

CreatePdfAsync Generate PDF asynchronously

Queue a PDF generation job for async processing.

**Authentication:** API Key required (`x-api-key` header)

## How It Works

1. Submit a job with template and data 2. Receive a `job_id` immediately 3. Poll `/v1/pdf/status/{job_id}` for completion 4. Optionally receive a webhook notification

## When to Use Async

Use async generation when: - Processing large documents or batches - You can't wait for synchronous response - You want webhook notifications

## Webhooks

If `webhook_url` is provided, we'll POST to it when the job completes or fails:

```json 

{
    "event": "pdf.completed",
    "job_id": "...",
    "status": "completed",
    "result": {
        "url": "https://...",
        "filename": "invoice.pdf"
    }
}

```

Webhooks include HMAC-SHA256 signature in `X-TemplateFox-Signature` header if you provide a `webhook_secret`.

**Credits:** 1 credit deducted immediately (refunded if job fails permanently). 

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

func (*PDFAsyncAPIService) CreatePdfAsyncExecute added in v1.5.0 

func (a *PDFAsyncAPIService) CreatePdfAsyncExecute(r PDFAsyncAPICreatePdfAsyncRequest) (*CreateAsyncPdfResponse, *http.Response, error)

Execute executes the request 

@return CreateAsyncPdfResponse

func (*PDFAsyncAPIService) GetPdfJob added in v1.6.0 

func (a *PDFAsyncAPIService) GetPdfJob(ctx context.Context, jobId string) PDFAsyncAPIGetPdfJobRequest

GetPdfJob Get PDF job status

Get the current status of an async PDF generation job.

**Authentication:** API Key required (`x-api-key` header)

## Status Values

| Status | Description | |--------|-------------| | `pending` | Job is queued, waiting to be processed | | `processing` | Job is being processed | | `completed` | PDF generated successfully | | `failed` | Job failed (check error_message) |

## Polling Recommendations

- Poll every 1-2 seconds for small documents - Poll every 5-10 seconds for large documents - Consider using webhooks instead of polling 

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

func (*PDFAsyncAPIService) GetPdfJobExecute added in v1.6.0 

func (a *PDFAsyncAPIService) GetPdfJobExecute(r PDFAsyncAPIGetPdfJobRequest) (*JobStatusResponse, *http.Response, error)

Execute executes the request 

@return JobStatusResponse

func (*PDFAsyncAPIService) ListPdfJobs added in v1.5.0 

func (a *PDFAsyncAPIService) ListPdfJobs(ctx context.Context) PDFAsyncAPIListPdfJobsRequest

ListPdfJobs List PDF jobs

List async PDF generation jobs for your team.

**Authentication:** API Key required (`x-api-key` header)

Supports pagination and filtering by status. 

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

func (*PDFAsyncAPIService) ListPdfJobsExecute added in v1.5.0 

func (a *PDFAsyncAPIService) ListPdfJobsExecute(r PDFAsyncAPIListPdfJobsRequest) (*JobListResponse, *http.Response, error)

Execute executes the request 

@return JobListResponse

type S3ConfigRequest 

type S3ConfigRequest struct {
	// S3-compatible endpoint URL. Must start with https://
	EndpointUrl string `json:"endpoint_url" validate:"regexp=^https:\\/\\/"`
	// Access key ID for S3 authentication
	AccessKeyId     string         `json:"access_key_id"`
	SecretAccessKey NullableString `json:"secret_access_key,omitempty"`
	// S3 bucket name. Must follow S3 naming conventions (lowercase, no underscores)
	BucketName string `json:"bucket_name" validate:"regexp=^[a-z0-9][a-z0-9.\\\\-]*[a-z0-9]$"`
	// Default path prefix for uploaded files. Can include slashes for folder structure
	DefaultPrefix *string `json:"default_prefix,omitempty" validate:"regexp=^[a-zA-Z0-9_\\\\-\\\\.\\/]*$"`
}

S3ConfigRequest Request model for S3 configuration

func NewS3ConfigRequest 

func NewS3ConfigRequest(endpointUrl string, accessKeyId string, bucketName string) *S3ConfigRequest

NewS3ConfigRequest instantiates a new S3ConfigRequest 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 NewS3ConfigRequestWithDefaults 

func NewS3ConfigRequestWithDefaults() *S3ConfigRequest

NewS3ConfigRequestWithDefaults instantiates a new S3ConfigRequest 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 (*S3ConfigRequest) GetAccessKeyId 

func (o *S3ConfigRequest) GetAccessKeyId() string

GetAccessKeyId returns the AccessKeyId field value

func (*S3ConfigRequest) GetAccessKeyIdOk 

func (o *S3ConfigRequest) GetAccessKeyIdOk() (*string, bool)

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

func (*S3ConfigRequest) GetBucketName 

func (o *S3ConfigRequest) GetBucketName() string

GetBucketName returns the BucketName field value

func (*S3ConfigRequest) GetBucketNameOk 

func (o *S3ConfigRequest) GetBucketNameOk() (*string, bool)

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

func (*S3ConfigRequest) GetDefaultPrefix 

func (o *S3ConfigRequest) GetDefaultPrefix() string

GetDefaultPrefix returns the DefaultPrefix field value if set, zero value otherwise.

func (*S3ConfigRequest) GetDefaultPrefixOk 

func (o *S3ConfigRequest) GetDefaultPrefixOk() (*string, bool)

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

func (*S3ConfigRequest) GetEndpointUrl 

func (o *S3ConfigRequest) GetEndpointUrl() string

GetEndpointUrl returns the EndpointUrl field value

func (*S3ConfigRequest) GetEndpointUrlOk 

func (o *S3ConfigRequest) GetEndpointUrlOk() (*string, bool)

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

func (*S3ConfigRequest) GetSecretAccessKey 

func (o *S3ConfigRequest) GetSecretAccessKey() string

GetSecretAccessKey returns the SecretAccessKey field value if set, zero value otherwise (both if not set or set to explicit null).

func (*S3ConfigRequest) GetSecretAccessKeyOk 

func (o *S3ConfigRequest) GetSecretAccessKeyOk() (*string, bool)

GetSecretAccessKeyOk returns a tuple with the SecretAccessKey field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*S3ConfigRequest) HasDefaultPrefix 

func (o *S3ConfigRequest) HasDefaultPrefix() bool

HasDefaultPrefix returns a boolean if a field has been set.

func (*S3ConfigRequest) HasSecretAccessKey 

func (o *S3ConfigRequest) HasSecretAccessKey() bool

HasSecretAccessKey returns a boolean if a field has been set.

func (S3ConfigRequest) MarshalJSON 

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

func (*S3ConfigRequest) SetAccessKeyId 

func (o *S3ConfigRequest) SetAccessKeyId(v string)

SetAccessKeyId sets field value

func (*S3ConfigRequest) SetBucketName 

func (o *S3ConfigRequest) SetBucketName(v string)

SetBucketName sets field value

func (*S3ConfigRequest) SetDefaultPrefix 

func (o *S3ConfigRequest) SetDefaultPrefix(v string)

SetDefaultPrefix gets a reference to the given string and assigns it to the DefaultPrefix field.

func (*S3ConfigRequest) SetEndpointUrl 

func (o *S3ConfigRequest) SetEndpointUrl(v string)

SetEndpointUrl sets field value

func (*S3ConfigRequest) SetSecretAccessKey 

func (o *S3ConfigRequest) SetSecretAccessKey(v string)

SetSecretAccessKey gets a reference to the given NullableString and assigns it to the SecretAccessKey field.

func (*S3ConfigRequest) SetSecretAccessKeyNil 

func (o *S3ConfigRequest) SetSecretAccessKeyNil()

SetSecretAccessKeyNil sets the value for SecretAccessKey to be an explicit nil

func (S3ConfigRequest) ToMap 

func (o S3ConfigRequest) ToMap() (map[string]interface{}, error)

func (*S3ConfigRequest) UnmarshalJSON 

func (o *S3ConfigRequest) UnmarshalJSON(data []byte) (err error)

func (*S3ConfigRequest) UnsetSecretAccessKey 

func (o *S3ConfigRequest) UnsetSecretAccessKey()

UnsetSecretAccessKey ensures that no value is present for SecretAccessKey, not even an explicit nil

type S3ConfigResponse 

type S3ConfigResponse struct {
	// Whether S3 is configured
	Configured bool `json:"configured"`
	// S3-compatible endpoint URL
	EndpointUrl string `json:"endpoint_url"`
	// Access key ID
	AccessKeyId string `json:"access_key_id"`
	// Masked secret access key (shows first 4 and last 4 characters)
	SecretAccessKeyMasked string `json:"secret_access_key_masked"`
	// S3 bucket name
	BucketName string `json:"bucket_name"`
	// Default path prefix for uploads
	DefaultPrefix string `json:"default_prefix"`
}

S3ConfigResponse Response for S3 configuration (with masked secret)

func NewS3ConfigResponse 

func NewS3ConfigResponse(configured bool, endpointUrl string, accessKeyId string, secretAccessKeyMasked string, bucketName string, defaultPrefix string) *S3ConfigResponse

NewS3ConfigResponse instantiates a new S3ConfigResponse 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 NewS3ConfigResponseWithDefaults 

func NewS3ConfigResponseWithDefaults() *S3ConfigResponse

NewS3ConfigResponseWithDefaults instantiates a new S3ConfigResponse 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 (*S3ConfigResponse) GetAccessKeyId 

func (o *S3ConfigResponse) GetAccessKeyId() string

GetAccessKeyId returns the AccessKeyId field value

func (*S3ConfigResponse) GetAccessKeyIdOk 

func (o *S3ConfigResponse) GetAccessKeyIdOk() (*string, bool)

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

func (*S3ConfigResponse) GetBucketName 

func (o *S3ConfigResponse) GetBucketName() string

GetBucketName returns the BucketName field value

func (*S3ConfigResponse) GetBucketNameOk 

func (o *S3ConfigResponse) GetBucketNameOk() (*string, bool)

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

func (*S3ConfigResponse) GetConfigured 

func (o *S3ConfigResponse) GetConfigured() bool

GetConfigured returns the Configured field value

func (*S3ConfigResponse) GetConfiguredOk 

func (o *S3ConfigResponse) GetConfiguredOk() (*bool, bool)

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

func (*S3ConfigResponse) GetDefaultPrefix 

func (o *S3ConfigResponse) GetDefaultPrefix() string

GetDefaultPrefix returns the DefaultPrefix field value

func (*S3ConfigResponse) GetDefaultPrefixOk 

func (o *S3ConfigResponse) GetDefaultPrefixOk() (*string, bool)

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

func (*S3ConfigResponse) GetEndpointUrl 

func (o *S3ConfigResponse) GetEndpointUrl() string

GetEndpointUrl returns the EndpointUrl field value

func (*S3ConfigResponse) GetEndpointUrlOk 

func (o *S3ConfigResponse) GetEndpointUrlOk() (*string, bool)

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

func (*S3ConfigResponse) GetSecretAccessKeyMasked 

func (o *S3ConfigResponse) GetSecretAccessKeyMasked() string

GetSecretAccessKeyMasked returns the SecretAccessKeyMasked field value

func (*S3ConfigResponse) GetSecretAccessKeyMaskedOk 

func (o *S3ConfigResponse) GetSecretAccessKeyMaskedOk() (*string, bool)

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

func (S3ConfigResponse) MarshalJSON 

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

func (*S3ConfigResponse) SetAccessKeyId 

func (o *S3ConfigResponse) SetAccessKeyId(v string)

SetAccessKeyId sets field value

func (*S3ConfigResponse) SetBucketName 

func (o *S3ConfigResponse) SetBucketName(v string)

SetBucketName sets field value

func (*S3ConfigResponse) SetConfigured 

func (o *S3ConfigResponse) SetConfigured(v bool)

SetConfigured sets field value

func (*S3ConfigResponse) SetDefaultPrefix 

func (o *S3ConfigResponse) SetDefaultPrefix(v string)

SetDefaultPrefix sets field value

func (*S3ConfigResponse) SetEndpointUrl 

func (o *S3ConfigResponse) SetEndpointUrl(v string)

SetEndpointUrl sets field value

func (*S3ConfigResponse) SetSecretAccessKeyMasked 

func (o *S3ConfigResponse) SetSecretAccessKeyMasked(v string)

SetSecretAccessKeyMasked sets field value

func (S3ConfigResponse) ToMap 

func (o S3ConfigResponse) ToMap() (map[string]interface{}, error)

func (*S3ConfigResponse) UnmarshalJSON 

func (o *S3ConfigResponse) UnmarshalJSON(data []byte) (err error)

type S3SuccessResponse 

type S3SuccessResponse struct {
	// Whether the operation succeeded
	Success bool `json:"success"`
}

S3SuccessResponse Generic success response for S3 operations

func NewS3SuccessResponse 

func NewS3SuccessResponse(success bool) *S3SuccessResponse

NewS3SuccessResponse instantiates a new S3SuccessResponse 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 NewS3SuccessResponseWithDefaults 

func NewS3SuccessResponseWithDefaults() *S3SuccessResponse

NewS3SuccessResponseWithDefaults instantiates a new S3SuccessResponse 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 (*S3SuccessResponse) GetSuccess 

func (o *S3SuccessResponse) GetSuccess() bool

GetSuccess returns the Success field value

func (*S3SuccessResponse) GetSuccessOk 

func (o *S3SuccessResponse) GetSuccessOk() (*bool, bool)

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

func (S3SuccessResponse) MarshalJSON 

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

func (*S3SuccessResponse) SetSuccess 

func (o *S3SuccessResponse) SetSuccess(v bool)

SetSuccess sets field value

func (S3SuccessResponse) ToMap 

func (o S3SuccessResponse) ToMap() (map[string]interface{}, error)

func (*S3SuccessResponse) UnmarshalJSON 

func (o *S3SuccessResponse) UnmarshalJSON(data []byte) (err error)

type S3TestResponse 

type S3TestResponse struct {
	// Whether the connection test succeeded
	Success bool `json:"success"`
	// Test result message
	Message string `json:"message"`
}

S3TestResponse Response for S3 connection test

func NewS3TestResponse 

func NewS3TestResponse(success bool, message string) *S3TestResponse

NewS3TestResponse instantiates a new S3TestResponse 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 NewS3TestResponseWithDefaults 

func NewS3TestResponseWithDefaults() *S3TestResponse

NewS3TestResponseWithDefaults instantiates a new S3TestResponse 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 (*S3TestResponse) GetMessage 

func (o *S3TestResponse) GetMessage() string

GetMessage returns the Message field value

func (*S3TestResponse) GetMessageOk 

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

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

func (*S3TestResponse) GetSuccess 

func (o *S3TestResponse) GetSuccess() bool

GetSuccess returns the Success field value

func (*S3TestResponse) GetSuccessOk 

func (o *S3TestResponse) GetSuccessOk() (*bool, bool)

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

func (S3TestResponse) MarshalJSON 

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

func (*S3TestResponse) SetMessage 

func (o *S3TestResponse) SetMessage(v string)

SetMessage sets field value

func (*S3TestResponse) SetSuccess 

func (o *S3TestResponse) SetSuccess(v bool)

SetSuccess sets field value

func (S3TestResponse) ToMap 

func (o S3TestResponse) ToMap() (map[string]interface{}, error)

func (*S3TestResponse) UnmarshalJSON 

func (o *S3TestResponse) UnmarshalJSON(data []byte) (err error)

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 TemplateField 

type TemplateField struct {
	// Field key/identifier
	Key string `json:"key"`
	// Human-readable label
	Label string `json:"label"`
	// Field type: string, integer, number, boolean, array
	Type *string `json:"type,omitempty"`
	// Whether the field is required
	Required *bool               `json:"required,omitempty"`
	HelpText NullableString      `json:"helpText,omitempty"`
	Spec     []TemplateFieldSpec `json:"spec,omitempty"`
}

TemplateField Field definition for template variables (compatible with Zapier and Make.com)

func NewTemplateField 

func NewTemplateField(key string, label string) *TemplateField

NewTemplateField instantiates a new TemplateField 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 NewTemplateFieldWithDefaults 

func NewTemplateFieldWithDefaults() *TemplateField

NewTemplateFieldWithDefaults instantiates a new TemplateField 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 (*TemplateField) GetHelpText 

func (o *TemplateField) GetHelpText() string

GetHelpText returns the HelpText field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateField) GetHelpTextOk 

func (o *TemplateField) GetHelpTextOk() (*string, bool)

GetHelpTextOk returns a tuple with the HelpText field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateField) GetKey 

func (o *TemplateField) GetKey() string

GetKey returns the Key field value

func (*TemplateField) GetKeyOk 

func (o *TemplateField) GetKeyOk() (*string, bool)

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

func (*TemplateField) GetLabel 

func (o *TemplateField) GetLabel() string

GetLabel returns the Label field value

func (*TemplateField) GetLabelOk 

func (o *TemplateField) GetLabelOk() (*string, bool)

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

func (*TemplateField) GetRequired 

func (o *TemplateField) GetRequired() bool

GetRequired returns the Required field value if set, zero value otherwise.

func (*TemplateField) GetRequiredOk 

func (o *TemplateField) GetRequiredOk() (*bool, bool)

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

func (*TemplateField) GetSpec added in v1.2.0 

func (o *TemplateField) GetSpec() []TemplateFieldSpec

GetSpec returns the Spec field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TemplateField) GetSpecOk added in v1.2.0 

func (o *TemplateField) GetSpecOk() ([]TemplateFieldSpec, bool)

GetSpecOk returns a tuple with the Spec field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TemplateField) GetType 

func (o *TemplateField) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*TemplateField) GetTypeOk 

func (o *TemplateField) GetTypeOk() (*string, bool)

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

func (*TemplateField) HasHelpText 

func (o *TemplateField) HasHelpText() bool

HasHelpText returns a boolean if a field has been set.

func (*TemplateField) HasRequired 

func (o *TemplateField) HasRequired() bool

HasRequired returns a boolean if a field has been set.

func (*TemplateField) HasSpec added in v1.2.0 

func (o *TemplateField) HasSpec() bool

HasSpec returns a boolean if a field has been set.

func (*TemplateField) HasType 

func (o *TemplateField) HasType() bool

HasType returns a boolean if a field has been set.

func (TemplateField) MarshalJSON 

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

func (*TemplateField) SetHelpText 

func (o *TemplateField) SetHelpText(v string)

SetHelpText gets a reference to the given NullableString and assigns it to the HelpText field.

func (*TemplateField) SetHelpTextNil 

func (o *TemplateField) SetHelpTextNil()

SetHelpTextNil sets the value for HelpText to be an explicit nil

func (*TemplateField) SetKey 

func (o *TemplateField) SetKey(v string)

SetKey sets field value

func (*TemplateField) SetLabel 

func (o *TemplateField) SetLabel(v string)

SetLabel sets field value

func (*TemplateField) SetRequired 

func (o *TemplateField) SetRequired(v bool)

SetRequired gets a reference to the given bool and assigns it to the Required field.

func (*TemplateField) SetSpec added in v1.2.0 

func (o *TemplateField) SetSpec(v []TemplateFieldSpec)

SetSpec gets a reference to the given []TemplateFieldSpec and assigns it to the Spec field.

func (*TemplateField) SetType 

func (o *TemplateField) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (TemplateField) ToMap 

func (o TemplateField) ToMap() (map[string]interface{}, error)

func (*TemplateField) UnmarshalJSON 

func (o *TemplateField) UnmarshalJSON(data []byte) (err error)

func (*TemplateField) UnsetHelpText 

func (o *TemplateField) UnsetHelpText()

UnsetHelpText ensures that no value is present for HelpText, not even an explicit nil

type TemplateFieldSpec added in v1.2.0 

type TemplateFieldSpec struct {
	// Field name
	Name string `json:"name"`
	// Field label
	Label string `json:"label"`
	// Field type: text, number
	Type *string `json:"type,omitempty"`
}

TemplateFieldSpec Spec for array item fields

func NewTemplateFieldSpec added in v1.2.0 

func NewTemplateFieldSpec(name string, label string) *TemplateFieldSpec

NewTemplateFieldSpec instantiates a new TemplateFieldSpec 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 NewTemplateFieldSpecWithDefaults added in v1.2.0 

func NewTemplateFieldSpecWithDefaults() *TemplateFieldSpec

NewTemplateFieldSpecWithDefaults instantiates a new TemplateFieldSpec 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 (*TemplateFieldSpec) GetLabel added in v1.2.0 

func (o *TemplateFieldSpec) GetLabel() string

GetLabel returns the Label field value

func (*TemplateFieldSpec) GetLabelOk added in v1.2.0 

func (o *TemplateFieldSpec) GetLabelOk() (*string, bool)

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

func (*TemplateFieldSpec) GetName added in v1.2.0 

func (o *TemplateFieldSpec) GetName() string

GetName returns the Name field value

func (*TemplateFieldSpec) GetNameOk added in v1.2.0 

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

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

func (*TemplateFieldSpec) GetType added in v1.2.0 

func (o *TemplateFieldSpec) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*TemplateFieldSpec) GetTypeOk added in v1.2.0 

func (o *TemplateFieldSpec) GetTypeOk() (*string, bool)

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

func (*TemplateFieldSpec) HasType added in v1.2.0 

func (o *TemplateFieldSpec) HasType() bool

HasType returns a boolean if a field has been set.

func (TemplateFieldSpec) MarshalJSON added in v1.2.0 

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

func (*TemplateFieldSpec) SetLabel added in v1.2.0 

func (o *TemplateFieldSpec) SetLabel(v string)

SetLabel sets field value

func (*TemplateFieldSpec) SetName added in v1.2.0 

func (o *TemplateFieldSpec) SetName(v string)

SetName sets field value

func (*TemplateFieldSpec) SetType added in v1.2.0 

func (o *TemplateFieldSpec) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (TemplateFieldSpec) ToMap added in v1.2.0 

func (o TemplateFieldSpec) ToMap() (map[string]interface{}, error)

func (*TemplateFieldSpec) UnmarshalJSON added in v1.2.0 

func (o *TemplateFieldSpec) UnmarshalJSON(data []byte) (err error)

type TemplateListItem 

type TemplateListItem struct {
	// Template short ID (12 characters)
	Id string `json:"id"`
	// Template name
	Name string `json:"name"`
	// ISO 8601 timestamp
	CreatedAt string `json:"created_at"`
	// ISO 8601 timestamp
	UpdatedAt string `json:"updated_at"`
}

TemplateListItem Template item in list response

func NewTemplateListItem 

func NewTemplateListItem(id string, name string, createdAt string, updatedAt string) *TemplateListItem

NewTemplateListItem instantiates a new TemplateListItem 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 NewTemplateListItemWithDefaults 

func NewTemplateListItemWithDefaults() *TemplateListItem

NewTemplateListItemWithDefaults instantiates a new TemplateListItem 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 (*TemplateListItem) GetCreatedAt 

func (o *TemplateListItem) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field value

func (*TemplateListItem) GetCreatedAtOk 

func (o *TemplateListItem) GetCreatedAtOk() (*string, bool)

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

func (*TemplateListItem) GetId 

func (o *TemplateListItem) GetId() string

GetId returns the Id field value

func (*TemplateListItem) GetIdOk 

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

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

func (*TemplateListItem) GetName 

func (o *TemplateListItem) GetName() string

GetName returns the Name field value

func (*TemplateListItem) GetNameOk 

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

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

func (*TemplateListItem) GetUpdatedAt 

func (o *TemplateListItem) GetUpdatedAt() string

GetUpdatedAt returns the UpdatedAt field value

func (*TemplateListItem) GetUpdatedAtOk 

func (o *TemplateListItem) GetUpdatedAtOk() (*string, bool)

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

func (TemplateListItem) MarshalJSON 

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

func (*TemplateListItem) SetCreatedAt 

func (o *TemplateListItem) SetCreatedAt(v string)

SetCreatedAt sets field value

func (*TemplateListItem) SetId 

func (o *TemplateListItem) SetId(v string)

SetId sets field value

func (*TemplateListItem) SetName 

func (o *TemplateListItem) SetName(v string)

SetName sets field value

func (*TemplateListItem) SetUpdatedAt 

func (o *TemplateListItem) SetUpdatedAt(v string)

SetUpdatedAt sets field value

func (TemplateListItem) ToMap 

func (o TemplateListItem) ToMap() (map[string]interface{}, error)

func (*TemplateListItem) UnmarshalJSON 

func (o *TemplateListItem) UnmarshalJSON(data []byte) (err error)

type TemplatesAPI 

type TemplatesAPI interface {

	/*
		GetTemplateFields Get template fields

		Get the dynamic fields for a template.

	**Authentication:** API Key required (`x-api-key` header) or JWT token

	**Usage:** This endpoint is designed for no-code tool integrations (Zapier, Make.com).
	It returns an array of field definitions used to dynamically generate input forms.

	**Response format:** Array of field objects with: `key`, `label`, `type`, `required`,
	optional `helpText`, and optional `spec` (for array fields).

	**Field types:**
	- `string`: Text input
	- `integer`: Integer number
	- `number`: Decimal number
	- `boolean`: True/False checkbox
	- `array`: Array of items with nested `spec` defining item structure

	**Array fields:** When a field is an array of objects, the response includes a `spec`
	array defining the structure of each item (name, label, type for each nested field).

	**No credits consumed:** This is a read-only endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param templateId
		@return TemplatesAPIGetTemplateFieldsRequest
	*/
	GetTemplateFields(ctx context.Context, templateId string) TemplatesAPIGetTemplateFieldsRequest

	// GetTemplateFieldsExecute executes the request
	//  @return []TemplateField
	GetTemplateFieldsExecute(r TemplatesAPIGetTemplateFieldsRequest) ([]TemplateField, *http.Response, error)

	/*
		ListTemplates List templates

		List all templates for the authenticated user.

	**Authentication:** API Key required (`x-api-key` header) or JWT token

	**Usage:** This endpoint is designed for no-code tools (Zapier, Make, n8n) to populate
	template selection dropdowns.

	**No credits consumed:** This is a read-only endpoint.

	**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response.

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

	// ListTemplatesExecute executes the request
	//  @return TemplatesListResponse
	ListTemplatesExecute(r TemplatesAPIListTemplatesRequest) (*TemplatesListResponse, *http.Response, error)
}

type TemplatesAPIGetTemplateFieldsRequest 

type TemplatesAPIGetTemplateFieldsRequest struct {
	ApiService TemplatesAPI
	// contains filtered or unexported fields
}

func (TemplatesAPIGetTemplateFieldsRequest) Execute 

func (r TemplatesAPIGetTemplateFieldsRequest) Execute() ([]TemplateField, *http.Response, error)

type TemplatesAPIListTemplatesRequest 

type TemplatesAPIListTemplatesRequest struct {
	ApiService TemplatesAPI
	// contains filtered or unexported fields
}

func (TemplatesAPIListTemplatesRequest) Execute 

func (r TemplatesAPIListTemplatesRequest) Execute() (*TemplatesListResponse, *http.Response, error)

type TemplatesAPIService 

type TemplatesAPIService service

TemplatesAPIService TemplatesAPI service

func (*TemplatesAPIService) GetTemplateFields 

func (a *TemplatesAPIService) GetTemplateFields(ctx context.Context, templateId string) TemplatesAPIGetTemplateFieldsRequest

GetTemplateFields Get template fields

Get the dynamic fields for a template.

**Authentication:** API Key required (`x-api-key` header) or JWT token

**Usage:** This endpoint is designed for no-code tool integrations (Zapier, Make.com). It returns an array of field definitions used to dynamically generate input forms.

**Response format:** Array of field objects with: `key`, `label`, `type`, `required`, optional `helpText`, and optional `spec` (for array fields).

**Field types:** - `string`: Text input - `integer`: Integer number - `number`: Decimal number - `boolean`: True/False checkbox - `array`: Array of items with nested `spec` defining item structure

**Array fields:** When a field is an array of objects, the response includes a `spec` array defining the structure of each item (name, label, type for each nested field).

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*TemplatesAPIService) GetTemplateFieldsExecute 

func (a *TemplatesAPIService) GetTemplateFieldsExecute(r TemplatesAPIGetTemplateFieldsRequest) ([]TemplateField, *http.Response, error)

Execute executes the request 

@return []TemplateField

func (*TemplatesAPIService) ListTemplates 

func (a *TemplatesAPIService) ListTemplates(ctx context.Context) TemplatesAPIListTemplatesRequest

ListTemplates List templates

List all templates for the authenticated user.

**Authentication:** API Key required (`x-api-key` header) or JWT token

**Usage:** This endpoint is designed for no-code tools (Zapier, Make, n8n) to populate template selection dropdowns.

**No credits consumed:** This is a read-only endpoint.

**Rate Limits:** 60 requests/min (free), 120 requests/min (paid). Headers included in response. 

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

func (*TemplatesAPIService) ListTemplatesExecute 

func (a *TemplatesAPIService) ListTemplatesExecute(r TemplatesAPIListTemplatesRequest) (*TemplatesListResponse, *http.Response, error)

Execute executes the request 

@return TemplatesListResponse

type TemplatesListResponse 

type TemplatesListResponse struct {
	Templates []TemplateListItem `json:"templates"`
}

TemplatesListResponse Response for template list endpoint

func NewTemplatesListResponse 

func NewTemplatesListResponse(templates []TemplateListItem) *TemplatesListResponse

NewTemplatesListResponse instantiates a new TemplatesListResponse 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 NewTemplatesListResponseWithDefaults 

func NewTemplatesListResponseWithDefaults() *TemplatesListResponse

NewTemplatesListResponseWithDefaults instantiates a new TemplatesListResponse 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 (*TemplatesListResponse) GetTemplates 

func (o *TemplatesListResponse) GetTemplates() []TemplateListItem

GetTemplates returns the Templates field value

func (*TemplatesListResponse) GetTemplatesOk 

func (o *TemplatesListResponse) GetTemplatesOk() ([]TemplateListItem, bool)

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

func (TemplatesListResponse) MarshalJSON 

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

func (*TemplatesListResponse) SetTemplates 

func (o *TemplatesListResponse) SetTemplates(v []TemplateListItem)

SetTemplates sets field value

func (TemplatesListResponse) ToMap 

func (o TemplatesListResponse) ToMap() (map[string]interface{}, error)

func (*TemplatesListResponse) UnmarshalJSON 

func (o *TemplatesListResponse) UnmarshalJSON(data []byte) (err error)

type Transaction 

type Transaction struct {
	// Unique transaction reference (UUID)
	TransactionRef string `json:"transaction_ref"`
	// Transaction type: PDFGEN, PURCHASE, REFUND, BONUS
	TransactionType string         `json:"transaction_type"`
	TemplateId      NullableString `json:"template_id,omitempty"`
	ExecTm          NullableInt32  `json:"exec_tm,omitempty"`
	// Credits consumed (positive) or added (negative)
	Credits int32 `json:"credits"`
	// ISO 8601 timestamp
	CreatedAt string `json:"created_at"`
}

Transaction Transaction record

func NewTransaction 

func NewTransaction(transactionRef string, transactionType string, credits int32, createdAt string) *Transaction

NewTransaction instantiates a new Transaction 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 NewTransactionWithDefaults 

func NewTransactionWithDefaults() *Transaction

NewTransactionWithDefaults instantiates a new Transaction 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 (*Transaction) GetCreatedAt 

func (o *Transaction) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field value

func (*Transaction) GetCreatedAtOk 

func (o *Transaction) GetCreatedAtOk() (*string, bool)

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

func (*Transaction) GetCredits 

func (o *Transaction) GetCredits() int32

GetCredits returns the Credits field value

func (*Transaction) GetCreditsOk 

func (o *Transaction) GetCreditsOk() (*int32, bool)

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

func (*Transaction) GetExecTm 

func (o *Transaction) GetExecTm() int32

GetExecTm returns the ExecTm field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Transaction) GetExecTmOk 

func (o *Transaction) GetExecTmOk() (*int32, bool)

GetExecTmOk returns a tuple with the ExecTm field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Transaction) GetTemplateId 

func (o *Transaction) GetTemplateId() string

GetTemplateId returns the TemplateId field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Transaction) GetTemplateIdOk 

func (o *Transaction) GetTemplateIdOk() (*string, bool)

GetTemplateIdOk returns a tuple with the TemplateId field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Transaction) GetTransactionRef 

func (o *Transaction) GetTransactionRef() string

GetTransactionRef returns the TransactionRef field value

func (*Transaction) GetTransactionRefOk 

func (o *Transaction) GetTransactionRefOk() (*string, bool)

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

func (*Transaction) GetTransactionType 

func (o *Transaction) GetTransactionType() string

GetTransactionType returns the TransactionType field value

func (*Transaction) GetTransactionTypeOk 

func (o *Transaction) GetTransactionTypeOk() (*string, bool)

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

func (*Transaction) HasExecTm 

func (o *Transaction) HasExecTm() bool

HasExecTm returns a boolean if a field has been set.

func (*Transaction) HasTemplateId 

func (o *Transaction) HasTemplateId() bool

HasTemplateId returns a boolean if a field has been set.

func (Transaction) MarshalJSON 

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

func (*Transaction) SetCreatedAt 

func (o *Transaction) SetCreatedAt(v string)

SetCreatedAt sets field value

func (*Transaction) SetCredits 

func (o *Transaction) SetCredits(v int32)

SetCredits sets field value

func (*Transaction) SetExecTm 

func (o *Transaction) SetExecTm(v int32)

SetExecTm gets a reference to the given NullableInt32 and assigns it to the ExecTm field.

func (*Transaction) SetExecTmNil 

func (o *Transaction) SetExecTmNil()

SetExecTmNil sets the value for ExecTm to be an explicit nil

func (*Transaction) SetTemplateId 

func (o *Transaction) SetTemplateId(v string)

SetTemplateId gets a reference to the given NullableString and assigns it to the TemplateId field.

func (*Transaction) SetTemplateIdNil 

func (o *Transaction) SetTemplateIdNil()

SetTemplateIdNil sets the value for TemplateId to be an explicit nil

func (*Transaction) SetTransactionRef 

func (o *Transaction) SetTransactionRef(v string)

SetTransactionRef sets field value

func (*Transaction) SetTransactionType 

func (o *Transaction) SetTransactionType(v string)

SetTransactionType sets field value

func (Transaction) ToMap 

func (o Transaction) ToMap() (map[string]interface{}, error)

func (*Transaction) UnmarshalJSON 

func (o *Transaction) UnmarshalJSON(data []byte) (err error)

func (*Transaction) UnsetExecTm 

func (o *Transaction) UnsetExecTm()

UnsetExecTm ensures that no value is present for ExecTm, not even an explicit nil

func (*Transaction) UnsetTemplateId 

func (o *Transaction) UnsetTemplateId()

UnsetTemplateId ensures that no value is present for TemplateId, not even an explicit nil

type TransactionsResponse 

type TransactionsResponse struct {
	Transactions []Transaction `json:"transactions"`
	// Total number of transactions
	Total int32 `json:"total"`
	// Number of records returned
	Limit int32 `json:"limit"`
	// Number of records skipped
	Offset int32 `json:"offset"`
}

TransactionsResponse Response for transactions list endpoint

func NewTransactionsResponse 

func NewTransactionsResponse(transactions []Transaction, total int32, limit int32, offset int32) *TransactionsResponse

NewTransactionsResponse instantiates a new TransactionsResponse 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 NewTransactionsResponseWithDefaults 

func NewTransactionsResponseWithDefaults() *TransactionsResponse

NewTransactionsResponseWithDefaults instantiates a new TransactionsResponse 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 (*TransactionsResponse) GetLimit 

func (o *TransactionsResponse) GetLimit() int32

GetLimit returns the Limit field value

func (*TransactionsResponse) GetLimitOk 

func (o *TransactionsResponse) GetLimitOk() (*int32, bool)

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

func (*TransactionsResponse) GetOffset 

func (o *TransactionsResponse) GetOffset() int32

GetOffset returns the Offset field value

func (*TransactionsResponse) GetOffsetOk 

func (o *TransactionsResponse) GetOffsetOk() (*int32, bool)

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

func (*TransactionsResponse) GetTotal 

func (o *TransactionsResponse) GetTotal() int32

GetTotal returns the Total field value

func (*TransactionsResponse) GetTotalOk 

func (o *TransactionsResponse) GetTotalOk() (*int32, bool)

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

func (*TransactionsResponse) GetTransactions 

func (o *TransactionsResponse) GetTransactions() []Transaction

GetTransactions returns the Transactions field value

func (*TransactionsResponse) GetTransactionsOk 

func (o *TransactionsResponse) GetTransactionsOk() ([]Transaction, bool)

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

func (TransactionsResponse) MarshalJSON 

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

func (*TransactionsResponse) SetLimit 

func (o *TransactionsResponse) SetLimit(v int32)

SetLimit sets field value

func (*TransactionsResponse) SetOffset 

func (o *TransactionsResponse) SetOffset(v int32)

SetOffset sets field value

func (*TransactionsResponse) SetTotal 

func (o *TransactionsResponse) SetTotal(v int32)

SetTotal sets field value

func (*TransactionsResponse) SetTransactions 

func (o *TransactionsResponse) SetTransactions(v []Transaction)

SetTransactions sets field value

func (TransactionsResponse) ToMap 

func (o TransactionsResponse) ToMap() (map[string]interface{}, error)

func (*TransactionsResponse) UnmarshalJSON 

func (o *TransactionsResponse) UnmarshalJSON(data []byte) (err error)

type ValidationError 

type ValidationError struct {
	Loc  []LocationInner `json:"loc"`
	Msg  string          `json:"msg"`
	Type string          `json:"type"`
}

ValidationError struct for ValidationError

func NewValidationError 

func NewValidationError(loc []LocationInner, msg string, type_ string) *ValidationError

NewValidationError instantiates a new ValidationError 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 NewValidationErrorWithDefaults 

func NewValidationErrorWithDefaults() *ValidationError

NewValidationErrorWithDefaults instantiates a new ValidationError 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 (*ValidationError) GetLoc 

func (o *ValidationError) GetLoc() []LocationInner

GetLoc returns the Loc field value

func (*ValidationError) GetLocOk 

func (o *ValidationError) GetLocOk() ([]LocationInner, bool)

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

func (*ValidationError) GetMsg 

func (o *ValidationError) GetMsg() string

GetMsg returns the Msg field value

func (*ValidationError) GetMsgOk 

func (o *ValidationError) GetMsgOk() (*string, bool)

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

func (*ValidationError) GetType 

func (o *ValidationError) GetType() string

GetType returns the Type field value

func (*ValidationError) GetTypeOk 

func (o *ValidationError) GetTypeOk() (*string, bool)

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

func (ValidationError) MarshalJSON 

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

func (*ValidationError) SetLoc 

func (o *ValidationError) SetLoc(v []LocationInner)

SetLoc sets field value

func (*ValidationError) SetMsg 

func (o *ValidationError) SetMsg(v string)

SetMsg sets field value

func (*ValidationError) SetType 

func (o *ValidationError) SetType(v string)

SetType sets field value

func (ValidationError) ToMap 

func (o ValidationError) ToMap() (map[string]interface{}, error)

func (*ValidationError) UnmarshalJSON 

func (o *ValidationError) UnmarshalJSON(data []byte) (err 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.