katello_api 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. data/Gemfile +8 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.rdoc +53 -0
  4. data/Rakefile +2 -0
  5. data/katello_api.gemspec +25 -0
  6. data/lib/katello_api/base.rb +134 -0
  7. data/lib/katello_api/config.yml +6 -0
  8. data/lib/katello_api/resources/activation_key.rb +104 -0
  9. data/lib/katello_api/resources/architecture.rb +64 -0
  10. data/lib/katello_api/resources/changeset.rb +83 -0
  11. data/lib/katello_api/resources/changesets_content.rb +149 -0
  12. data/lib/katello_api/resources/compute_resource.rb +82 -0
  13. data/lib/katello_api/resources/config_template.rb +92 -0
  14. data/lib/katello_api/resources/content_view.rb +55 -0
  15. data/lib/katello_api/resources/content_view_definition.rb +107 -0
  16. data/lib/katello_api/resources/crl.rb +19 -0
  17. data/lib/katello_api/resources/distribution.rb +29 -0
  18. data/lib/katello_api/resources/distributor.rb +112 -0
  19. data/lib/katello_api/resources/domain.rb +71 -0
  20. data/lib/katello_api/resources/environment.rb +106 -0
  21. data/lib/katello_api/resources/erratum.rb +33 -0
  22. data/lib/katello_api/resources/gpg_key.rb +78 -0
  23. data/lib/katello_api/resources/hardware_model.rb +70 -0
  24. data/lib/katello_api/resources/organization.rb +64 -0
  25. data/lib/katello_api/resources/package.rb +42 -0
  26. data/lib/katello_api/resources/permission.rb +57 -0
  27. data/lib/katello_api/resources/ping.rb +37 -0
  28. data/lib/katello_api/resources/product.rb +119 -0
  29. data/lib/katello_api/resources/provider.rb +151 -0
  30. data/lib/katello_api/resources/repository.rb +128 -0
  31. data/lib/katello_api/resources/repository_set.rb +45 -0
  32. data/lib/katello_api/resources/role.rb +74 -0
  33. data/lib/katello_api/resources/role_ldap_group.rb +41 -0
  34. data/lib/katello_api/resources/smart_proxy.rb +67 -0
  35. data/lib/katello_api/resources/statu.rb +19 -0
  36. data/lib/katello_api/resources/subnet.rb +64 -0
  37. data/lib/katello_api/resources/subscription.rb +64 -0
  38. data/lib/katello_api/resources/sync.rb +49 -0
  39. data/lib/katello_api/resources/sync_plan.rb +78 -0
  40. data/lib/katello_api/resources/system.rb +226 -0
  41. data/lib/katello_api/resources/system_group.rb +136 -0
  42. data/lib/katello_api/resources/system_group_erratum.rb +34 -0
  43. data/lib/katello_api/resources/system_group_package.rb +49 -0
  44. data/lib/katello_api/resources/system_package.rb +45 -0
  45. data/lib/katello_api/resources/task.rb +30 -0
  46. data/lib/katello_api/resources/template.rb +107 -0
  47. data/lib/katello_api/resources/templates_content.rb +143 -0
  48. data/lib/katello_api/resources/uebercert.rb +20 -0
  49. data/lib/katello_api/resources/user.rb +113 -0
  50. data/lib/katello_api/rest_client_oauth.rb +19 -0
  51. data/lib/katello_api/version.rb +3 -0
  52. data/lib/katello_api.rb +23 -0
  53. metadata +160 -0
@@ -0,0 +1,82 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class ComputeResource < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["compute_resources"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ #
10
+ # @param [Hash] headers additional http headers
11
+ def index(params = { }, headers = { })
12
+ check_params params, :allowed => false, :method => __method__
13
+ url, params = fill_params_in_url "/api/compute_resources", params
14
+ call(:"get", url, params, headers)
15
+ end
16
+
17
+ # @param [Hash] params a hash of params to be passed to the service
18
+ # @option params [String] id compute resource name
19
+ #
20
+ # @param [Hash] headers additional http headers
21
+ def show(params = { }, headers = { })
22
+ check_params params, :allowed => true, :method => __method__
23
+ url, params = fill_params_in_url "/api/compute_resources/:id", params
24
+ call(:"get", url, params, headers)
25
+ end
26
+
27
+ # @param [Hash] params a hash of params to be passed to the service
28
+ # @option params [Hash] compute_resource compute resource info
29
+ # allowed keys are:
30
+ # * description [String, nil],
31
+ # * name [String],
32
+ # * password [String, nil] password for ovirt, ec2, vmware, openstack. secret key for ec2 ,
33
+ # * provider [String] providers include libvirt, ovirt, ec2, vmware, openstack, rackspace ,
34
+ # * region [String, nil] for ec2 only ,
35
+ # * server [String, nil] for vmware ,
36
+ # * tenant [String, nil] for openstack only ,
37
+ # * url [String] url for libvirt, ovirt, and openstack ,
38
+ # * user [String, nil] username for ovirt, ec2, vmware, openstack. access key for ec2. ,
39
+ # * uuid [String, nil] for ovirt, vmware datacenter ,
40
+ #
41
+ # @param [Hash] headers additional http headers
42
+ def create(params = { }, headers = { })
43
+ check_params params, :allowed => true, :method => __method__
44
+ url, params = fill_params_in_url "/api/compute_resources", params
45
+ call(:"post", url, params, headers)
46
+ end
47
+
48
+ # @param [Hash] params a hash of params to be passed to the service
49
+ # @option params [String] id compute resource name
50
+ # @option params [Hash] compute_resource compute resource info
51
+ # allowed keys are:
52
+ # * description [String, nil],
53
+ # * name [String],
54
+ # * password [String, nil] password for ovirt, ec2, vmware, openstack. secret key for ec2 ,
55
+ # * provider [String] providers include libvirt, ovirt, ec2, vmware, openstack, rackspace ,
56
+ # * region [String, nil] for ec2 only ,
57
+ # * server [String, nil] for vmware ,
58
+ # * tenant [String, nil] for openstack only ,
59
+ # * url [String] url for libvirt, ovirt, and openstack ,
60
+ # * user [String, nil] username for ovirt, ec2, vmware, openstack. access key for ec2. ,
61
+ # * uuid [String, nil] for ovirt, vmware datacenter ,
62
+ #
63
+ # @param [Hash] headers additional http headers
64
+ def update(params = { }, headers = { })
65
+ check_params params, :allowed => true, :method => __method__
66
+ url, params = fill_params_in_url "/api/compute_resources/:id", params
67
+ call(:"put", url, params, headers)
68
+ end
69
+
70
+ # @param [Hash] params a hash of params to be passed to the service
71
+ # @option params [String] id compute resource name
72
+ #
73
+ # @param [Hash] headers additional http headers
74
+ def destroy(params = { }, headers = { })
75
+ check_params params, :allowed => true, :method => __method__
76
+ url, params = fill_params_in_url "/api/compute_resources/:id", params
77
+ call(:"delete", url, params, headers)
78
+ end
79
+
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,92 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class ConfigTemplate < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["config_templates"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] order sort results
10
+ # @option params [String] search filter results
11
+ #
12
+ # @param [Hash] headers additional http headers
13
+ def index(params = { }, headers = { })
14
+ check_params params, :allowed => true, :method => __method__
15
+ url, params = fill_params_in_url "/api/config_templates", params
16
+ call(:"get", url, params, headers)
17
+ end
18
+
19
+ # @param [Hash] params a hash of params to be passed to the service
20
+ #
21
+ # @param [Hash] headers additional http headers
22
+ def show(params = { }, headers = { })
23
+ check_params params, :allowed => false, :method => __method__
24
+ url, params = fill_params_in_url "/api/config_templates/:id", params
25
+ call(:"get", url, params, headers)
26
+ end
27
+
28
+ # @param [Hash] params a hash of params to be passed to the service
29
+ # @option params [Hash] config_template
30
+ # allowed keys are:
31
+ # * audit_comment [String, nil],
32
+ # * name [String] template name ,
33
+ # * snippet [String, nil],
34
+ # * template [String],
35
+ # * template_combinations_attributes [String, nil] array of template combinations (hostgroup_id, environment_id) ,
36
+ # * template_kind_id [String, nil] not relevant for snippet ,
37
+ #
38
+ # @param [Hash] headers additional http headers
39
+ def create(params = { }, headers = { })
40
+ check_params params, :allowed => true, :method => __method__
41
+ url, params = fill_params_in_url "/api/config_templates", params
42
+ call(:"post", url, params, headers)
43
+ end
44
+
45
+ # @param [Hash] params a hash of params to be passed to the service
46
+ # @option params [Hash] config_template
47
+ # allowed keys are:
48
+ # * audit_comment [String, nil],
49
+ # * name [String] template name ,
50
+ # * snippet [String, nil],
51
+ # * template [String],
52
+ # * template_combinations_attributes [String, nil] array of template combinations (hostgroup_id, environment_id) ,
53
+ # * template_kind_id [String, nil] not relevant for snippet ,
54
+ #
55
+ # @param [Hash] headers additional http headers
56
+ def update(params = { }, headers = { })
57
+ check_params params, :allowed => true, :method => __method__
58
+ url, params = fill_params_in_url "/api/config_templates/:id", params
59
+ call(:"put", url, params, headers)
60
+ end
61
+
62
+ # @param [Hash] params a hash of params to be passed to the service
63
+ #
64
+ # @param [Hash] headers additional http headers
65
+ def destroy(params = { }, headers = { })
66
+ check_params params, :allowed => false, :method => __method__
67
+ url, params = fill_params_in_url "/api/config_templates/:id", params
68
+ call(:"delete", url, params, headers)
69
+ end
70
+
71
+ # @param [Hash] params a hash of params to be passed to the service
72
+ # @option params [String] version template version
73
+ #
74
+ # @param [Hash] headers additional http headers
75
+ def revision(params = { }, headers = { })
76
+ check_params params, :allowed => true, :method => __method__
77
+ url, params = fill_params_in_url "/api/config_templates/revision", params
78
+ call(:"get", url, params, headers)
79
+ end
80
+
81
+ # @param [Hash] params a hash of params to be passed to the service
82
+ #
83
+ # @param [Hash] headers additional http headers
84
+ def build_pxe_default(params = { }, headers = { })
85
+ check_params params, :allowed => false, :method => __method__
86
+ url, params = fill_params_in_url "/api/config_templates/build_pxe_default", params
87
+ call(:"get", url, params, headers)
88
+ end
89
+
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,55 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class ContentView < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["content_views"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] id content view id
10
+ # @option params [String] environment_id environment identifier
11
+ # @option params [String] label content view label
12
+ # @option params [String] name content view name
13
+ # @option params [String] organization_id organization identifier
14
+ #
15
+ # @param [Hash] headers additional http headers
16
+ def index(params = { }, headers = { })
17
+ check_params params, :allowed => true, :method => __method__
18
+ url, params = fill_params_in_url "/api/organizations/:organization_id/content_views", params
19
+ call(:"get", url, params, headers)
20
+ end
21
+
22
+ # @param [Hash] params a hash of params to be passed to the service
23
+ # @option params [String] id content view id
24
+ # @option params [String] environment_id environment id
25
+ #
26
+ # @param [Hash] headers additional http headers
27
+ def show(params = { }, headers = { })
28
+ check_params params, :allowed => true, :method => __method__
29
+ url, params = fill_params_in_url "/api/content_views/:id", params
30
+ call(:"get", url, params, headers)
31
+ end
32
+
33
+ # @param [Hash] params a hash of params to be passed to the service
34
+ # @option params [String] id content view id
35
+ # @option params [String] environment_id environment promoting to
36
+ #
37
+ # @param [Hash] headers additional http headers
38
+ def promote(params = { }, headers = { })
39
+ check_params params, :allowed => true, :method => __method__
40
+ url, params = fill_params_in_url "/api/content_views/:id/promote", params
41
+ call(:"post", url, params, headers)
42
+ end
43
+
44
+ # @param [Hash] params a hash of params to be passed to the service
45
+ #
46
+ # @param [Hash] headers additional http headers
47
+ def refresh(params = { }, headers = { })
48
+ check_params params, :allowed => false, :method => __method__
49
+ url, params = fill_params_in_url "/api/content_views/:id/refresh", params
50
+ call(:"post", url, params, headers)
51
+ end
52
+
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,107 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class ContentViewDefinition < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["content_view_definitions"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] id content view id
10
+ # @option params [String] label content view label
11
+ # @option params [String] name content view name
12
+ # @option params [String] organization_id organization identifier
13
+ #
14
+ # @param [Hash] headers additional http headers
15
+ def index(params = { }, headers = { })
16
+ check_params params, :allowed => true, :method => __method__
17
+ url, params = fill_params_in_url "/api/organizations/:organization_id/content_view_definitions", params
18
+ call(:"get", url, params, headers)
19
+ end
20
+
21
+ # @param [Hash] params a hash of params to be passed to the service
22
+ # @option params [Hash] content_view_definition
23
+ # allowed keys are:
24
+ # * description [String, nil] definition description ,
25
+ # * label [String] content view identifier ,
26
+ # * name [String] content view definition name ,
27
+ # @option params [String] organization_id organization identifier
28
+ #
29
+ # @param [Hash] headers additional http headers
30
+ def create(params = { }, headers = { })
31
+ check_params params, :allowed => true, :method => __method__
32
+ url, params = fill_params_in_url "/api/content_view_definitions", params
33
+ call(:"post", url, params, headers)
34
+ end
35
+
36
+ # @param [Hash] params a hash of params to be passed to the service
37
+ # @option params [String] id definition identifer
38
+ # @option params [Hash] content_view_definition
39
+ # allowed keys are:
40
+ # * description [String, nil] definition description ,
41
+ # * name [String] content view definition name ,
42
+ # @option params [String] org organization name
43
+ #
44
+ # @param [Hash] headers additional http headers
45
+ def update(params = { }, headers = { })
46
+ check_params params, :allowed => true, :method => __method__
47
+ url, params = fill_params_in_url "/api/organizations/:org/content_view_definitions/:id", params
48
+ call(:"put", url, params, headers)
49
+ end
50
+
51
+ # @param [Hash] params a hash of params to be passed to the service
52
+ # @option params [String] id definition identifier
53
+ #
54
+ # @param [Hash] headers additional http headers
55
+ def show(params = { }, headers = { })
56
+ check_params params, :allowed => true, :method => __method__
57
+ url, params = fill_params_in_url "/api/content_view_definitions/:id", params
58
+ call(:"get", url, params, headers)
59
+ end
60
+
61
+ # @param [Hash] params a hash of params to be passed to the service
62
+ # @option params [String] id definition identifier
63
+ # @option params [String] description description for the new content view
64
+ # @option params [String] label label for the new content view
65
+ # @option params [String] name name for the new content view
66
+ #
67
+ # @param [Hash] headers additional http headers
68
+ def publish(params = { }, headers = { })
69
+ check_params params, :allowed => true, :method => __method__
70
+ url, params = fill_params_in_url "/api/organizations/:name/content_view_definitions/:id/publish", params
71
+ call(:"post", url, params, headers)
72
+ end
73
+
74
+ # @param [Hash] params a hash of params to be passed to the service
75
+ # @option params [String] id definition identifier
76
+ #
77
+ # @param [Hash] headers additional http headers
78
+ def destroy(params = { }, headers = { })
79
+ check_params params, :allowed => true, :method => __method__
80
+ url, params = fill_params_in_url "/api/content_view_definitions/:id", params
81
+ call(:"delete", url, params, headers)
82
+ end
83
+
84
+ # @param [Hash] params a hash of params to be passed to the service
85
+ # @option params [String] id definition identifier
86
+ #
87
+ # @param [Hash] headers additional http headers
88
+ def content_views(params = { }, headers = { })
89
+ check_params params, :allowed => true, :method => __method__
90
+ url, params = fill_params_in_url "/api/content_view_definitions/:id/content_views", params
91
+ call(:"get", url, params, headers)
92
+ end
93
+
94
+ # @param [Hash] params a hash of params to be passed to the service
95
+ # @option params [String] id definition identifier
96
+ # @option params [String] views updated list of view ids
97
+ #
98
+ # @param [Hash] headers additional http headers
99
+ def update_content_views(params = { }, headers = { })
100
+ check_params params, :allowed => true, :method => __method__
101
+ url, params = fill_params_in_url "/api/content_view_definitions/:id/content_views", params
102
+ call(:"put", url, params, headers)
103
+ end
104
+
105
+ end
106
+ end
107
+ end
@@ -0,0 +1,19 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class Crl < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["crls"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ #
10
+ # @param [Hash] headers additional http headers
11
+ def index(params = { }, headers = { })
12
+ check_params params, :allowed => false, :method => __method__
13
+ url, params = fill_params_in_url "/api/crls", params
14
+ call(:"get", url, params, headers)
15
+ end
16
+
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,29 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class Distribution < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["distributions"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ #
10
+ # @param [Hash] headers additional http headers
11
+ def index(params = { }, headers = { })
12
+ check_params params, :allowed => false, :method => __method__
13
+ url, params = fill_params_in_url "/api/repositories/:repository_id/distributions", params
14
+ call(:"get", url, params, headers)
15
+ end
16
+
17
+ # @param [Hash] params a hash of params to be passed to the service
18
+ # @option params [String] repository_id repository numeric id
19
+ #
20
+ # @param [Hash] headers additional http headers
21
+ def show(params = { }, headers = { })
22
+ check_params params, :allowed => true, :method => __method__
23
+ url, params = fill_params_in_url "/api/repositories/:repository_id/distributions/:id", params
24
+ call(:"get", url, params, headers)
25
+ end
26
+
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,112 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class Distributor < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["distributors"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [Hash] facts key-value hash of distributor-specific facts
10
+ # @option params [String] installedProducts list of products installed on the distributor
11
+ # @option params [String] location physical of the distributor
12
+ # @option params [String] name name of the distributor
13
+ # @option params [String] releaseVer release of the os. the $releasever variable in repo url will be replaced with this value
14
+ # @option params [String, nil] serviceLevel a service level for auto-healing process, e.g. self-support
15
+ # @option params [String] type type of the distributor, it should always be ‘distributor’
16
+ #
17
+ # @param [Hash] headers additional http headers
18
+ def create(params = { }, headers = { })
19
+ check_params params, :allowed => true, :method => __method__
20
+ url, params = fill_params_in_url "/api/environments/:environment_id/distributors", params
21
+ call(:"post", url, params, headers)
22
+ end
23
+
24
+ # @param [Hash] params a hash of params to be passed to the service
25
+ # @option params [Hash] facts key-value hash of distributor-specific facts
26
+ # @option params [String] installedProducts list of products installed on the distributor
27
+ # @option params [String] location physical of the distributor
28
+ # @option params [String] name name of the distributor
29
+ # @option params [String] releaseVer release of the os. the $releasever variable in repo url will be replaced with this value
30
+ # @option params [String, nil] serviceLevel a service level for auto-healing process, e.g. self-support
31
+ #
32
+ # @param [Hash] headers additional http headers
33
+ def update(params = { }, headers = { })
34
+ check_params params, :allowed => true, :method => __method__
35
+ url, params = fill_params_in_url "/api/distributors/:id", params
36
+ call(:"put", url, params, headers)
37
+ end
38
+
39
+ # @param [Hash] params a hash of params to be passed to the service
40
+ # @option params [String] name filter distributors by name
41
+ # @option params [String] pool_id filter distributors by subscribed pool
42
+ #
43
+ # @param [Hash] headers additional http headers
44
+ def index(params = { }, headers = { })
45
+ check_params params, :allowed => true, :method => __method__
46
+ url, params = fill_params_in_url "/api/environments/:environment_id/distributors", params
47
+ call(:"get", url, params, headers)
48
+ end
49
+
50
+ # @param [Hash] params a hash of params to be passed to the service
51
+ # @option params [String] id uuid of the distributor
52
+ #
53
+ # @param [Hash] headers additional http headers
54
+ def show(params = { }, headers = { })
55
+ check_params params, :allowed => true, :method => __method__
56
+ url, params = fill_params_in_url "/api/distributors/:id", params
57
+ call(:"get", url, params, headers)
58
+ end
59
+
60
+ # @param [Hash] params a hash of params to be passed to the service
61
+ # @option params [String] id uuid of the distributor
62
+ #
63
+ # @param [Hash] headers additional http headers
64
+ def destroy(params = { }, headers = { })
65
+ check_params params, :allowed => true, :method => __method__
66
+ url, params = fill_params_in_url "/api/distributors/:id", params
67
+ call(:"delete", url, params, headers)
68
+ end
69
+
70
+ # @param [Hash] params a hash of params to be passed to the service
71
+ # @option params [String] id uuid of the distributor
72
+ #
73
+ # @param [Hash] headers additional http headers
74
+ def pools(params = { }, headers = { })
75
+ check_params params, :allowed => true, :method => __method__
76
+ url, params = fill_params_in_url "/api/distributors/:id/pools", params
77
+ call(:"get", url, params, headers)
78
+ end
79
+
80
+ # @param [Hash] params a hash of params to be passed to the service
81
+ #
82
+ # @param [Hash] headers additional http headers
83
+ def report(params = { }, headers = { })
84
+ check_params params, :allowed => false, :method => __method__
85
+ url, params = fill_params_in_url "/api/environments/:environment_id/distributors/report", params
86
+ call(:"get", url, params, headers)
87
+ end
88
+
89
+ # @param [Hash] params a hash of params to be passed to the service
90
+ # @option params [String] distributor_name name of the distributor
91
+ # @option params [String] distributor_uuid uuid of the distributor
92
+ #
93
+ # @param [Hash] headers additional http headers
94
+ def tasks(params = { }, headers = { })
95
+ check_params params, :allowed => true, :method => __method__
96
+ url, params = fill_params_in_url "/api/organizations/:organization_id/distributors/tasks", params
97
+ call(:"get", url, params, headers)
98
+ end
99
+
100
+ # @param [Hash] params a hash of params to be passed to the service
101
+ # @option params [String] id uuid of the task
102
+ #
103
+ # @param [Hash] headers additional http headers
104
+ def task_show(params = { }, headers = { })
105
+ check_params params, :allowed => true, :method => __method__
106
+ url, params = fill_params_in_url "/api/distributors/tasks/:id", params
107
+ call(:"get", url, params, headers)
108
+ end
109
+
110
+ end
111
+ end
112
+ end
@@ -0,0 +1,71 @@
1
+ module KatelloApi
2
+ module Resources
3
+ class Domain < KatelloApi::Base
4
+ def self.doc
5
+ @doc ||= KatelloApi.doc['resources']["domains"]
6
+ end
7
+
8
+ # @param [Hash] params a hash of params to be passed to the service
9
+ # @option params [String] order sort results
10
+ # @option params [String] search filter results
11
+ #
12
+ # @param [Hash] headers additional http headers
13
+ def index(params = { }, headers = { })
14
+ check_params params, :allowed => true, :method => __method__
15
+ url, params = fill_params_in_url "/api/domains", params
16
+ call(:"get", url, params, headers)
17
+ end
18
+
19
+ # @param [Hash] params a hash of params to be passed to the service
20
+ # @option params [String] id domain name (no slashes)
21
+ #
22
+ # @param [Hash] headers additional http headers
23
+ def show(params = { }, headers = { })
24
+ check_params params, :allowed => true, :method => __method__
25
+ url, params = fill_params_in_url "/api/domains/:id", params
26
+ call(:"get", url, params, headers)
27
+ end
28
+
29
+ # @param [Hash] params a hash of params to be passed to the service
30
+ # @option params [Hash] domain
31
+ # allowed keys are:
32
+ # * dns_id [String, nil] dns proxy to use within this domain ,
33
+ # * domain_parameters_attributes [String, nil] array of parameters (name, value) ,
34
+ # * fullname [String, nil] full name describing the domain ,
35
+ # * name [String] the full dns domain name ,
36
+ #
37
+ # @param [Hash] headers additional http headers
38
+ def create(params = { }, headers = { })
39
+ check_params params, :allowed => true, :method => __method__
40
+ url, params = fill_params_in_url "/api/domains", params
41
+ call(:"post", url, params, headers)
42
+ end
43
+
44
+ # @param [Hash] params a hash of params to be passed to the service
45
+ # @option params [Hash] domain
46
+ # allowed keys are:
47
+ # * dns_id [String, nil] dns proxy to use within this domain ,
48
+ # * domain_parameters_attributes [String, nil] array of parameters (name, value) ,
49
+ # * fullname [String, nil] full name describing the domain ,
50
+ # * name [String] the full dns domain name ,
51
+ #
52
+ # @param [Hash] headers additional http headers
53
+ def update(params = { }, headers = { })
54
+ check_params params, :allowed => true, :method => __method__
55
+ url, params = fill_params_in_url "/api/domains/:id", params
56
+ call(:"put", url, params, headers)
57
+ end
58
+
59
+ # @param [Hash] params a hash of params to be passed to the service
60
+ # @option params [String] id domain name (no slashes)
61
+ #
62
+ # @param [Hash] headers additional http headers
63
+ def destroy(params = { }, headers = { })
64
+ check_params params, :allowed => true, :method => __method__
65
+ url, params = fill_params_in_url "/api/domains/:id", params
66
+ call(:"delete", url, params, headers)
67
+ end
68
+
69
+ end
70
+ end
71
+ end