Class: License::Office

Inherits:
Object
  • Object
show all
Defined in:
lib/ovh-api/api/license/office.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Office

Returns a new instance of Office.



6
7
8
 
# File 'lib/ovh-api/api/license/office.rb', line 6

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(iam_tags: nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
 
# File 'lib/ovh-api/api/license/office.rb', line 10

def get(iam_tags: nil)
  @connection.call(
    :GET,
    '/license/office',
    type: nil,
    auth: [],
    query: { 'iamTags' => iam_tags }
  )
end

#service_name_domain_domain_name_get(domain_name:, service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ovh-api/api/license/office.rb', line 20

def service_name_domain_domain_name_get(domain_name:, service_name:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/domain/{domainName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_domain_get(service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/ovh-api/api/license/office.rb', line 34

def service_name_domain_get(service_name:)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/domain'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_get(service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ovh-api/api/license/office.rb', line 46

def service_name_get(service_name:)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_pending_task_get(service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ovh-api/api/license/office.rb', line 58

def service_name_pending_task_get(service_name:)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/pendingTask'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_pending_task_id_get(id:, service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ovh-api/api/license/office.rb', line 70

def service_name_pending_task_id_get(id:, service_name:)
  raise ArgumentError, 'id is required' if id.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/pendingTask/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_put(service_name:, license_office_office_tenant_native:) ⇒ Object

Raises:

  • (ArgumentError) 


84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ovh-api/api/license/office.rb', line 84

def service_name_put(service_name:, license_office_office_tenant_native:)
  raise ArgumentError, 'service_name is required' if service_name.nil?
  raise ArgumentError, 'license_office_office_tenant_native is required' if license_office_office_tenant_native.nil?

  @connection.call(
    :PUT,
    '/license/office/{serviceName}'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    body: license_office_office_tenant_native
  )
end

#service_name_service_infos_get(service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ovh-api/api/license/office.rb', line 98

def service_name_service_infos_get(service_name:)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/serviceInfos'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_service_infos_put(service_name:, services_service:) ⇒ Object

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/ovh-api/api/license/office.rb', line 110

def service_name_service_infos_put(service_name:, services_service:)
  raise ArgumentError, 'service_name is required' if service_name.nil?
  raise ArgumentError, 'services_service is required' if services_service.nil?

  @connection.call(
    :PUT,
    '/license/office/{serviceName}/serviceInfos'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    body: services_service
  )
end

#service_name_usage_statistics_get(service_name:, from: nil, to: nil) ⇒ Object

Raises:

  • (ArgumentError) 


124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ovh-api/api/license/office.rb', line 124

def service_name_usage_statistics_get(service_name:, from: nil, to: nil)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/usageStatistics'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    query: { 'from' => from, 'to' => to }
  )
end

#service_name_user_activation_email_change_password_post(activation_email:, service_name:, license_office_office_tenant_post_change_password:) ⇒ Object

Raises:

  • (ArgumentError) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/ovh-api/api/license/office.rb', line 137

def service_name_user_activation_email_change_password_post(activation_email:, service_name:, license_office_office_tenant_post_change_password:)
  raise ArgumentError, 'activation_email is required' if activation_email.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?
  raise ArgumentError, 'license_office_office_tenant_post_change_password is required' if license_office_office_tenant_post_change_password.nil?

  @connection.call(
    :POST,
    '/license/office/{serviceName}/user/{activationEmail}/changePassword'
      .gsub('{activationEmail}', ERB::Util.url_encode(activation_email.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    body: license_office_office_tenant_post_change_password
  )
end

#service_name_user_activation_email_delete(activation_email:, service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ovh-api/api/license/office.rb', line 153

def service_name_user_activation_email_delete(activation_email:, service_name:)
  raise ArgumentError, 'activation_email is required' if activation_email.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :DELETE,
    '/license/office/{serviceName}/user/{activationEmail}'
      .gsub('{activationEmail}', ERB::Util.url_encode(activation_email.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_user_activation_email_get(activation_email:, service_name:) ⇒ Object

Raises:

  • (ArgumentError) 


167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/ovh-api/api/license/office.rb', line 167

def service_name_user_activation_email_get(activation_email:, service_name:)
  raise ArgumentError, 'activation_email is required' if activation_email.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/user/{activationEmail}'
      .gsub('{activationEmail}', ERB::Util.url_encode(activation_email.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: []
  )
end

#service_name_user_activation_email_put(activation_email:, service_name:, license_office_office_user_native_update:) ⇒ Object

Raises:

  • (ArgumentError) 


181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/ovh-api/api/license/office.rb', line 181

def service_name_user_activation_email_put(activation_email:, service_name:, license_office_office_user_native_update:)
  raise ArgumentError, 'activation_email is required' if activation_email.nil?
  raise ArgumentError, 'service_name is required' if service_name.nil?
  raise ArgumentError, 'license_office_office_user_native_update is required' if license_office_office_user_native_update.nil?

  @connection.call(
    :PUT,
    '/license/office/{serviceName}/user/{activationEmail}'
      .gsub('{activationEmail}', ERB::Util.url_encode(activation_email.to_s))
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    body: license_office_office_user_native_update
  )
end

#service_name_user_get(service_name:, activation_email: nil, first_name: nil, last_name: nil, licences: nil) ⇒ Object

Raises:

  • (ArgumentError) 


197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ovh-api/api/license/office.rb', line 197

def service_name_user_get(service_name:, activation_email: nil, first_name: nil, last_name: nil, licences: nil)
  raise ArgumentError, 'service_name is required' if service_name.nil?

  @connection.call(
    :GET,
    '/license/office/{serviceName}/user'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    query: { 'activationEmail' => activation_email, 'firstName' => first_name, 'lastName' => last_name, 'licences' => licences }
  )
end

#service_name_user_post(service_name:, license_office_post_user_native:) ⇒ Object

Raises:

  • (ArgumentError) 


210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ovh-api/api/license/office.rb', line 210

def service_name_user_post(service_name:, license_office_post_user_native:)
  raise ArgumentError, 'service_name is required' if service_name.nil?
  raise ArgumentError, 'license_office_post_user_native is required' if license_office_post_user_native.nil?

  @connection.call(
    :POST,
    '/license/office/{serviceName}/user'
      .gsub('{serviceName}', ERB::Util.url_encode(service_name.to_s)),
    type: nil,
    auth: [],
    body: license_office_post_user_native
  )
end