Class SeamHttpWorkspacesCustomizationProfiles

constructor

• new SeamHttpWorkspacesCustomizationProfiles(apiKeyOrOptions?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(parameters?, options?): WorkspacesCustomizationProfilesCreateRequest

• Parameters

  • Optionalparameters: {
        name?: null | string;
        primary_color: string;
        secondary_color: string;
    }

    • Optionalname?: null | string

    • primary_color: string

    • secondary_color: string

  • options: WorkspacesCustomizationProfilesCreateOptions = {}

  Returns WorkspacesCustomizationProfilesCreateRequest

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(parameters?, options?): WorkspacesCustomizationProfilesGetRequest

• Parameters

  • Optionalparameters: {
        customization_profile_id: string;
    }

    • customization_profile_id: string

  • options: WorkspacesCustomizationProfilesGetOptions = {}

  Returns WorkspacesCustomizationProfilesGetRequest

list

• list(parameters?, options?): WorkspacesCustomizationProfilesListRequest

• Parameters

  • Optionalparameters: {
        customer_key?: string;
    }

    • Optionalcustomer_key?: string

      Customer key for which you want to list customization profiles.
  • options: WorkspacesCustomizationProfilesListOptions = {}

  Returns WorkspacesCustomizationProfilesListRequest

update

• update(parameters?, options?): WorkspacesCustomizationProfilesUpdateRequest

• Parameters

  • Optionalparameters: {
        customization_profile_id: string;
        name?: null | string;
        primary_color?: string;
        secondary_color?: string;
    }

    • customization_profile_id: string

    • Optionalname?: null | string

    • Optionalprimary_color?: string

    • Optionalsecondary_color?: string

  • options: WorkspacesCustomizationProfilesUpdateOptions = {}

  Returns WorkspacesCustomizationProfilesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

uploadImages

• uploadImages(parameters?, options?): WorkspacesCustomizationProfilesUploadImagesRequest

• Parameters

  • Optionalparameters: {}
  • options: WorkspacesCustomizationProfilesUploadImagesOptions = {}

  Returns WorkspacesCustomizationProfilesUploadImagesRequest

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromClient

• fromClient(client, options?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpWorkspacesCustomizationProfiles

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpWorkspacesCustomizationProfiles>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpWorkspacesCustomizationProfiles>