Skip to content

Latest commit

 

History

History
301 lines (225 loc) · 14.1 KB

README.md

File metadata and controls

301 lines (225 loc) · 14.1 KB

Clients

(Oauth2.Clients)

Overview

Available Operations

List

List OAuth2 clients.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Oauth2.Clients.List(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceOAuth2Client != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
page *int64 ➖ Page number, defaults to 1.
limit *int64 ➖ Size of a page, defaults to 10. Maximum is 100.
opts []operations.Option ➖ The options for this request.

Response

*operations.Oauth2ClientsListResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Create

Create an OAuth2 client.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Oauth2.Clients.Create(ctx, components.OAuth2ClientConfiguration{
        RedirectUris: []string{
            "https://inferior-chainstay.com",
        },
        ClientName: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Any != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.OAuth2ClientConfiguration ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.Oauth2ClientsOauth2CreateClientResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Get

Get an OAuth2 client by Client ID.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Oauth2.Clients.Get(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Any != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientID string ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.Oauth2ClientsOauth2GetClientResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Update

Update an OAuth2 client.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Oauth2.Clients.Update(ctx, "<id>", components.OAuth2ClientConfigurationUpdate{
        RedirectUris: []string{
            "https://grown-worth.name",
            "https://worthwhile-avalanche.org/",
            "https://general-digit.com/",
        },
        ClientName: "<value>",
        ClientID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Any != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientID string ✔️ N/A
oAuth2ClientConfigurationUpdate components.OAuth2ClientConfigurationUpdate ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.Oauth2ClientsOauth2UpdateClientResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Delete

Delete an OAuth2 client.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Oauth2.Clients.Delete(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Any != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientID string ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.Oauth2ClientsOauth2DeleteClientResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*