Skip to content

Latest commit

 

History

History
1028 lines (646 loc) · 26.2 KB

WebhooksAPI.md

File metadata and controls

1028 lines (646 loc) · 26.2 KB

\WebhooksAPI

All URIs are relative to https://api.dofusdu.de

Method HTTP request Description
DeleteWebhooksAlmanaxId Delete /webhooks/almanax/{id} Unregister Almanax Hook
DeleteWebhooksRssId Delete /webhooks/rss/{id} Unregister RSS Hook
DeleteWebhooksTwitterId Delete /webhooks/twitter/{id} Unregister Twitter Hook
GetMetaWebhooksAlmanax Get /meta/webhooks/almanax Get Almanax Hook Metainfo
GetMetaWebhooksRss Get /meta/webhooks/rss Get RSS Hook Metainfo
GetMetaWebhooksTwitter Get /meta/webhooks/twitter Get Twitter Hook Metainfo
GetWebhooksAlmanaxId Get /webhooks/almanax/{id} Get Almanax Hook
GetWebhooksRssId Get /webhooks/rss/{id} Get RSS Hook
GetWebhooksTwitterId Get /webhooks/twitter/{id} Get Twitter Hook
PostWebhooksAlmanax Post /webhooks/almanax Register Almanax Hook
PostWebhooksRss Post /webhooks/rss Register RSS Hook
PostWebhooksTwitter Post /webhooks/twitter Register Twitter Hook
PutWebhooksAlmanaxId Put /webhooks/almanax/{id} Update Almanax Hook
PutWebhooksRssId Put /webhooks/rss/{id} Update RSS Hook
PutWebhooksTwitterId Put /webhooks/twitter/{id} Update Twitter Hook

DeleteWebhooksAlmanaxId

DeleteWebhooksAlmanaxId(ctx, id).Execute()

Unregister Almanax Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.DeleteWebhooksAlmanaxId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.DeleteWebhooksAlmanaxId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteWebhooksRssId

DeleteWebhooksRssId(ctx, id).Execute()

Unregister RSS Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.DeleteWebhooksRssId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.DeleteWebhooksRssId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteWebhooksTwitterId

DeleteWebhooksTwitterId(ctx, id).Execute()

Unregister Twitter Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.DeleteWebhooksTwitterId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.DeleteWebhooksTwitterId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetMetaWebhooksAlmanax

GetMetaWebhooksTwitter200Response GetMetaWebhooksAlmanax(ctx).Execute()

Get Almanax Hook Metainfo

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetMetaWebhooksAlmanax(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetMetaWebhooksAlmanax``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetaWebhooksAlmanax`: GetMetaWebhooksTwitter200Response
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetMetaWebhooksAlmanax`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetMetaWebhooksTwitter200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetMetaWebhooksRss

GetMetaWebhooksTwitter200Response GetMetaWebhooksRss(ctx).Execute()

Get RSS Hook Metainfo

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetMetaWebhooksRss(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetMetaWebhooksRss``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetaWebhooksRss`: GetMetaWebhooksTwitter200Response
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetMetaWebhooksRss`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetMetaWebhooksTwitter200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetMetaWebhooksTwitter

GetMetaWebhooksTwitter200Response GetMetaWebhooksTwitter(ctx).Execute()

Get Twitter Hook Metainfo

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetMetaWebhooksTwitter(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetMetaWebhooksTwitter``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetaWebhooksTwitter`: GetMetaWebhooksTwitter200Response
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetMetaWebhooksTwitter`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetMetaWebhooksTwitter200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetWebhooksAlmanaxId

AlmanaxWebhook GetWebhooksAlmanaxId(ctx, id).Execute()

Get Almanax Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetWebhooksAlmanaxId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetWebhooksAlmanaxId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetWebhooksAlmanaxId`: AlmanaxWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetWebhooksAlmanaxId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

AlmanaxWebhook

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetWebhooksRssId

RssWebhook GetWebhooksRssId(ctx, id).Execute()

Get RSS Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetWebhooksRssId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetWebhooksRssId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetWebhooksRssId`: RssWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetWebhooksRssId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

RssWebhook

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetWebhooksTwitterId

TwitterWebhook GetWebhooksTwitterId(ctx, id).Execute()

Get Twitter Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.GetWebhooksTwitterId(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.GetWebhooksTwitterId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetWebhooksTwitterId`: TwitterWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.GetWebhooksTwitterId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

Return type

TwitterWebhook

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

PostWebhooksAlmanax

PostWebhooksAlmanax(ctx).CreateAlmanaxWebhook(createAlmanaxWebhook).Execute()

Register Almanax Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	createAlmanaxWebhook := *openapiclient.NewCreateAlmanaxWebhook([]string{"Subscriptions_example"}, "Format_example", "https://discord.com/api/webhooks/XYZ", []string{"Intervals_example"}) // CreateAlmanaxWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.PostWebhooksAlmanax(context.Background()).CreateAlmanaxWebhook(createAlmanaxWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PostWebhooksAlmanax``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createAlmanaxWebhook CreateAlmanaxWebhook

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

PostWebhooksRss

PostWebhooksRss(ctx).CreateRSSWebhook(createRSSWebhook).Execute()

Register RSS Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	createRSSWebhook := *openapiclient.NewCreateRSSWebhook([]string{"Subscriptions_example"}, "Format_example", "https://discord.com/api/webhooks/XYZ") // CreateRSSWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.PostWebhooksRss(context.Background()).CreateRSSWebhook(createRSSWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PostWebhooksRss``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createRSSWebhook CreateRSSWebhook

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

PostWebhooksTwitter

PostWebhooksTwitter(ctx).CreateTwitterWebhook(createTwitterWebhook).Execute()

Register Twitter Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	createTwitterWebhook := *openapiclient.NewCreateTwitterWebhook([]string{"Subscriptions_example"}, "Format_example", "https://discord.com/api/webhooks/XYZ") // CreateTwitterWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.WebhooksAPI.PostWebhooksTwitter(context.Background()).CreateTwitterWebhook(createTwitterWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PostWebhooksTwitter``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createTwitterWebhook CreateTwitterWebhook

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

PutWebhooksAlmanaxId

AlmanaxWebhook PutWebhooksAlmanaxId(ctx, id).PutAlmanaxWebhook(putAlmanaxWebhook).Execute()

Update Almanax Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook
	putAlmanaxWebhook := *openapiclient.NewPutAlmanaxWebhook() // PutAlmanaxWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.PutWebhooksAlmanaxId(context.Background(), id).PutAlmanaxWebhook(putAlmanaxWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PutWebhooksAlmanaxId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutWebhooksAlmanaxId`: AlmanaxWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.PutWebhooksAlmanaxId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

putAlmanaxWebhook | PutAlmanaxWebhook | |

Return type

AlmanaxWebhook

Authorization

No authorization required

HTTP request headers

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

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

PutWebhooksRssId

RssWebhook PutWebhooksRssId(ctx, id).PutRSSWebhook(putRSSWebhook).Execute()

Update RSS Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook
	putRSSWebhook := *openapiclient.NewPutRSSWebhook() // PutRSSWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.PutWebhooksRssId(context.Background(), id).PutRSSWebhook(putRSSWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PutWebhooksRssId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutWebhooksRssId`: RssWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.PutWebhooksRssId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

putRSSWebhook | PutRSSWebhook | |

Return type

RssWebhook

Authorization

No authorization required

HTTP request headers

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

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

PutWebhooksTwitterId

TwitterWebhook PutWebhooksTwitterId(ctx, id).PutTwitterWebhook(putTwitterWebhook).Execute()

Update Twitter Hook

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/dofusdude/dodugo"
)

func main() {
	id := "id_example" // string | the ID returned from the API when creating the webhook
	putTwitterWebhook := *openapiclient.NewPutTwitterWebhook() // PutTwitterWebhook |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.WebhooksAPI.PutWebhooksTwitterId(context.Background(), id).PutTwitterWebhook(putTwitterWebhook).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `WebhooksAPI.PutWebhooksTwitterId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutWebhooksTwitterId`: TwitterWebhook
	fmt.Fprintf(os.Stdout, "Response from `WebhooksAPI.PutWebhooksTwitterId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string the ID returned from the API when creating the webhook

Other Parameters

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

Name Type Description Notes

putTwitterWebhook | PutTwitterWebhook | |

Return type

TwitterWebhook

Authorization

No authorization required

HTTP request headers

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

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