Class Organizations

constructor

• new Organizations(api: Api): Organizations

  Parameters

  • api: Api

  Returns Organizations

api

addToOrganization

• addToOrganization(
      organization: string,
      uids: string[],
      type?: MembersType,
  ): Promise<ApiResponse<unknown, unknown>>

  Parameters

  • organization: string
  • uids: string[]
  • type: MembersType = 'users'

  Returns Promise<ApiResponse<unknown, unknown>>

change

• change(id: string): Promise<ApiResponse<unknown, unknown>>

  Parameters

  • id: string

  Returns Promise<ApiResponse<unknown, unknown>>

changeOrganizationDetails

• changeOrganizationDetails(
      organizationId: string,
      data: Partial<OrganizationRequestData>,
  ): Promise<ApiResponse<void, void>>

  Parameters

  • organizationId: string
  • data: Partial<OrganizationRequestData>

  Returns Promise<ApiResponse<void, void>>

changeOrganizationProducts

• changeOrganizationProducts(
      organization: string,
      data: { products: Record<string, ProductTier> },
  ): Promise<ApiResponse<{ checkoutUrl: string }, { checkoutUrl: string }>>

  Parameters

  • organization: string
  • data: { products: Record<string, ProductTier> }

  Returns Promise<ApiResponse<{ checkoutUrl: string }, { checkoutUrl: string }>>

createOrganization

• createOrganization(
      data: OrganizationRequestData,
  ): Promise<ApiResponse<OrganizationData, OrganizationData>>

  Parameters

  • data: OrganizationRequestData

  Returns Promise<ApiResponse<OrganizationData, OrganizationData>>

createOrganizationWithProducts

• createOrganizationWithProducts(
      data?: OrganizationWithProductsData,
  ): Promise<
      ApiResponse<OrganizationCreateResponse, OrganizationCreateResponse>,
  >

  Parameters

  • Optionaldata: OrganizationWithProductsData

  Returns Promise<ApiResponse<OrganizationCreateResponse, OrganizationCreateResponse>>

createPortal

• createPortal(
      organization: string,
  ): Promise<ApiResponse<CreatePortalResponse, CreatePortalResponse>>

  Parameters

  • organization: string

  Returns Promise<ApiResponse<CreatePortalResponse, CreatePortalResponse>>

get

• get(): Promise<ApiResponse<{ data: Organization[] }, { data: Organization[] }>>

  Returns Promise<ApiResponse<{ data: Organization[] }, { data: Organization[] }>>

getAdminOrganizations

• getAdminOrganizations(): Promise<
      ApiResponse<
          UserAdminOrganizationsResponse,
          UserAdminOrganizationsResponse,
      >,
  >

  Returns Promise<
      ApiResponse<
          UserAdminOrganizationsResponse,
          UserAdminOrganizationsResponse,
      >,
  >

getOrganizationAdmins

• getOrganizationAdmins(organizationId: string): Promise<User[]>

  Parameters

  • organizationId: string

  Returns Promise<User[]>

getOrganizationDetails

• getOrganizationDetails(
      organizationId: string,
  ): Promise<ApiResponse<OrganizationData, OrganizationData>>

  Parameters

  • organizationId: string

  Returns Promise<ApiResponse<OrganizationData, OrganizationData>>

getOrganizationMembers

• getOrganizationMembers(organizationId: string): Promise<User[]>

  Parameters

  • organizationId: string

  Returns Promise<User[]>

getOrganizationProducts

• getOrganizationProducts(
      organization: string,
  ): Promise<
      ApiResponse<
          OrganizationProductDataResponse,
          OrganizationProductDataResponse,
      >,
  >

  Parameters

  • organization: string

  Returns Promise<
      ApiResponse<
          OrganizationProductDataResponse,
          OrganizationProductDataResponse,
      >,
  >

getProducts

• getProducts(): Promise<
      ApiResponse<Record<string, Product>, Record<string, Product>>,
  >

  Returns Promise<ApiResponse<Record<string, Product>, Record<string, Product>>>

removeFromOrganization

• removeFromOrganization(
      organization: string,
      type: MembersType,
      indexes: number[],
  ): Promise<ApiResponse<unknown, unknown>>

  Parameters

  • organization: string
  • type: MembersType
  • indexes: number[]

  Returns Promise<ApiResponse<unknown, unknown>>