Class SeamHttpSeamCustomerV1Connectors

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1Connectors

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

authorize

• authorize(
      parameters?: { connector_name?: string; slug: string },
      options?: SeamCustomerV1ConnectorsAuthorizeOptions,
  ): SeamCustomerV1ConnectorsAuthorizeRequest

  Parameters

  • Optionalparameters: { connector_name?: string; slug: string }

    • Optionalconnector_name?: string

      Connector name/type. If not provided, workspace_slug will be used as connector_name

    • slug: string

      Workspace slug

  • options: SeamCustomerV1ConnectorsAuthorizeOptions = {}

  Returns SeamCustomerV1ConnectorsAuthorizeRequest

connectorTypes

• connectorTypes(
      parameters?: {},
      options?: SeamCustomerV1ConnectorsConnectorTypesOptions,
  ): SeamCustomerV1ConnectorsConnectorTypesRequest

  Parameters

  • Optionalparameters: {}
  • options: SeamCustomerV1ConnectorsConnectorTypesOptions = {}

  Returns SeamCustomerV1ConnectorsConnectorTypesRequest

create

• create(
      parameters?: {
          config: { [x: string]: unknown };
          connector_type: "mock" | "mews" | "rms" | "cloudbeds" | "smoobu" | "zonal";
          customer_key?: string;
      },
      options?: SeamCustomerV1ConnectorsCreateOptions,
  ): SeamCustomerV1ConnectorsCreateRequest

  Parameters

  • Optionalparameters: {
        config: { [x: string]: unknown };
        connector_type: "mock" | "mews" | "rms" | "cloudbeds" | "smoobu" | "zonal";
        customer_key?: string;
    }

    • config: { [x: string]: unknown }

      Instance-specific configuration for the connector

    • connector_type: "mock" | "mews" | "rms" | "cloudbeds" | "smoobu" | "zonal"

      Type of connector to create

    • Optionalcustomer_key?: string

      Key identifying the customer

  • options: SeamCustomerV1ConnectorsCreateOptions = {}

  Returns SeamCustomerV1ConnectorsCreateRequest

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>

delete

• delete(
      parameters?: {
          connector_customer_id?: string;
          connector_id: string;
          customer_id?: string;
          customer_key?: string;
          unique_provider_resource_key?: string;
      },
      options?: SeamCustomerV1ConnectorsDeleteOptions,
  ): SeamCustomerV1ConnectorsDeleteRequest

  Parameters

  • Optionalparameters: {
        connector_customer_id?: string;
        connector_id: string;
        customer_id?: string;
        customer_key?: string;
        unique_provider_resource_key?: string;
    }

    • Optionalconnector_customer_id?: string

    • connector_id: string

      ID of the connector to delete

    • Optionalcustomer_id?: string

    • Optionalcustomer_key?: string

    • Optionalunique_provider_resource_key?: string

  • options: SeamCustomerV1ConnectorsDeleteOptions = {}

  Returns SeamCustomerV1ConnectorsDeleteRequest

list

• list(
      parameters?: {},
      options?: SeamCustomerV1ConnectorsListOptions,
  ): SeamCustomerV1ConnectorsListRequest

  Parameters

  • Optionalparameters: {}
  • options: SeamCustomerV1ConnectorsListOptions = {}

  Returns SeamCustomerV1ConnectorsListRequest

sync

• sync(
      parameters?: {
          connector_customer_id: string | null;
          connector_id: string;
          connector_type: string;
          customer_id: string;
          customer_key: string;
          unique_provider_resource_key: string | null;
      },
      options?: SeamCustomerV1ConnectorsSyncOptions,
  ): SeamCustomerV1ConnectorsSyncRequest

  Parameters

  • Optionalparameters: {
        connector_customer_id: string | null;
        connector_id: string;
        connector_type: string;
        customer_id: string;
        customer_key: string;
        unique_provider_resource_key: string | null;
    }

    • connector_customer_id: string | null

      ID of the connector customer to sync

    • connector_id: string

      ID of the connector to sync

    • connector_type: string

      Type of the connector to sync

    • customer_id: string

      ID of the customer to sync

    • customer_key: string

      Key of the customer to sync

    • unique_provider_resource_key: string | null

      Unique provider resource key of the connector to sync

  • options: SeamCustomerV1ConnectorsSyncOptions = {}

  Returns SeamCustomerV1ConnectorsSyncRequest

update

• update(
      parameters?: {
          config:
              | {}
              | {
                  access_token?: string;
                  client?: string;
                  client_token?: string;
                  enterprise_id?: string;
                  enterprise_ids?: string[];
                  is_demo?: boolean;
              }
              | {
                  auth_token?: string;
                  client_id: string;
                  client_password: string;
                  property_id?: string
                  | number;
              }
              | { access_token?: string; property_id?: string; refresh_token?: string }
              | { api_key: string; base_api_url?: string };
          connector_id: string;
          customer_key?: string;
      },
      options?: SeamCustomerV1ConnectorsUpdateOptions,
  ): SeamCustomerV1ConnectorsUpdateRequest

  Parameters

  • Optionalparameters: {
        config:
            | {}
            | {
                access_token?: string;
                client?: string;
                client_token?: string;
                enterprise_id?: string;
                enterprise_ids?: string[];
                is_demo?: boolean;
            }
            | {
                auth_token?: string;
                client_id: string;
                client_password: string;
                property_id?: string
                | number;
            }
            | { access_token?: string; property_id?: string; refresh_token?: string }
            | { api_key: string; base_api_url?: string };
        connector_id: string;
        customer_key?: string;
    }

    • config:
          | {}
          | {
              access_token?: string;
              client?: string;
              client_token?: string;
              enterprise_id?: string;
              enterprise_ids?: string[];
              is_demo?: boolean;
          }
          | {
              auth_token?: string;
              client_id: string;
              client_password: string;
              property_id?: string
              | number;
          }
          | { access_token?: string; property_id?: string; refresh_token?: string }
          | { api_key: string; base_api_url?: string }

      Instance-specific configuration for the connector

    • connector_id: string

      ID of the connector to update

    • Optionalcustomer_key?: string

      Key identifying the customer

  • options: SeamCustomerV1ConnectorsUpdateOptions = {}

  Returns SeamCustomerV1ConnectorsUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Connectors

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Connectors

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Connectors

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Connectors

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Connectors

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1Connectors>