Keyword rules

const rules = await bird.whatsapp.keywordRules.list({ operation: "opt_out" });
for (const rule of rules.data ?? []) {
  console.log(rule.scope, rule.effective_keywords);
}

rules = client.whatsapp.keyword_rules.list(operation="opt_out")
for rule in rules.data or []:
    print(rule.scope, rule.effective_keywords)

rules, err := client.Whatsapp.KeywordRules.List(context.Background(), bird.WhatsappKeywordRulesListParams{
	Operation: "opt_out", // omit for both operations, Bird's rules and your own
})
if err != nil {
	log.Fatal(err)
}
for _, rule := range rules.Data {
	fmt.Println(rule.Scope, rule.EffectiveKeywords)
}

$rules = $bird->whatsapp->keywordRules->list(['operation' => 'opt_out']);
foreach ($rules->getData() ?? [] as $rule) {
    echo $rule->getScope(), ' ', implode(',', $rule->getEffectiveKeywords() ?? []), PHP_EOL;
}

bird whatsapp keyword-rules list

curl "https://us1.platform.bird.com/v1/whatsapp/keyword-rules?operation=opt_out" \
  -H "Authorization: Bearer $BIRD_API_KEY"

const rule = await bird.whatsapp.keywordRules.create({
  operation: "opt_out",
  country: "US", // the SENDER's country, from their own number
  reply: "You're off the list. ACME Courier won't message you again.",
});
// effective_keywords is Bird's set plus any of your own.
console.log(rule.id, rule.effective_keywords);

rule = client.whatsapp.keyword_rules.create(
    operation="opt_out",
    country="US",  # the SENDER's country, from their own number
    reply="You're off the list. ACME Courier won't message you again.",
)
# effective_keywords is Bird's set plus any of your own.
print(rule.id, rule.effective_keywords)

rule, err := client.Whatsapp.KeywordRules.Create(context.Background(), bird.WhatsappKeywordRulesCreateParams{
	Operation: "opt_out",
	Country:   bird.String("US"), // the SENDER's country, from their own number
	Reply:     bird.String("You're off the list. ACME Courier won't message you again."),
})
if err != nil {
	log.Fatal(err)
}
// EffectiveKeywords is Bird's set plus any of your own.
fmt.Println(rule.Id, rule.EffectiveKeywords)

$rule = $bird->whatsapp->keywordRules->create(
    (new WhatsAppKeywordRuleCreate())
        ->setOperation('opt_out')
        ->setCountry('US')
        ->setReply("You're off the list. ACME Courier won't message you again."),
);
// getEffectiveKeywords() is Bird's set plus any of your own.
echo $rule->getId(), ' ', implode(',', $rule->getEffectiveKeywords() ?? []);

bird whatsapp keyword-rules create \
  --country US \
  --keywords 'no more texts' \
  --keywords 'remove me' \
  --operation opt_out \
  --reply "You're off the list. ACME Courier won't message you again." \
  --waba 102290129340398

curl -X POST https://us1.platform.bird.com/v1/whatsapp/keyword-rules \
  -H "Authorization: Bearer $BIRD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operation":"opt_out","country":"US","reply":"You'"'"'re off the list. ACME Courier won'"'"'t message you again."}'

// Omitting keywords leaves the set alone; an empty array clears your additions
// back to Bird's. reply: null switches the auto-reply off and still records
// the opt-out.
const rule = await bird.whatsapp.keywordRules.update("wkr_01m2kj8x4te9p0rr7e5w2n1abc", {
  keywords: ["no more texts", "remove me"],
});
console.log(rule.effective_keywords);

# Omitting keywords leaves the set alone; an empty list clears your additions
# back to Bird's.
rule = client.whatsapp.keyword_rules.update(
    "wkr_01m2kj8x4te9p0rr7e5w2n1abc", keywords=["no more texts", "remove me"]
)
print(rule.effective_keywords)

// Omitting keywords leaves the set alone; an empty slice clears your
// additions back to Bird's.
rule, err := client.Whatsapp.KeywordRules.Update(context.Background(),
	"wkr_01m2kj8x4te9p0rr7e5w2n1abc", bird.WhatsappKeywordRulesUpdateParams{
		Keywords: []string{"no more texts", "remove me"},
	})
if err != nil {
	log.Fatal(err)
}
fmt.Println(rule.EffectiveKeywords)

// Omitting keywords leaves the set alone; an empty array clears your additions
// back to Bird's.
$rule = $bird->whatsapp->keywordRules->update(
    'wkr_01m2kj8x4te9p0rr7e5w2n1abc',
    (new WhatsAppKeywordRuleUpdate())->setKeywords(['no more texts', 'remove me']),
);
echo implode(',', $rule->getEffectiveKeywords() ?? []);

bird whatsapp keyword-rules update <id> \
  --keywords 'no more texts' \
  --reply "You're off the list. ACME Courier won't message you again."

curl -X PATCH https://us1.platform.bird.com/v1/whatsapp/keyword-rules/wkr_01m2kj8x4te9p0rr7e5w2n1abc \
  -H "Authorization: Bearer $BIRD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keywords":["no more texts"]}'

// The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one; STOP never stops working.
await bird.whatsapp.keywordRules.delete("wkr_01m2kj8x4te9p0rr7e5w2n1abc");

# The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one; STOP never stops working.
client.whatsapp.keyword_rules.delete("wkr_01m2kj8x4te9p0rr7e5w2n1abc")

if err := client.Whatsapp.KeywordRules.Delete(context.Background(),
	"wkr_01m2kj8x4te9p0rr7e5w2n1abc"); err != nil {
	log.Fatal(err)
}

// The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one; STOP never stops working.
$bird->whatsapp->keywordRules->delete('wkr_01m2kj8x4te9p0rr7e5w2n1abc');

bird whatsapp keyword-rules delete <id> --yes

curl -X DELETE https://us1.platform.bird.com/v1/whatsapp/keyword-rules/wkr_01m2kj8x4te9p0rr7e5w2n1abc \
  -H "Authorization: Bearer $BIRD_API_KEY"