Open Play SDK API başvurusu
    Preparing search index...

    Tipli istemci; browser/oyunda server key değil, client key kullanılır.

    Hierarchy

    • CrxApi
      • CrxClient
    Index

    Constructors

    Properties

    catalog: ServerCatalog

    Katalog okuması (SPEC-0197 S3b): sunucu kitlesi, her satır visibility ve contentRevision ile; koşullu GET (ifNoneMatch → 304).

    createRewardTable: (
        draft: RewardTableDraft,
        options?: RewardRequestOptions,
    ) => Promise<RewardTable>

    Ödül tablosu kaydı (POST /v1/reward-tables, SPEC-0222): yeni sürüm olarak yazar; sunucu anahtarı gerekir.

    Type Declaration

    getRewardTable: (
        key: string,
        options?: RewardRequestOptions,
    ) => Promise<RewardTable>

    Ödül tablosunun güncel sürümünü okur (GET /v1/reward-tables/{key}).

    Type Declaration

    grantRewardTable: (key: string, input: RewardGrantInput) => Promise<RewardGrant>

    Tablodan idempotent ödül verir (POST /v1/reward-tables/{key}/grant); yanıtta çekiliş tohumu yoktur.

    Type Declaration

    Methods

    • POST /v1/clans/{clan_id}/xp: girdi doğrulanır; hata CrxError.

      Parameters

      • input: {
            body: AddClanXpRequest;
            headers: { "Idempotency-Key": string };
            path: { clan_id: string };
        }
      • Optionaloptions: RequestOptions

      Returns Promise<ClanMutationResponse>

    • DELETE /v1/characters/{id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<void>

    • DELETE /v1/rules/{key}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<void>

    • DELETE /v1/webhooks/{id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<void>

    • POST /v1/clans/{clan_id}/treasury/deposit: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>

    • POST /v1/rules/{key}/disable: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<void>

    • POST /v1/clans/{clan_id}/disband: girdi doğrulanır; hata CrxError.

      Parameters

      • input: {
            body: ClanActorRequest;
            headers: { "Idempotency-Key": string };
            path: { clan_id: string };
        }
      • Optionaloptions: RequestOptions

      Returns Promise<ClanMutationResponse>

    • POST /v1/rules/{key}/enable: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<void>

    • POST /v1/characters/{id}/commands: girdi doğrulanır; hata CrxError.

      Parameters

      • input: {
            body: Command;
            headers?: { "Idempotency-Key"?: string; "If-Match"?: string };
            path: { id: string };
        }
      • Optionaloptions: RequestOptions

      Returns Promise<CommandResponse>

    • GET /v1/characters/{id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<CharacterResponse>

    • GET /v1/characters/{id}/state: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { path: { id: string }; query: { at: string } }
      • Optionaloptions: RequestOptions

      Returns Promise<StateAtResponse>

    • GET /v1/characters/{id}/timeline: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { path: { id: string }; query?: { cursor?: string; limit?: number } }
      • Optionaloptions: RequestOptions

      Returns Promise<TimelineResponse>

    • GET /v1/clans/{clan_id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanResponse>

    • GET /v1/clan-applications/{application_id}: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { path: { application_id: string } }
      • Optionaloptions: RequestOptions

      Returns Promise<ClanApplicationResponse>

    • GET /v1/clan-invites/{invite_id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanInviteResponse>

    • GET /v1/clan-settings: girdi doğrulanır; hata CrxError.

      Parameters

      • input: Readonly<Record<string, never>> = {}
      • Optionaloptions: RequestOptions

      Returns Promise<ClanSettingsResponse>

    • GET /v1/definitions/{key}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<DefinitionResponse>

    • GET /v1/level-curves/{key}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<CurveResponse>

    • GET /v1/webhooks/{id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<WebhookResponse>

    • getCharacterTimeline sayfalarını dolaşır; döngü/limit sessiz kesilmez.

      Parameters

      • input: { path: { id: string }; query?: { cursor?: string; limit?: number } }
      • options: PaginationOptions = {}

      Returns AsyncGenerator<TimelineItemDto>

    • listCharacterEvents sayfalarını dolaşır; döngü/limit sessiz kesilmez.

      Parameters

      • input: { path: { id: string }; query?: { cursor?: string; limit?: number } }
      • options: PaginationOptions = {}

      Returns AsyncGenerator<EventDto>

    • listCharacters sayfalarını dolaşır; döngü/limit sessiz kesilmez.

      Parameters

      • input: { query?: { cursor?: string; definition?: string; limit?: number } } = {}
      • options: PaginationOptions = {}

      Returns AsyncGenerator<CharacterResponse>

    • listRules sayfalarını dolaşır; döngü/limit sessiz kesilmez.

      Parameters

      • input: { query?: { cursor?: string; limit?: number } } = {}
      • options: PaginationOptions = {}

      Returns AsyncGenerator<RuleResponse>

    • listWebhooks sayfalarını dolaşır; döngü/limit sessiz kesilmez.

      Parameters

      • input: { query?: { cursor?: string; limit?: number } } = {}
      • options: PaginationOptions = {}

      Returns AsyncGenerator<WebhookResponse>

    • POST /v1/clans/{clan_id}/members/kick: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>

    • POST /v1/clans/{clan_id}/leave: girdi doğrulanır; hata CrxError.

      Parameters

      • input: {
            body: ClanActorRequest;
            headers: { "Idempotency-Key": string };
            path: { clan_id: string };
        }
      • Optionaloptions: RequestOptions

      Returns Promise<ClanMutationResponse>

    • GET /v1/characters/{id}/events: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { path: { id: string }; query?: { cursor?: string; limit?: number } }
      • Optionaloptions: RequestOptions

      Returns Promise<EventPageResponse>

    • GET /v1/characters: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { query?: { cursor?: string; definition?: string; limit?: number } } = {}
      • Optionaloptions: RequestOptions

      Returns Promise<CharacterListResponse>

    • GET /v1/clans: girdi doğrulanır; hata CrxError.

      Parameters

      • input: Readonly<Record<string, never>> = {}
      • Optionaloptions: RequestOptions

      Returns Promise<ClanListResponse>

    • GET /v1/rules: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { query?: { cursor?: string; limit?: number } } = {}
      • Optionaloptions: RequestOptions

      Returns Promise<RuleListResponse>

    • GET /v1/webhooks: girdi doğrulanır; hata CrxError.

      Parameters

      • input: { query?: { cursor?: string; limit?: number } } = {}
      • Optionaloptions: RequestOptions

      Returns Promise<WebhookListResponse>

    • POST /v1/clan-invites/{invite_id}/respond: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>

    • POST /v1/clans/{clan_id}/leadership: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>

    • PATCH /v1/clans/{clan_id}: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>

    • POST /v1/clans/{clan_id}/treasury/withdraw: girdi doğrulanır; hata CrxError.

      Parameters

      Returns Promise<ClanMutationResponse>