Skip to content

Latest commit

 

History

History
359 lines (227 loc) · 9.83 KB

CustomisationProfilesApi.md

File metadata and controls

359 lines (227 loc) · 9.83 KB
Raw

\CustomisationProfilesApi

All URIs are relative to https://webform-sandbox.finapi.io

Method HTTP request Description
CreateProfile Post /api/profiles Create a profile
DeleteProfile Delete /api/profiles/{id} Delete a profile
EditProfile Patch /api/profiles/{id} Edit a profile
GetProfile Get /api/profiles/{id} Get a profile
GetProfiles Get /api/profiles Get profiles

CreateProfile

Profile CreateProfile(ctx).CreateProfileDetails(createProfileDetails).Execute()

Create a profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    createProfileDetails := *openapiclient.NewCreateProfileDetails("Mobile application label") // CreateProfileDetails | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createProfileDetails CreateProfileDetails

Return type

Profile

Authorization

BearerAccessToken

HTTP request headers

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

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

DeleteProfile

DeleteProfile(ctx, id).Execute()

Delete a profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Identifier of the profile

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomisationProfilesApi.DeleteProfile(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomisationProfilesApi.DeleteProfile``: %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 Identifier of the profile

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAccessToken

HTTP request headers

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

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

EditProfile

Profile EditProfile(ctx, id).EditProfileDetails(editProfileDetails).Execute()

Edit a profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Identifier of the profile
    editProfileDetails := *openapiclient.NewEditProfileDetails() // EditProfileDetails | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the profile

Other Parameters

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

Name Type Description Notes

editProfileDetails | EditProfileDetails | |

Return type

Profile

Authorization

BearerAccessToken

HTTP request headers

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

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

GetProfile

Profile GetProfile(ctx, id).Execute()

Get a profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | Identifier of the profile

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of the profile

Other Parameters

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

Name Type Description Notes

Return type

Profile

Authorization

BearerAccessToken

HTTP request headers

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

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

GetProfiles

ProfilesPage GetProfiles(ctx).Order(order).Page(page).PerPage(perPage).Execute()

Get profiles

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    order := "createdAt,desc" // string | Determines the order of the results. You can order by <code>createdAt</code> field ascending or descending. The general format is <code>property[,asc|desc]</code>, with <code>asc</code> being the default value.The default order is <code>createdAt,asc</code>. (optional)
    page := int32(1) // int32 | Page to load (optional) (default to 1)
    perPage := int32(20) // int32 | The number of items on the page (optional) (default to 20)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomisationProfilesApi.GetProfiles(context.Background()).Order(order).Page(page).PerPage(perPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomisationProfilesApi.GetProfiles``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetProfiles`: ProfilesPage
    fmt.Fprintf(os.Stdout, "Response from `CustomisationProfilesApi.GetProfiles`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
order string Determines the order of the results. You can order by <code>createdAt</code> field ascending or descending. The general format is <code>property[,asc desc]</code>, with <code>asc</code> being the default value.The default order is <code>createdAt,asc</code>.
page int32 Page to load [default to 1]
perPage int32 The number of items on the page [default to 20]

Return type

ProfilesPage

Authorization

BearerAccessToken

HTTP request headers

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

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