Module: StudyplusForSchoolSync::Endpoint::Partner
- Included in:
- StudyplusForSchoolSync::Endpoint
- Defined in:
- lib/studyplus_for_school_sync/endpoint/partner.rb
Instance Method Summary collapse
-
#create_partner(school_name:, **options) ⇒ Hash
Create partner.
-
#create_student(partner_public_id:, last_name:, first_name:, last_name_kana:, first_name_kana:, **options) ⇒ Hash
Create student.
-
#create_tag(partner_id:, name:, **options) ⇒ Hash
Creae tag.
-
#delete_tag(partner_id:, tag_id:) ⇒ Hash
Delete tag.
-
#tags(partner_id:, page: 1) ⇒ Hash
Get tags.
-
#update_tag(partner_id:, tag_id:, name:, **options) ⇒ Hash
Update tag.
Instance Method Details
#create_partner(school_name:, **options) ⇒ Hash
Create partner
12 13 14 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 12 def create_partner(school_name:, **) post(path: "#{BASE_PAH}/partners", params: .merge(school_name: school_name)) end |
#create_student(partner_public_id:, last_name:, first_name:, last_name_kana:, first_name_kana:, **options) ⇒ Hash
Create student
27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 27 def create_student(partner_public_id:, last_name:, first_name:, last_name_kana:, first_name_kana:, **) post( path: "#{BASE_PAH}/partners/#{partner_public_id}/students", params: .merge( last_name: last_name, first_name: first_name, last_name_kana: last_name_kana, first_name_kana: first_name_kana ) ) end |
#create_tag(partner_id:, name:, **options) ⇒ Hash
Creae tag
53 54 55 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 53 def create_tag(partner_id:, name:, **) post(path: "#{BASE_PAH}/partners/#{partner_id}/tags", params: .merge(name: name)) end |
#delete_tag(partner_id:, tag_id:) ⇒ Hash
Delete tag
72 73 74 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 72 def delete_tag(partner_id:, tag_id:) delete(path: "#{BASE_PAH}/partners/#{partner_id}/tags/#{tag_id}") end |
#tags(partner_id:, page: 1) ⇒ Hash
Get tags
43 44 45 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 43 def (partner_id:, page: 1) get(path: "#{BASE_PAH}/partners/#{partner_id}/tags", params: { page: page }) end |
#update_tag(partner_id:, tag_id:, name:, **options) ⇒ Hash
Update tag
64 65 66 |
# File 'lib/studyplus_for_school_sync/endpoint/partner.rb', line 64 def update_tag(partner_id:, tag_id:, name:, **) patch(path: "#{BASE_PAH}/partners/#{partner_id}/tags/#{tag_id}", params: .merge(name: name)) end |