Skip to content

IntegrationCollectionsAPI.md

Latest commit

 

History

History
432 lines (274 loc) · 13.2 KB

IntegrationCollectionsAPI.md

File metadata and controls

432 lines (274 loc) · 13.2 KB
Raw

\IntegrationCollectionsAPI

All URIs are relative to http://localhost

Method HTTP request Description
CreateCollectionsIntegrations Post /api/v1/integrations/collections IntegrationCollectionController@store
DeleteCollectionsIntegrations Delete /api/v1/integrations/collections/{id} Delete a collection
EditCollectionsIntegrations Patch /api/v1/integrations/collections/{id} Edit a collection
FetchAllCollectionsIntegrations Get /api/v1/integrations/collections IntegrationCollectionController@index
FetchCollectionsIntegrations Get /api/v1/integrations/collections/{id} IntegrationCollectionController@show
UpdateCollectionsIntegrations Put /api/v1/integrations/collections/{id} Update a collection

CreateCollectionsIntegrations

CreateDarIntegration201Response CreateCollectionsIntegrations(ctx).CreateCollectionsIntegrationsRequest(createCollectionsIntegrationsRequest).Execute()

IntegrationCollectionController@store

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	createCollectionsIntegrationsRequest := *openapiclient.NewCreateCollectionsIntegrationsRequest() // CreateCollectionsIntegrationsRequest | Pass user credentials

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createCollectionsIntegrationsRequest CreateCollectionsIntegrationsRequest Pass user credentials

Return type

CreateDarIntegration201Response

Authorization

bearerAuth

HTTP request headers

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

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

DeleteCollectionsIntegrations

DeleteApplications200Response DeleteCollectionsIntegrations(ctx, id).Execute()

Delete a collection

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	id := int32(1) // int32 | collection id

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 collection id

Other Parameters

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

Name Type Description Notes

Return type

DeleteApplications200Response

Authorization

bearerAuth

HTTP request headers

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

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

EditCollectionsIntegrations

FetchCollections200Response EditCollectionsIntegrations(ctx, id).CreateCollectionsIntegrationsRequest(createCollectionsIntegrationsRequest).Execute()

Edit a collection

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	id := int32(1) // int32 | collection id
	createCollectionsIntegrationsRequest := *openapiclient.NewCreateCollectionsIntegrationsRequest() // CreateCollectionsIntegrationsRequest | Pass user credentials

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 collection id

Other Parameters

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

Name Type Description Notes

createCollectionsIntegrationsRequest | CreateCollectionsIntegrationsRequest | Pass user credentials |

Return type

FetchCollections200Response

Authorization

bearerAuth

HTTP request headers

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

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

FetchAllCollectionsIntegrations

FetchAllCollections200Response FetchAllCollectionsIntegrations(ctx).Name(name).PerPage(perPage).Execute()

IntegrationCollectionController@index

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	name := "name_example" // string | Filter collections by name (optional)
	perPage := int32(1) // int32 | per page (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
name string Filter collections by name
perPage int32 per page

Return type

FetchAllCollections200Response

Authorization

bearerAuth

HTTP request headers

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

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

FetchCollectionsIntegrations

FetchCollections200Response FetchCollectionsIntegrations(ctx, id).Execute()

IntegrationCollectionController@show

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	id := int32(1) // int32 | collection id

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 collection id

Other Parameters

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

Name Type Description Notes

Return type

FetchCollections200Response

Authorization

bearerAuth

HTTP request headers

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

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

UpdateCollectionsIntegrations

FetchCollections200Response UpdateCollectionsIntegrations(ctx, id).CreateCollectionsIntegrationsRequest(createCollectionsIntegrationsRequest).Execute()

Update a collection

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)

func main() {
	id := int32(1) // int32 | collection id
	createCollectionsIntegrationsRequest := *openapiclient.NewCreateCollectionsIntegrationsRequest() // CreateCollectionsIntegrationsRequest | Pass user credentials

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 collection id

Other Parameters

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

Name Type Description Notes

createCollectionsIntegrationsRequest | CreateCollectionsIntegrationsRequest | Pass user credentials |

Return type

FetchCollections200Response

Authorization

bearerAuth

HTTP request headers

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

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