Class SeamHttpSeamPartnerV1Resources

constructor

• new SeamHttpSeamPartnerV1Resources(apiKeyOrOptions?): SeamHttpSeamPartnerV1Resources

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamPartnerV1Resources

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

list

• list(params?): SeamHttpRequest<SetNonNullable<Required<{
      partner_resources: {
          custom_metadata?: Record<string, string>;
          customer_key: string;
          description?: string;
          email_address?: string;
          ends_at?: string;
          location_keys?: string[];
          name?: string;
          partner_resource_key: string;
          partner_resource_type: string;
          phone_number?: string;
          starts_at?: string;
          user_identity_key?: string;
      }[];
  }>, "partner_resources">, "partner_resources">

• Parameters

  • Optionalparams: {
        resource_type_alias?: string;
    }

    • Optionalresource_type_alias?: string

      Resource type alias by which you want to filter partner resources.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      partner_resources: {
          custom_metadata?: Record<string, string>;
          customer_key: string;
          description?: string;
          email_address?: string;
          ends_at?: string;
          location_keys?: string[];
          name?: string;
          partner_resource_key: string;
          partner_resource_type: string;
          phone_number?: string;
          starts_at?: string;
          user_identity_key?: string;
      }[];
  }>, "partner_resources">, "partner_resources">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamPartnerV1Resources

• Parameters

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

  Returns SeamHttpSeamPartnerV1Resources

StaticfromClient

• fromClient(client, options?): SeamHttpSeamPartnerV1Resources

• Parameters

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

  Returns SeamHttpSeamPartnerV1Resources

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamPartnerV1Resources

• Parameters

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

  Returns SeamHttpSeamPartnerV1Resources

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamPartnerV1Resources

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamPartnerV1Resources

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamPartnerV1Resources>