From 36cd0b37bef497fff2721f68850852c3b9309bcc Mon Sep 17 00:00:00 2001 From: Federico Guerinoni Date: Wed, 22 May 2024 11:32:25 +0200 Subject: [PATCH] chore: remove old campaign --- README.md | 26 ------------- lib/stream-chat/client.rb | 78 --------------------------------------- 2 files changed, 104 deletions(-) diff --git a/README.md b/README.md index a204aa0..e94ce7c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/lib/stream-chat/client.rb b/lib/stream-chat/client.rb index ee30fdc..9432a9d 100644 --- a/lib/stream-chat/client.rb +++ b/lib/stream-chat/client.rb @@ -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]) }