\WebhooksAPI

All URIs are relative to https://api-v2.fattureincloud.it

Method	HTTP request	Description
CreateWebhooksSubscription	Post /c/{company_id}/subscriptions	Create a Webhook Subscription
DeleteWebhooksSubscription	Delete /c/{company_id}/subscriptions/{subscription_id}	Delete Webhooks Subscription
GetWebhooksSubscription	Get /c/{company_id}/subscriptions/{subscription_id}	Get Webhooks Subscription
ListWebhooksSubscriptions	Get /c/{company_id}/subscriptions	List Webhooks Subscriptions
ModifyWebhooksSubscription	Put /c/{company_id}/subscriptions/{subscription_id}	Modify Webhooks Subscription
VerifyWebhooksSubscription	Post /c/{company_id}/subscriptions/{subscription_id}/verify	Verify Webhooks Subscription

CreateWebhooksSubscription

CreateWebhooksSubscriptionResponse CreateWebhooksSubscription(ctx, companyId).CreateWebhooksSubscriptionRequest(createWebhooksSubscriptionRequest).Execute()

Create a Webhook Subscription

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	createWebhooksSubscriptionRequest := *fattureincloud.NewCreateWebhooksSubscriptionRequest() // CreateWebhooksSubscriptionRequest |  (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.CreateWebhooksSubscription(auth, companyId).CreateWebhooksSubscriptionRequest(createWebhooksSubscriptionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.CreateWebhooksSubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateWebhooksSubscription`: CreateWebhooksSubscriptionResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.

Other Parameters

Other parameters are passed through a pointer to a apiCreateWebhooksSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes

createWebhooksSubscriptionRequest | CreateWebhooksSubscriptionRequest | |

Return type

CreateWebhooksSubscriptionResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteWebhooksSubscription

DeleteWebhooksSubscription(ctx, companyId, subscriptionId).Execute()

Delete Webhooks Subscription

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	subscriptionId := "SUB123" // string | The ID of the subscription.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.DeleteWebhooksSubscription(auth, companyId, subscriptionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.DeleteWebhooksSubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.
subscriptionId	string	The ID of the subscription.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteWebhooksSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWebhooksSubscription

GetWebhooksSubscriptionResponse GetWebhooksSubscription(ctx, companyId, subscriptionId).Execute()

Get Webhooks Subscription

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	subscriptionId := "SUB123" // string | The ID of the subscription.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetWebhooksSubscription(auth, companyId, subscriptionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetWebhooksSubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetWebhooksSubscription`: GetWebhooksSubscriptionResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.
subscriptionId	string	The ID of the subscription.

Other Parameters

Other parameters are passed through a pointer to a apiGetWebhooksSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetWebhooksSubscriptionResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListWebhooksSubscriptions

ListWebhooksSubscriptionsResponse ListWebhooksSubscriptions(ctx, companyId).Execute()

List Webhooks Subscriptions

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.ListWebhooksSubscriptions(auth, companyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.ListWebhooksSubscriptions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListWebhooksSubscriptions`: ListWebhooksSubscriptionsResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.

Other Parameters

Other parameters are passed through a pointer to a apiListWebhooksSubscriptionsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListWebhooksSubscriptionsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyWebhooksSubscription

ModifyWebhooksSubscriptionResponse ModifyWebhooksSubscription(ctx, companyId, subscriptionId).ModifyWebhooksSubscriptionRequest(modifyWebhooksSubscriptionRequest).Execute()

Modify Webhooks Subscription

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	subscriptionId := "SUB123" // string | The ID of the subscription.
	modifyWebhooksSubscriptionRequest := *fattureincloud.NewModifyWebhooksSubscriptionRequest() // ModifyWebhooksSubscriptionRequest |  (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.ModifyWebhooksSubscription(auth, companyId, subscriptionId).ModifyWebhooksSubscriptionRequest(modifyWebhooksSubscriptionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.ModifyWebhooksSubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ModifyWebhooksSubscription`: ModifyWebhooksSubscriptionResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.
subscriptionId	string	The ID of the subscription.

Other Parameters

Other parameters are passed through a pointer to a apiModifyWebhooksSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes

modifyWebhooksSubscriptionRequest | ModifyWebhooksSubscriptionRequest | |

Return type

ModifyWebhooksSubscriptionResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VerifyWebhooksSubscription

VerifyWebhooksSubscription(ctx, companyId, subscriptionId).VerifyWebhooksSubscriptionRequest(verifyWebhooksSubscriptionRequest).Execute()

Verify Webhooks Subscription

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	subscriptionId := "SUB123" // string | The ID of the subscription.
	verifyWebhooksSubscriptionRequest := *fattureincloud.NewVerifyWebhooksSubscriptionRequest() // VerifyWebhooksSubscriptionRequest |  (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.VerifyWebhooksSubscription(auth, companyId, subscriptionId).VerifyWebhooksSubscriptionRequest(verifyWebhooksSubscriptionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.VerifyWebhooksSubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId	int32	The ID of the company.
subscriptionId	string	The ID of the subscription.

Other Parameters

Other parameters are passed through a pointer to a apiVerifyWebhooksSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes

verifyWebhooksSubscriptionRequest | VerifyWebhooksSubscriptionRequest | |

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

WebhooksAPI.md

Latest commit

History

WebhooksAPI.md

File metadata and controls

\WebhooksAPI

CreateWebhooksSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteWebhooksSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetWebhooksSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListWebhooksSubscriptions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ModifyWebhooksSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VerifyWebhooksSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers