https://github.com/panoratech/go-sdk

Last synced: 7 months ago
JSON representation
Host: GitHub
URL: https://github.com/panoratech/go-sdk
Owner: panoratech
Created: 2024-07-30T18:06:54.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-11-18T18:57:23.000Z (11 months ago)
Last Synced: 2024-11-18T19:27:30.601Z (11 months ago)
Language: Go
Size: 1.77 MB
Stars: 0
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project

README

          # 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](https://www.speakeasy.com/docs/customize-sdks)

- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)

- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)

- [ ] ✨ When ready to productionize, delete this section from the README

## Summary

Panora API: A unified API to ship integrations

## Table of Contents

* [SDK Installation](#sdk-installation)

* [SDK Example Usage](#sdk-example-usage)

* [Available Resources and Operations](#available-resources-and-operations)

* [Pagination](#pagination)

* [Retries](#retries)

* [Error Handling](#error-handling)

* [Server Selection](#server-selection)

* [Custom HTTP Client](#custom-http-client)

* [Authentication](#authentication)

## SDK Installation

To add the SDK as a dependency to your project:

```bash

go get github.com/panoratech/go-sdk

```

## SDK Example Usage

### Example

```go

package main

import (

	"context"

	gosdk "github.com/panoratech/go-sdk"

	"log"

)

func main() {

	s := gosdk.New(

		gosdk.WithSecurity(""),

	)

	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](docs/sdks/accounting/README.md)

#### [Accounting.Accounts](docs/sdks/panoraaccounts/README.md)

* [List](docs/sdks/panoraaccounts/README.md#list) - List  Accounts

* [Create](docs/sdks/panoraaccounts/README.md#create) - Create Accounts

* [Retrieve](docs/sdks/panoraaccounts/README.md#retrieve) - Retrieve Accounts

#### [Accounting.Addresses](docs/sdks/addresses/README.md)

* [List](docs/sdks/addresses/README.md#list) - List  Addresss

* [Retrieve](docs/sdks/addresses/README.md#retrieve) - Retrieve Addresses

#### [Accounting.Attachments](docs/sdks/attachments/README.md)

* [List](docs/sdks/attachments/README.md#list) - List  Attachments

* [Create](docs/sdks/attachments/README.md#create) - Create Attachments

* [Retrieve](docs/sdks/attachments/README.md#retrieve) - Retrieve Attachments

#### [Accounting.Balancesheets](docs/sdks/balancesheets/README.md)

* [List](docs/sdks/balancesheets/README.md#list) - List  BalanceSheets

* [Retrieve](docs/sdks/balancesheets/README.md#retrieve) - Retrieve BalanceSheets

#### [Accounting.Cashflowstatements](docs/sdks/cashflowstatements/README.md)

* [List](docs/sdks/cashflowstatements/README.md#list) - List  CashflowStatements

* [Retrieve](docs/sdks/cashflowstatements/README.md#retrieve) - Retrieve Cashflow Statements

#### [Accounting.Companyinfos](docs/sdks/companyinfos/README.md)

* [List](docs/sdks/companyinfos/README.md#list) - List  CompanyInfos

* [Retrieve](docs/sdks/companyinfos/README.md#retrieve) - Retrieve Company Infos

#### [Accounting.Contacts](docs/sdks/panoraaccountingcontacts/README.md)

* [List](docs/sdks/panoraaccountingcontacts/README.md#list) - List  Contacts

* [Create](docs/sdks/panoraaccountingcontacts/README.md#create) - Create Contacts

* [Retrieve](docs/sdks/panoraaccountingcontacts/README.md#retrieve) - Retrieve Contacts

#### [Accounting.Creditnotes](docs/sdks/creditnotes/README.md)

* [List](docs/sdks/creditnotes/README.md#list) - List  CreditNotes

* [Retrieve](docs/sdks/creditnotes/README.md#retrieve) - Retrieve Credit Notes

#### [Accounting.Expenses](docs/sdks/expenses/README.md)

* [List](docs/sdks/expenses/README.md#list) - List  Expenses

* [Create](docs/sdks/expenses/README.md#create) - Create Expenses

* [Retrieve](docs/sdks/expenses/README.md#retrieve) - Retrieve Expenses

#### [Accounting.Incomestatements](docs/sdks/incomestatements/README.md)

* [List](docs/sdks/incomestatements/README.md#list) - List  IncomeStatements

* [Retrieve](docs/sdks/incomestatements/README.md#retrieve) - Retrieve Income Statements

#### [Accounting.Invoices](docs/sdks/invoices/README.md)

* [List](docs/sdks/invoices/README.md#list) - List  Invoices

* [Create](docs/sdks/invoices/README.md#create) - Create Invoices

* [Retrieve](docs/sdks/invoices/README.md#retrieve) - Retrieve Invoices

#### [Accounting.Items](docs/sdks/items/README.md)

* [List](docs/sdks/items/README.md#list) - List  Items

* [Retrieve](docs/sdks/items/README.md#retrieve) - Retrieve Items

#### [Accounting.Journalentries](docs/sdks/journalentries/README.md)

* [List](docs/sdks/journalentries/README.md#list) - List  JournalEntrys

* [Create](docs/sdks/journalentries/README.md#create) - Create Journal Entries

* [Retrieve](docs/sdks/journalentries/README.md#retrieve) - Retrieve Journal Entries

#### [Accounting.Payments](docs/sdks/payments/README.md)

* [List](docs/sdks/payments/README.md#list) - List  Payments

* [Create](docs/sdks/payments/README.md#create) - Create Payments

* [Retrieve](docs/sdks/payments/README.md#retrieve) - Retrieve Payments

#### [Accounting.Phonenumbers](docs/sdks/phonenumbers/README.md)

* [List](docs/sdks/phonenumbers/README.md#list) - List  PhoneNumbers

* [Retrieve](docs/sdks/phonenumbers/README.md#retrieve) - Retrieve Phone Numbers

#### [Accounting.Purchaseorders](docs/sdks/purchaseorders/README.md)

* [List](docs/sdks/purchaseorders/README.md#list) - List  PurchaseOrders

* [Create](docs/sdks/purchaseorders/README.md#create) - Create Purchase Orders

* [Retrieve](docs/sdks/purchaseorders/README.md#retrieve) - Retrieve Purchase Orders

#### [Accounting.Taxrates](docs/sdks/taxrates/README.md)

* [List](docs/sdks/taxrates/README.md#list) - List  TaxRates

* [Retrieve](docs/sdks/taxrates/README.md#retrieve) - Retrieve Tax Rates

#### [Accounting.Trackingcategories](docs/sdks/trackingcategories/README.md)

* [List](docs/sdks/trackingcategories/README.md#list) - List  TrackingCategorys

* [Retrieve](docs/sdks/trackingcategories/README.md#retrieve) - Retrieve Tracking Categories

#### [Accounting.Transactions](docs/sdks/transactions/README.md)

* [List](docs/sdks/transactions/README.md#list) - List  Transactions

* [Retrieve](docs/sdks/transactions/README.md#retrieve) - Retrieve Transactions

#### [Accounting.Vendorcredits](docs/sdks/vendorcredits/README.md)

* [List](docs/sdks/vendorcredits/README.md#list) - List  VendorCredits

* [Retrieve](docs/sdks/vendorcredits/README.md#retrieve) - Retrieve Vendor Credits

### [Auth](docs/sdks/auth/README.md)

#### [Auth.Login](docs/sdks/login/README.md)

* [SignIn](docs/sdks/login/README.md#signin) - Log In

### [Connections](docs/sdks/connections/README.md)

* [List](docs/sdks/connections/README.md#list) - List Connections

### [Crm](docs/sdks/crm/README.md)

#### [Crm.Companies](docs/sdks/companies/README.md)

* [List](docs/sdks/companies/README.md#list) - List Companies

* [Create](docs/sdks/companies/README.md#create) - Create Companies

* [Retrieve](docs/sdks/companies/README.md#retrieve) - Retrieve Companies

#### [Crm.Contacts](docs/sdks/panoracontacts/README.md)

* [List](docs/sdks/panoracontacts/README.md#list) - List CRM Contacts

* [Create](docs/sdks/panoracontacts/README.md#create) - Create Contacts

* [Retrieve](docs/sdks/panoracontacts/README.md#retrieve) - Retrieve Contacts

#### [Crm.Deals](docs/sdks/deals/README.md)

* [List](docs/sdks/deals/README.md#list) - List Deals

* [Create](docs/sdks/deals/README.md#create) - Create Deals

* [Retrieve](docs/sdks/deals/README.md#retrieve) - Retrieve Deals

#### [Crm.Engagements](docs/sdks/engagements/README.md)

* [List](docs/sdks/engagements/README.md#list) - List Engagements

* [Create](docs/sdks/engagements/README.md#create) - Create Engagements

* [Retrieve](docs/sdks/engagements/README.md#retrieve) - Retrieve Engagements

#### [Crm.Notes](docs/sdks/notes/README.md)

* [List](docs/sdks/notes/README.md#list) - List Notes

* [Create](docs/sdks/notes/README.md#create) - Create Notes

* [Retrieve](docs/sdks/notes/README.md#retrieve) - Retrieve Notes

#### [Crm.Stages](docs/sdks/stages/README.md)

* [List](docs/sdks/stages/README.md#list) - List  Stages

* [Retrieve](docs/sdks/stages/README.md#retrieve) - Retrieve Stages

#### [Crm.Tasks](docs/sdks/tasks/README.md)

* [List](docs/sdks/tasks/README.md#list) - List Tasks

* [Create](docs/sdks/tasks/README.md#create) - Create Tasks

* [Retrieve](docs/sdks/tasks/README.md#retrieve) - Retrieve Tasks

#### [Crm.Users](docs/sdks/panorausers/README.md)

* [List](docs/sdks/panorausers/README.md#list) - List  Users

* [Retrieve](docs/sdks/panorausers/README.md#retrieve) - Retrieve Users

### [Ecommerce](docs/sdks/ecommerce/README.md)

#### [Ecommerce.Customers](docs/sdks/customers/README.md)

* [List](docs/sdks/customers/README.md#list) - List Customers

* [Retrieve](docs/sdks/customers/README.md#retrieve) - Retrieve Customers

#### [Ecommerce.Fulfillments](docs/sdks/fulfillments/README.md)

* [List](docs/sdks/fulfillments/README.md#list) - List Fulfillments

* [Retrieve](docs/sdks/fulfillments/README.md#retrieve) - Retrieve Fulfillments

#### [Ecommerce.Orders](docs/sdks/orders/README.md)

* [List](docs/sdks/orders/README.md#list) - List Orders

* [Create](docs/sdks/orders/README.md#create) - Create Orders

* [Retrieve](docs/sdks/orders/README.md#retrieve) - Retrieve Orders

#### [Ecommerce.Products](docs/sdks/products/README.md)

* [List](docs/sdks/products/README.md#list) - List Products

* [Create](docs/sdks/products/README.md#create) - Create Products

* [Retrieve](docs/sdks/products/README.md#retrieve) - Retrieve Products

### [Events](docs/sdks/events/README.md)

* [GetPanoraCoreEvents](docs/sdks/events/README.md#getpanoracoreevents) - List Events

### [FieldMappings](docs/sdks/fieldmappings/README.md)

* [GetFieldMappingValues](docs/sdks/fieldmappings/README.md#getfieldmappingvalues) - Retrieve field mappings values

* [GetFieldMappingsEntities](docs/sdks/fieldmappings/README.md#getfieldmappingsentities) - Retrieve field mapping entities

* [GetFieldMappings](docs/sdks/fieldmappings/README.md#getfieldmappings) - Retrieve field mappings

* [Definitions](docs/sdks/fieldmappings/README.md#definitions) - Define target Field

* [DefineCustomField](docs/sdks/fieldmappings/README.md#definecustomfield) - Create Custom Field

* [Map](docs/sdks/fieldmappings/README.md#map) - Map Custom Field

### [Filestorage](docs/sdks/filestorage/README.md)

#### [Filestorage.Files](docs/sdks/files/README.md)

* [List](docs/sdks/files/README.md#list) - List  Files

* [Create](docs/sdks/files/README.md#create) - Create Files

* [Retrieve](docs/sdks/files/README.md#retrieve) - Retrieve Files

#### [Filestorage.Folders](docs/sdks/folders/README.md)

* [List](docs/sdks/folders/README.md#list) - List  Folders

* [Create](docs/sdks/folders/README.md#create) - Create Folders

* [Retrieve](docs/sdks/folders/README.md#retrieve) - Retrieve Folders

#### [Filestorage.Groups](docs/sdks/groups/README.md)

* [List](docs/sdks/groups/README.md#list) - List  Groups

* [Retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve Groups

#### [Filestorage.Users](docs/sdks/panorafilestorageusers/README.md)

* [List](docs/sdks/panorafilestorageusers/README.md#list) - List Users

* [Retrieve](docs/sdks/panorafilestorageusers/README.md#retrieve) - Retrieve Users

### [LinkedUsers](docs/sdks/linkedusers/README.md)

* [RemoteID](docs/sdks/linkedusers/README.md#remoteid) - Retrieve a Linked User From A Remote Id

* [Create](docs/sdks/linkedusers/README.md#create) - Create Linked Users

* [List](docs/sdks/linkedusers/README.md#list) - List Linked Users

* [ImportBatch](docs/sdks/linkedusers/README.md#importbatch) - Add Batch Linked Users

* [Retrieve](docs/sdks/linkedusers/README.md#retrieve) - Retrieve Linked Users

### [Marketingautomation](docs/sdks/marketingautomation/README.md)

#### [Marketingautomation.Actions](docs/sdks/actions/README.md)

* [List](docs/sdks/actions/README.md#list) - List Actions

* [Create](docs/sdks/actions/README.md#create) - Create Action

* [Retrieve](docs/sdks/actions/README.md#retrieve) - Retrieve Actions

#### [Marketingautomation.Automations](docs/sdks/automations/README.md)

* [List](docs/sdks/automations/README.md#list) - List Automations

* [Create](docs/sdks/automations/README.md#create) - Create Automation

* [Retrieve](docs/sdks/automations/README.md#retrieve) - Retrieve Automation

#### [Marketingautomation.Campaigns](docs/sdks/campaigns/README.md)

* [List](docs/sdks/campaigns/README.md#list) - List Campaigns

* [Create](docs/sdks/campaigns/README.md#create) - Create Campaign

* [Retrieve](docs/sdks/campaigns/README.md#retrieve) - Retrieve Campaign

#### [Marketingautomation.Contacts](docs/sdks/panoramarketingautomationcontacts/README.md)

* [List](docs/sdks/panoramarketingautomationcontacts/README.md#list) - List  Contacts

* [Create](docs/sdks/panoramarketingautomationcontacts/README.md#create) - Create Contact

* [Retrieve](docs/sdks/panoramarketingautomationcontacts/README.md#retrieve) - Retrieve Contacts

#### [Marketingautomation.Emails](docs/sdks/emails/README.md)

* [List](docs/sdks/emails/README.md#list) - List Emails

* [Retrieve](docs/sdks/emails/README.md#retrieve) - Retrieve Email

#### [Marketingautomation.Events](docs/sdks/panoraevents/README.md)

* [List](docs/sdks/panoraevents/README.md#list) - List Events

* [Retrieve](docs/sdks/panoraevents/README.md#retrieve) - Retrieve Event

#### [Marketingautomation.Lists](docs/sdks/lists/README.md)

* [List](docs/sdks/lists/README.md#list) - List Lists

* [Create](docs/sdks/lists/README.md#create) - Create Lists

* [Retrieve](docs/sdks/lists/README.md#retrieve) - Retrieve List

#### [Marketingautomation.Messages](docs/sdks/messages/README.md)

* [List](docs/sdks/messages/README.md#list) - List Messages

* [Retrieve](docs/sdks/messages/README.md#retrieve) - Retrieve Messages

#### [Marketingautomation.Templates](docs/sdks/templates/README.md)

* [List](docs/sdks/templates/README.md#list) - List Templates

* [Create](docs/sdks/templates/README.md#create) - Create Template

* [Retrieve](docs/sdks/templates/README.md#retrieve) - Retrieve Template

#### [Marketingautomation.Users](docs/sdks/panoramarketingautomationusers/README.md)

* [List](docs/sdks/panoramarketingautomationusers/README.md#list) - List  Users

* [Retrieve](docs/sdks/panoramarketingautomationusers/README.md#retrieve) - Retrieve Users

### [Panora SDK](docs/sdks/panora/README.md)

* [Hello](docs/sdks/panora/README.md#hello)

* [Health](docs/sdks/panora/README.md#health)

### [Passthrough](docs/sdks/passthrough/README.md)

* [Request](docs/sdks/passthrough/README.md#request) - Make a passthrough request

#### [Passthrough.{retryid}](docs/sdks/retryid/README.md)

* [GetRetriedRequestResponse](docs/sdks/retryid/README.md#getretriedrequestresponse) - Retrieve response of a failed passthrough request due to rate limits

### [Projects](docs/sdks/projects/README.md)

* [GetProjects](docs/sdks/projects/README.md#getprojects) - Retrieve projects

* [Create](docs/sdks/projects/README.md#create) - Create a project

### [Rag](docs/sdks/rag/README.md)

* [Query](docs/sdks/rag/README.md#query) - Query using RAG Search

### [Sync](docs/sdks/sync/README.md)

* [Status](docs/sdks/sync/README.md#status) - Retrieve sync status of a certain vertical

* [Resync](docs/sdks/sync/README.md#resync) - Resync common objects across a vertical

* [UpdatePullFrequency](docs/sdks/sync/README.md#updatepullfrequency) - Update pull frequency for verticals

* [GetPullFrequency](docs/sdks/sync/README.md#getpullfrequency) - Get pull frequency for verticals

### [Ticketing](docs/sdks/ticketing/README.md)

#### [Ticketing.Accounts](docs/sdks/accounts/README.md)

* [List](docs/sdks/accounts/README.md#list) - List  Accounts

* [Retrieve](docs/sdks/accounts/README.md#retrieve) - Retrieve Accounts

#### [Ticketing.Attachments](docs/sdks/panoraattachments/README.md)

* [List](docs/sdks/panoraattachments/README.md#list) - List  Attachments

* [Create](docs/sdks/panoraattachments/README.md#create) - Create Attachments

* [Retrieve](docs/sdks/panoraattachments/README.md#retrieve) - Retrieve Attachments

#### [Ticketing.Collections](docs/sdks/collections/README.md)

* [List](docs/sdks/collections/README.md#list) - List Collections

* [Retrieve](docs/sdks/collections/README.md#retrieve) - Retrieve Collections

#### [Ticketing.Comments](docs/sdks/comments/README.md)

* [List](docs/sdks/comments/README.md#list) - List Comments

* [Create](docs/sdks/comments/README.md#create) - Create Comments

* [Retrieve](docs/sdks/comments/README.md#retrieve) - Retrieve Comment

#### [Ticketing.Contacts](docs/sdks/contacts/README.md)

* [List](docs/sdks/contacts/README.md#list) - List Contacts

* [Retrieve](docs/sdks/contacts/README.md#retrieve) - Retrieve Contact

#### [Ticketing.Tags](docs/sdks/tags/README.md)

* [List](docs/sdks/tags/README.md#list) - List Tags

* [Retrieve](docs/sdks/tags/README.md#retrieve) - Retrieve Tag

#### [Ticketing.Teams](docs/sdks/teams/README.md)

* [List](docs/sdks/teams/README.md#list) - List  Teams

* [Retrieve](docs/sdks/teams/README.md#retrieve) - Retrieve Teams

#### [Ticketing.Tickets](docs/sdks/tickets/README.md)

* [List](docs/sdks/tickets/README.md#list) - List  Tickets

* [Create](docs/sdks/tickets/README.md#create) - Create Tickets

* [Retrieve](docs/sdks/tickets/README.md#retrieve) - Retrieve Tickets

#### [Ticketing.Users](docs/sdks/users/README.md)

* [List](docs/sdks/users/README.md#list) - List Users

* [Retrieve](docs/sdks/users/README.md#retrieve) - Retrieve User

### [Webhooks](docs/sdks/webhooks/README.md)

* [List](docs/sdks/webhooks/README.md#list) - List webhooks

* [Create](docs/sdks/webhooks/README.md#create) - Create webhook

* [Delete](docs/sdks/webhooks/README.md#delete) - Delete Webhook

* [UpdateStatus](docs/sdks/webhooks/README.md#updatestatus) - Update webhook status

* [VerifyEvent](docs/sdks/webhooks/README.md#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:

```go

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(""),

	)

	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:

```go

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(""),

	)

	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

```go

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(""),

	)

	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

```go

package main

import (

	"context"

	gosdk "github.com/panoratech/go-sdk"

	"log"

)

func main() {

	s := gosdk.New(

		gosdk.WithServerIndex(2),

		gosdk.WithSecurity(""),

	)

	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:

```go

package main

import (

	"context"

	gosdk "github.com/panoratech/go-sdk"

	"log"

)

func main() {

	s := gosdk.New(

		gosdk.WithServerURL("https://api.panora.dev"),

		gosdk.WithSecurity(""),

	)

	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:

```go

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.

```go

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:

```go

package main

import (

	"context"

	gosdk "github.com/panoratech/go-sdk"

	"log"

)

func main() {

	s := gosdk.New(

		gosdk.WithSecurity(""),

	)

	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:

```go

package main

import (

	"context"

	gosdk "github.com/panoratech/go-sdk"

	"log"

)

func main() {

	s := gosdk.New(

		gosdk.WithSecurity(""),

	)

	ctx := context.Background()

	res, err := s.Filestorage.Files.List(ctx, "", 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. 

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

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/panoratech/go-sdk

Awesome Lists containing this project

README
