github.com/panoratech/go-sdk

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

🛠 Make your SDK feel handcrafted by customizing it
♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
🎁 Publish your SDK to package managers by configuring automatic publishing
✨ When ready to productionize, delete this section from the README

Summary

Panora API: A unified API to ship integrations

SDK Installation
SDK Example Usage
Available Resources and Operations
Pagination
Retries
Error Handling
Server Selection
Custom HTTP Client
Authentication

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/panoratech/go-sdk

SDK Example Usage

Example

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Accounting

Accounting.Accounts

List - List Accounts
Create - Create Accounts
Retrieve - Retrieve Accounts

Accounting.Addresses

List - List Addresss
Retrieve - Retrieve Addresses

Accounting.Attachments

List - List Attachments
Create - Create Attachments
Retrieve - Retrieve Attachments

Accounting.Balancesheets

List - List BalanceSheets
Retrieve - Retrieve BalanceSheets

Accounting.Cashflowstatements

List - List CashflowStatements
Retrieve - Retrieve Cashflow Statements

Accounting.Companyinfos

List - List CompanyInfos
Retrieve - Retrieve Company Infos

Accounting.Contacts

List - List Contacts
Create - Create Contacts
Retrieve - Retrieve Contacts

Accounting.Creditnotes

List - List CreditNotes
Retrieve - Retrieve Credit Notes

Accounting.Expenses

List - List Expenses
Create - Create Expenses
Retrieve - Retrieve Expenses

Accounting.Incomestatements

List - List IncomeStatements
Retrieve - Retrieve Income Statements

Accounting.Invoices

List - List Invoices
Create - Create Invoices
Retrieve - Retrieve Invoices

Accounting.Items

List - List Items
Retrieve - Retrieve Items

Accounting.Journalentries

List - List JournalEntrys
Create - Create Journal Entries
Retrieve - Retrieve Journal Entries

Accounting.Payments

List - List Payments
Create - Create Payments
Retrieve - Retrieve Payments

Accounting.Phonenumbers

List - List PhoneNumbers
Retrieve - Retrieve Phone Numbers

Accounting.Purchaseorders

List - List PurchaseOrders
Create - Create Purchase Orders
Retrieve - Retrieve Purchase Orders

Accounting.Taxrates

List - List TaxRates
Retrieve - Retrieve Tax Rates

Accounting.Trackingcategories

List - List TrackingCategorys
Retrieve - Retrieve Tracking Categories

Accounting.Transactions

List - List Transactions
Retrieve - Retrieve Transactions

Accounting.Vendorcredits

List - List VendorCredits
Retrieve - Retrieve Vendor Credits

Crm

Crm.Companies

List - List Companies
Create - Create Companies
Retrieve - Retrieve Companies

Crm.Contacts

List - List CRM Contacts
Create - Create Contacts
Retrieve - Retrieve Contacts

Crm.Deals

List - List Deals
Create - Create Deals
Retrieve - Retrieve Deals

Crm.Engagements

List - List Engagements
Create - Create Engagements
Retrieve - Retrieve Engagements

Crm.Notes

List - List Notes
Create - Create Notes
Retrieve - Retrieve Notes

Crm.Stages

List - List Stages
Retrieve - Retrieve Stages

Crm.Tasks

List - List Tasks
Create - Create Tasks
Retrieve - Retrieve Tasks

Crm.Users

List - List Users
Retrieve - Retrieve Users

Ecommerce

Ecommerce.Customers

List - List Customers
Retrieve - Retrieve Customers

Ecommerce.Fulfillments

List - List Fulfillments
Retrieve - Retrieve Fulfillments

Ecommerce.Orders

List - List Orders
Create - Create Orders
Retrieve - Retrieve Orders

Ecommerce.Products

List - List Products
Create - Create Products
Retrieve - Retrieve Products

FieldMappings

GetFieldMappingValues - Retrieve field mappings values
GetFieldMappingsEntities - Retrieve field mapping entities
GetFieldMappings - Retrieve field mappings
Definitions - Define target Field
DefineCustomField - Create Custom Field
Map - Map Custom Field

Filestorage

Filestorage.Files

List - List Files
Create - Create Files
Retrieve - Retrieve Files

Filestorage.Folders

List - List Folders
Create - Create Folders
Retrieve - Retrieve Folders

Filestorage.Groups

List - List Groups
Retrieve - Retrieve Groups

Filestorage.Users

List - List Users
Retrieve - Retrieve Users

LinkedUsers

RemoteID - Retrieve a Linked User From A Remote Id
Create - Create Linked Users
List - List Linked Users
ImportBatch - Add Batch Linked Users
Retrieve - Retrieve Linked Users

Marketingautomation

Marketingautomation.Actions

List - List Actions
Create - Create Action
Retrieve - Retrieve Actions

Marketingautomation.Automations

List - List Automations
Create - Create Automation
Retrieve - Retrieve Automation

Marketingautomation.Campaigns

List - List Campaigns
Create - Create Campaign
Retrieve - Retrieve Campaign

Marketingautomation.Contacts

List - List Contacts
Create - Create Contact
Retrieve - Retrieve Contacts

Marketingautomation.Emails

List - List Emails
Retrieve - Retrieve Email

Marketingautomation.Events

List - List Events
Retrieve - Retrieve Event

Marketingautomation.Lists

List - List Lists
Create - Create Lists
Retrieve - Retrieve List

Marketingautomation.Messages

List - List Messages
Retrieve - Retrieve Messages

Marketingautomation.Templates

List - List Templates
Create - Create Template
Retrieve - Retrieve Template

Marketingautomation.Users

List - List Users
Retrieve - Retrieve Users

Passthrough

Request - Make a passthrough request

Passthrough.{retryid}

GetRetriedRequestResponse - Retrieve response of a failed passthrough request due to rate limits

Projects

GetProjects - Retrieve projects
Create - Create a project

Sync

Status - Retrieve sync status of a certain vertical
Resync - Resync common objects across a vertical
UpdatePullFrequency - Update pull frequency for verticals
GetPullFrequency - Get pull frequency for verticals

Ticketing

Ticketing.Accounts

List - List Accounts
Retrieve - Retrieve Accounts

Ticketing.Attachments

List - List Attachments
Create - Create Attachments
Retrieve - Retrieve Attachments

Ticketing.Collections

List - List Collections
Retrieve - Retrieve Collections

Ticketing.Comments

List - List Comments
Create - Create Comments
Retrieve - Retrieve Comment

Ticketing.Contacts

List - List Contacts
Retrieve - Retrieve Contact

Ticketing.Teams

List - List Teams
Retrieve - Retrieve Teams

Ticketing.Tickets

List - List Tickets
Create - Create Tickets
Retrieve - Retrieve Tickets

Ticketing.Users

List - List Users
Retrieve - Retrieve User

Webhooks

List - List webhooks
Create - Create webhook
Delete - Delete Webhook
UpdateStatus - Update webhook status
VerifyEvent - Verify payload signature of the webhook

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"github.com/panoratech/go-sdk/retry"
	"log"
	"models/operations"
)

func main() {
	s := gosdk.New(
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"github.com/panoratech/go-sdk/retry"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the Hello function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	/

Example

package main

import (
	"context"
	"errors"
	gosdk "github.com/panoratech/go-sdk"
	"github.com/panoratech/go-sdk/models/sdkerrors"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex(serverIndex int) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server
0	`https://api.panora.dev`
1	`https://api-sandbox.panora.dev`
2	`https://api-dev.panora.dev`

Example

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithServerIndex(2),
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithServerURL("https://api.panora.dev"),
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`APIKey`	apiKey	API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Hello(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Res != nil {
		// handle response
	}
}

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

package main

import (
	"context"
	gosdk "github.com/panoratech/go-sdk"
	"log"
)

func main() {
	s := gosdk.New(
		gosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Filestorage.Files.List(ctx, "<value>", gosdk.Bool(true), gosdk.Float64(10), gosdk.String("1b8b05bb-5273-4012-b520-8657b0b90874"))
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}

	}
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

github.com/panoratech/go-sdk

🏗 Welcome to your new SDK! 🏗

Summary

Table of Contents

SDK Installation

SDK Example Usage

Example

Available Resources and Operations

Retries

Error Handling

Example

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Pagination

Development

Maturity

Contributions

SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=&utm_campaign=go)