Class: Asana::Resources::CustomFieldsBase
- Defined in:
- lib/asana/resources/gen/custom_fields_base.rb
Direct Known Subclasses
Class Method Summary collapse
-
.create_custom_field(client, options: {}, **data) ⇒ Object
options - [Hash] the request I/O options > offset - [str] Offset token.
-
.create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Create an enum option.
-
.delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) ⇒ Object
Delete a custom field.
-
.get_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) ⇒ Object
Get a custom field.
-
.get_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) ⇒ Object
Get a workspace’s custom fields.
- .inherited(base) ⇒ Object
-
.insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Reorder a custom field’s enum.
-
.update_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Update a custom field.
-
.update_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data) ⇒ Object
Update an enum option.
Methods inherited from Resource
#initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s
Methods included from ResponseHelper
Constructor Details
This class inherits a constructor from Asana::Resources::Resource
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Asana::Resources::Resource
Class Method Details
.create_custom_field(client, options: {}, **data) ⇒ Object
options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’ > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
24 25 26 27 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 24 def create_custom_field(client, options: {}, **data) path = "/custom_fields" CustomField.new(parse(client.post(path, body: data, options: )).first, client: client) end |
.create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Create an enum option
38 39 40 41 42 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 38 def create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) path = "/custom_fields/{custom_field_gid}/enum_options" path["{custom_field_gid}"] = custom_field_gid parse(client.post(path, body: data, options: )).first end |
.delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) ⇒ Object
Delete a custom field
50 51 52 53 54 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 50 def delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) path = "/custom_fields/{custom_field_gid}" path["{custom_field_gid}"] = custom_field_gid parse(client.delete(path, options: )).first end |
.get_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) ⇒ Object
Get a custom field
62 63 64 65 66 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 62 def get_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) path = "/custom_fields/{custom_field_gid}" path["{custom_field_gid}"] = custom_field_gid CustomField.new(parse(client.get(path, options: )).first, client: client) end |
.get_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) ⇒ Object
Get a workspace’s custom fields
76 77 78 79 80 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 76 def get_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) path = "/workspaces/{workspace_gid}/custom_fields" path["{workspace_gid}"] = workspace_gid Collection.new(parse(client.get(path, options: )), type: CustomField, client: client) end |
.inherited(base) ⇒ Object
10 11 12 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 10 def self.inherited(base) Registry.register(base) end |
.insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Reorder a custom field’s enum
89 90 91 92 93 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 89 def insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) path = "/custom_fields/{custom_field_gid}/enum_options/insert" path["{custom_field_gid}"] = custom_field_gid parse(client.post(path, body: data, options: )).first end |
.update_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) ⇒ Object
Update a custom field
102 103 104 105 106 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 102 def update_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) path = "/custom_fields/{custom_field_gid}" path["{custom_field_gid}"] = custom_field_gid CustomField.new(parse(client.put(path, body: data, options: )).first, client: client) end |
.update_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data) ⇒ Object
Update an enum option
115 116 117 118 119 |
# File 'lib/asana/resources/gen/custom_fields_base.rb', line 115 def update_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data) path = "/enum_options/{enum_option_gid}" path["{enum_option_gid}"] = enum_option_gid parse(client.put(path, body: data, options: )).first end |