Skip to content

Commit 6a65e0e

Browse files
manisha1997manisha1997
authored
chore: Add comments to ApiService methods.
1 parent d7e6e35 commit 6a65e0e

10 files changed

+38
-0
lines changed

‎rest/bulkexports/v1/exports_jobs.go

+3
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ func (params *CreateExportCustomJobParams) SetEmail(Email string) *CreateExportC
6464
return params
6565
}
6666

67+
//
6768
func (c *ApiService) CreateExportCustomJob(ResourceType string, params *CreateExportCustomJobParams) (*BulkexportsV1ExportCustomJob, error) {
6869
path := "/v1/Exports/{ResourceType}/Jobs"
6970
path = strings.Replace(path, "{"+"ResourceType"+"}", ResourceType, -1)
@@ -107,6 +108,7 @@ func (c *ApiService) CreateExportCustomJob(ResourceType string, params *CreateEx
107108
return ps, err
108109
}
109110

111+
//
110112
func (c *ApiService) DeleteJob(JobSid string) error {
111113
path := "/v1/Exports/Jobs/{JobSid}"
112114
path = strings.Replace(path, "{"+"JobSid"+"}", JobSid, -1)
@@ -126,6 +128,7 @@ func (c *ApiService) DeleteJob(JobSid string) error {
126128
return nil
127129
}
128130

131+
//
129132
func (c *ApiService) FetchJob(JobSid string) (*BulkexportsV1Job, error) {
130133
path := "/v1/Exports/Jobs/{JobSid}"
131134
path = strings.Replace(path, "{"+"JobSid"+"}", JobSid, -1)

‎rest/chat/v1/credentials.go

+4
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ func (params *CreateCredentialParams) SetSecret(Secret string) *CreateCredential
7070
return params
7171
}
7272

73+
//
7374
func (c *ApiService) CreateCredential(params *CreateCredentialParams) (*ChatV1Credential, error) {
7475
path := "/v1/Credentials"
7576

@@ -115,6 +116,7 @@ func (c *ApiService) CreateCredential(params *CreateCredentialParams) (*ChatV1Cr
115116
return ps, err
116117
}
117118

119+
//
118120
func (c *ApiService) DeleteCredential(Sid string) error {
119121
path := "/v1/Credentials/{Sid}"
120122
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -134,6 +136,7 @@ func (c *ApiService) DeleteCredential(Sid string) error {
134136
return nil
135137
}
136138

139+
//
137140
func (c *ApiService) FetchCredential(Sid string) (*ChatV1Credential, error) {
138141
path := "/v1/Credentials/{Sid}"
139142
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -337,6 +340,7 @@ func (params *UpdateCredentialParams) SetSecret(Secret string) *UpdateCredential
337340
return params
338341
}
339342

343+
//
340344
func (c *ApiService) UpdateCredential(Sid string, params *UpdateCredentialParams) (*ChatV1Credential, error) {
341345
path := "/v1/Credentials/{Sid}"
342346
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

‎rest/chat/v1/services.go

+4
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ func (params *CreateServiceParams) SetFriendlyName(FriendlyName string) *CreateS
3434
return params
3535
}
3636

37+
//
3738
func (c *ApiService) CreateService(params *CreateServiceParams) (*ChatV1Service, error) {
3839
path := "/v1/Services"
3940

@@ -61,6 +62,7 @@ func (c *ApiService) CreateService(params *CreateServiceParams) (*ChatV1Service,
6162
return ps, err
6263
}
6364

65+
//
6466
func (c *ApiService) DeleteService(Sid string) error {
6567
path := "/v1/Services/{Sid}"
6668
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -80,6 +82,7 @@ func (c *ApiService) DeleteService(Sid string) error {
8082
return nil
8183
}
8284

85+
//
8386
func (c *ApiService) FetchService(Sid string) (*ChatV1Service, error) {
8487
path := "/v1/Services/{Sid}"
8588
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -571,6 +574,7 @@ func (params *UpdateServiceParams) SetLimitsUserChannels(LimitsUserChannels int)
571574
return params
572575
}
573576

577+
//
574578
func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*ChatV1Service, error) {
575579
path := "/v1/Services/{Sid}"
576580
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

‎rest/chat/v1/services_channels.go

+4
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ func (params *CreateChannelParams) SetType(Type string) *CreateChannelParams {
5252
return params
5353
}
5454

55+
//
5556
func (c *ApiService) CreateChannel(ServiceSid string, params *CreateChannelParams) (*ChatV1Channel, error) {
5657
path := "/v1/Services/{ServiceSid}/Channels"
5758
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -89,6 +90,7 @@ func (c *ApiService) CreateChannel(ServiceSid string, params *CreateChannelParam
8990
return ps, err
9091
}
9192

93+
//
9294
func (c *ApiService) DeleteChannel(ServiceSid string, Sid string) error {
9395
path := "/v1/Services/{ServiceSid}/Channels/{Sid}"
9496
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -109,6 +111,7 @@ func (c *ApiService) DeleteChannel(ServiceSid string, Sid string) error {
109111
return nil
110112
}
111113

114+
//
112115
func (c *ApiService) FetchChannel(ServiceSid string, Sid string) (*ChatV1Channel, error) {
113116
path := "/v1/Services/{ServiceSid}/Channels/{Sid}"
114117
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -308,6 +311,7 @@ func (params *UpdateChannelParams) SetAttributes(Attributes string) *UpdateChann
308311
return params
309312
}
310313

314+
//
311315
func (c *ApiService) UpdateChannel(ServiceSid string, Sid string, params *UpdateChannelParams) (*ChatV1Channel, error) {
312316
path := "/v1/Services/{ServiceSid}/Channels/{Sid}"
313317
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v1/services_channels_invites.go

+3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ func (params *CreateInviteParams) SetRoleSid(RoleSid string) *CreateInviteParams
4040
return params
4141
}
4242

43+
//
4344
func (c *ApiService) CreateInvite(ServiceSid string, ChannelSid string, params *CreateInviteParams) (*ChatV1Invite, error) {
4445
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites"
4546
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -72,6 +73,7 @@ func (c *ApiService) CreateInvite(ServiceSid string, ChannelSid string, params *
7273
return ps, err
7374
}
7475

76+
//
7577
func (c *ApiService) DeleteInvite(ServiceSid string, ChannelSid string, Sid string) error {
7678
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}"
7779
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -93,6 +95,7 @@ func (c *ApiService) DeleteInvite(ServiceSid string, ChannelSid string, Sid stri
9395
return nil
9496
}
9597

98+
//
9699
func (c *ApiService) FetchInvite(ServiceSid string, ChannelSid string, Sid string) (*ChatV1Invite, error) {
97100
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}"
98101
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v1/services_channels_members.go

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ func (params *CreateMemberParams) SetRoleSid(RoleSid string) *CreateMemberParams
4040
return params
4141
}
4242

43+
//
4344
func (c *ApiService) CreateMember(ServiceSid string, ChannelSid string, params *CreateMemberParams) (*ChatV1Member, error) {
4445
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members"
4546
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -72,6 +73,7 @@ func (c *ApiService) CreateMember(ServiceSid string, ChannelSid string, params *
7273
return ps, err
7374
}
7475

76+
//
7577
func (c *ApiService) DeleteMember(ServiceSid string, ChannelSid string, Sid string) error {
7678
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}"
7779
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -93,6 +95,7 @@ func (c *ApiService) DeleteMember(ServiceSid string, ChannelSid string, Sid stri
9395
return nil
9496
}
9597

98+
//
9699
func (c *ApiService) FetchMember(ServiceSid string, ChannelSid string, Sid string) (*ChatV1Member, error) {
97100
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}"
98101
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -288,6 +291,7 @@ func (params *UpdateMemberParams) SetLastConsumedMessageIndex(LastConsumedMessag
288291
return params
289292
}
290293

294+
//
291295
func (c *ApiService) UpdateMember(ServiceSid string, ChannelSid string, Sid string, params *UpdateMemberParams) (*ChatV1Member, error) {
292296
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}"
293297
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v1/services_channels_messages.go

+4
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ func (params *CreateMessageParams) SetAttributes(Attributes string) *CreateMessa
4646
return params
4747
}
4848

49+
//
4950
func (c *ApiService) CreateMessage(ServiceSid string, ChannelSid string, params *CreateMessageParams) (*ChatV1Message, error) {
5051
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages"
5152
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -81,6 +82,7 @@ func (c *ApiService) CreateMessage(ServiceSid string, ChannelSid string, params
8182
return ps, err
8283
}
8384

85+
//
8486
func (c *ApiService) DeleteMessage(ServiceSid string, ChannelSid string, Sid string) error {
8587
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}"
8688
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -102,6 +104,7 @@ func (c *ApiService) DeleteMessage(ServiceSid string, ChannelSid string, Sid str
102104
return nil
103105
}
104106

107+
//
105108
func (c *ApiService) FetchMessage(ServiceSid string, ChannelSid string, Sid string) (*ChatV1Message, error) {
106109
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}"
107110
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -295,6 +298,7 @@ func (params *UpdateMessageParams) SetAttributes(Attributes string) *UpdateMessa
295298
return params
296299
}
297300

301+
//
298302
func (c *ApiService) UpdateMessage(ServiceSid string, ChannelSid string, Sid string, params *UpdateMessageParams) (*ChatV1Message, error) {
299303
path := "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}"
300304
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v1/services_roles.go

+4
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ func (params *CreateRoleParams) SetPermission(Permission []string) *CreateRolePa
4646
return params
4747
}
4848

49+
//
4950
func (c *ApiService) CreateRole(ServiceSid string, params *CreateRoleParams) (*ChatV1Role, error) {
5051
path := "/v1/Services/{ServiceSid}/Roles"
5152
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -82,6 +83,7 @@ func (c *ApiService) CreateRole(ServiceSid string, params *CreateRoleParams) (*C
8283
return ps, err
8384
}
8485

86+
//
8587
func (c *ApiService) DeleteRole(ServiceSid string, Sid string) error {
8688
path := "/v1/Services/{ServiceSid}/Roles/{Sid}"
8789
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -102,6 +104,7 @@ func (c *ApiService) DeleteRole(ServiceSid string, Sid string) error {
102104
return nil
103105
}
104106

107+
//
105108
func (c *ApiService) FetchRole(ServiceSid string, Sid string) (*ChatV1Role, error) {
106109
path := "/v1/Services/{ServiceSid}/Roles/{Sid}"
107110
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -278,6 +281,7 @@ func (params *UpdateRoleParams) SetPermission(Permission []string) *UpdateRolePa
278281
return params
279282
}
280283

284+
//
281285
func (c *ApiService) UpdateRole(ServiceSid string, Sid string, params *UpdateRoleParams) (*ChatV1Role, error) {
282286
path := "/v1/Services/{ServiceSid}/Roles/{Sid}"
283287
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v1/services_users.go

+4
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ func (params *CreateUserParams) SetFriendlyName(FriendlyName string) *CreateUser
5252
return params
5353
}
5454

55+
//
5556
func (c *ApiService) CreateUser(ServiceSid string, params *CreateUserParams) (*ChatV1User, error) {
5657
path := "/v1/Services/{ServiceSid}/Users"
5758
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -89,6 +90,7 @@ func (c *ApiService) CreateUser(ServiceSid string, params *CreateUserParams) (*C
8990
return ps, err
9091
}
9192

93+
//
9294
func (c *ApiService) DeleteUser(ServiceSid string, Sid string) error {
9395
path := "/v1/Services/{ServiceSid}/Users/{Sid}"
9496
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -109,6 +111,7 @@ func (c *ApiService) DeleteUser(ServiceSid string, Sid string) error {
109111
return nil
110112
}
111113

114+
//
112115
func (c *ApiService) FetchUser(ServiceSid string, Sid string) (*ChatV1User, error) {
113116
path := "/v1/Services/{ServiceSid}/Users/{Sid}"
114117
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)
@@ -297,6 +300,7 @@ func (params *UpdateUserParams) SetFriendlyName(FriendlyName string) *UpdateUser
297300
return params
298301
}
299302

303+
//
300304
func (c *ApiService) UpdateUser(ServiceSid string, Sid string, params *UpdateUserParams) (*ChatV1User, error) {
301305
path := "/v1/Services/{ServiceSid}/Users/{Sid}"
302306
path = strings.Replace(path, "{"+"ServiceSid"+"}", ServiceSid, -1)

‎rest/chat/v2/credentials.go

+4
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ func (params *CreateCredentialParams) SetSecret(Secret string) *CreateCredential
7070
return params
7171
}
7272

73+
//
7374
func (c *ApiService) CreateCredential(params *CreateCredentialParams) (*ChatV2Credential, error) {
7475
path := "/v2/Credentials"
7576

@@ -115,6 +116,7 @@ func (c *ApiService) CreateCredential(params *CreateCredentialParams) (*ChatV2Cr
115116
return ps, err
116117
}
117118

119+
//
118120
func (c *ApiService) DeleteCredential(Sid string) error {
119121
path := "/v2/Credentials/{Sid}"
120122
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -134,6 +136,7 @@ func (c *ApiService) DeleteCredential(Sid string) error {
134136
return nil
135137
}
136138

139+
//
137140
func (c *ApiService) FetchCredential(Sid string) (*ChatV2Credential, error) {
138141
path := "/v2/Credentials/{Sid}"
139142
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
@@ -337,6 +340,7 @@ func (params *UpdateCredentialParams) SetSecret(Secret string) *UpdateCredential
337340
return params
338341
}
339342

343+
//
340344
func (c *ApiService) UpdateCredential(Sid string, params *UpdateCredentialParams) (*ChatV2Credential, error) {
341345
path := "/v2/Credentials/{Sid}"
342346
path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

0 commit comments

Comments
 (0)