Skip to content

Commit

Permalink
chore: remove old campaign
Browse files Browse the repository at this point in the history
  • Loading branch information
guerinoni committed May 22, 2024
1 parent ef1410b commit 36cd0b3
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 104 deletions.
26 changes: 0 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,32 +165,6 @@ status_response = client.get_export_channel_status(response['task_id'])
# status_response['status'] == 'pending', 'completed'
```

### Campaigns

```ruby
# Create a user or channel segment
client.create_segment({ name: 'test', type: 'user', filter: { uniq: 'a flag on users' } })

# Create a campaign that uses the segment
client.create_campaign({
name: 'test',
text: 'Hi',
sender_id: campaign_sender,
segment_id: segment_id,
channel_type: 'messaging'
})

# Schedule the campaign
client.schedule_campaign(campaign_id, Time.now.to_i)

# Query the campaign to check the status
response = client.query_campaigns(filter_conditions: { id: campaign_id })
response['campaigns'][0]['status'] == 'completed'

# Read sent information
client.query_recipients(filter_conditions: { campaign_id: campaign_id })
```

### Rate limits

```ruby
Expand Down
78 changes: 0 additions & 78 deletions lib/stream-chat/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -890,84 +890,6 @@ def list_imports(options)
get('imports', params: options)
end

# Creates a campaign.
sig { params(campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
def create_campaign(campaign)
post('campaigns', data: { campaign: campaign })
end

# Queries campaigns similar to query_channels or query_users.
sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
def query_campaigns(**params)
get('campaigns', params: { payload: params.to_json })
end

# Updates a campaign.
sig { params(campaign_id: String, campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
def update_campaign(campaign_id, campaign)
put("campaigns/#{campaign_id}", data: { campaign: campaign })
end

# Deletes a campaign.
sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
def delete_campaign(campaign_id)
delete("campaigns/#{campaign_id}")
end

# Schedules a campaign.
sig { params(campaign_id: String, scheduled_for: Integer).returns(StreamChat::StreamResponse) }
def schedule_campaign(campaign_id, scheduled_for)
patch("campaigns/#{campaign_id}/schedule", data: { scheduled_for: scheduled_for })
end

# Stops a campaign.
sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
def stop_campaign(campaign_id)
patch("campaigns/#{campaign_id}/stop")
end

# Resumes a campaign.
sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
def resume_campaign(campaign_id)
patch("campaigns/#{campaign_id}/resume")
end

# Tests a campaign.
sig { params(campaign_id: String, users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
def test_campaign(campaign_id, users)
post("campaigns/#{campaign_id}/test", data: { users: users })
end

# Creates a campaign segment.
sig { params(segment: StringKeyHash).returns(StreamChat::StreamResponse) }
def create_segment(segment)
post('segments', data: { segment: segment })
end

# Queries campaign segments.
sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
def query_segments(**params)
get('segments', params: { payload: params.to_json })
end

# Updates a campaign segment.
sig { params(segment_id: String, segment: StringKeyHash).returns(StreamChat::StreamResponse) }
def update_segment(segment_id, segment)
put("segments/#{segment_id}", data: { segment: segment })
end

# Deletes a campaign segment.
sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
def delete_segment(segment_id)
delete("segments/#{segment_id}")
end

# Queries campaign recipients.
sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
def query_recipients(**params)
get('recipients', params: { payload: params.to_json })
end

private

sig { returns(T::Hash[String, String]) }
Expand Down

0 comments on commit 36cd0b3

Please sign in to comment.