Class SeamHttpWorkspacesCustomizationProfiles

constructor

• new SeamHttpWorkspacesCustomizationProfiles(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWorkspacesCustomizationProfiles

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: {
          customer_portal_theme?: {
              primary_color?: string;
              primary_foreground_color?: string;
              secondary_color?: string;
              secondary_foreground_color?: string;
          };
          name?: string
          | null;
          primary_color?: string;
          secondary_color?: string;
      },
      options?: WorkspacesCustomizationProfilesCreateOptions,
  ): WorkspacesCustomizationProfilesCreateRequest

  Parameters

  • Optionalparameters: {
        customer_portal_theme?: {
            primary_color?: string;
            primary_foreground_color?: string;
            secondary_color?: string;
            secondary_foreground_color?: string;
        };
        name?: string
        | null;
        primary_color?: string;
        secondary_color?: string;
    }
  • options: WorkspacesCustomizationProfilesCreateOptions = {}

  Returns WorkspacesCustomizationProfilesCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): 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?: { customization_profile_id: string },
      options?: WorkspacesCustomizationProfilesGetOptions,
  ): WorkspacesCustomizationProfilesGetRequest

  Parameters

  • Optionalparameters: { customization_profile_id: string }
  • options: WorkspacesCustomizationProfilesGetOptions = {}

  Returns WorkspacesCustomizationProfilesGetRequest

list

• list(
      parameters?: { customer_key?: string },
      options?: WorkspacesCustomizationProfilesListOptions,
  ): 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?: {
          customer_portal_theme?:
              | {
                  primary_color?: string;
                  primary_foreground_color?: string;
                  secondary_color?: string;
                  secondary_foreground_color?: string;
              }
              | null;
          customization_profile_id: string;
          name?: string
          | null;
          primary_color?: string;
          secondary_color?: string;
      },
      options?: WorkspacesCustomizationProfilesUpdateOptions,
  ): WorkspacesCustomizationProfilesUpdateRequest

  Parameters

  • Optionalparameters: {
        customer_portal_theme?:
            | {
                primary_color?: string;
                primary_foreground_color?: string;
                secondary_color?: string;
                secondary_foreground_color?: string;
            }
            | null;
        customization_profile_id: string;
        name?: string
        | null;
        primary_color?: string;
        secondary_color?: string;
    }
  • options: WorkspacesCustomizationProfilesUpdateOptions = {}

  Returns WorkspacesCustomizationProfilesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

uploadImages

• uploadImages(
      parameters?: {},
      options?: WorkspacesCustomizationProfilesUploadImagesOptions,
  ): WorkspacesCustomizationProfilesUploadImagesRequest

  Parameters

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

  Returns WorkspacesCustomizationProfilesUploadImagesRequest

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

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

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

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

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

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

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

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

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpWorkspacesCustomizationProfiles

  Parameters

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

  Returns SeamHttpWorkspacesCustomizationProfiles

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpWorkspacesCustomizationProfiles>