Table of Contents - json_api_client-1.23.0 Documentation
Classes and Modules
- JsonApiClient
- JsonApiClient::Associations
- JsonApiClient::Associations::BaseAssociation
- JsonApiClient::Associations::BelongsTo
- JsonApiClient::Associations::BelongsTo::Association
- JsonApiClient::Associations::HasMany
- JsonApiClient::Associations::HasMany::Association
- JsonApiClient::Associations::HasOne
- JsonApiClient::Associations::HasOne::Association
- JsonApiClient::CamelizedKeyFormatter
- JsonApiClient::CamelizedRouteFormatter
- JsonApiClient::Connection
- JsonApiClient::DasherizedKeyFormatter
- JsonApiClient::DasherizedRouteFormatter
- JsonApiClient::DefaultValueFormatter
- JsonApiClient::ErrorCollector
- JsonApiClient::ErrorCollector::Error
- JsonApiClient::Errors
- JsonApiClient::Errors::AccessDenied
- JsonApiClient::Errors::ApiError
- JsonApiClient::Errors::BadGateway
- JsonApiClient::Errors::ClientError
- JsonApiClient::Errors::Conflict
- JsonApiClient::Errors::ConnectionError
- JsonApiClient::Errors::GatewayTimeout
- JsonApiClient::Errors::InternalServerError
- JsonApiClient::Errors::NotAuthorized
- JsonApiClient::Errors::NotFound
- JsonApiClient::Errors::RecordNotSaved
- JsonApiClient::Errors::RequestTimeout
- JsonApiClient::Errors::ResourceImmutableError
- JsonApiClient::Errors::ServerError
- JsonApiClient::Errors::ServiceUnavailable
- JsonApiClient::Errors::TooManyRequests
- JsonApiClient::Errors::UnexpectedStatus
- JsonApiClient::Formatter
- JsonApiClient::Helpers
- JsonApiClient::Helpers::Associatable
- JsonApiClient::Helpers::Associatable::ClassMethods
- JsonApiClient::Helpers::Callbacks
- JsonApiClient::Helpers::Dirty
- JsonApiClient::Helpers::DynamicAttributes
- JsonApiClient::Helpers::DynamicAttributes::DefaultKeyFormatter
- JsonApiClient::Helpers::URI
- JsonApiClient::IdValueFormatter
- JsonApiClient::Implementation
- JsonApiClient::IncludedData
- JsonApiClient::KeyFormatter
- JsonApiClient::Linking
- JsonApiClient::Linking::Links
- JsonApiClient::Linking::TopLevelLinks
- JsonApiClient::MetaData
- JsonApiClient::Middleware
- JsonApiClient::Middleware::JsonRequest
- JsonApiClient::Middleware::Status
- JsonApiClient::Paginating
- JsonApiClient::Paginating::NestedParamPaginator
- JsonApiClient::Paginating::Paginator
- JsonApiClient::Parsers
- JsonApiClient::Parsers::Parser
- JsonApiClient::Query
- JsonApiClient::Query::Builder
- JsonApiClient::Query::Requestor
- JsonApiClient::Relationships
- JsonApiClient::Relationships::Relations
- JsonApiClient::Relationships::TopLevelRelations
- JsonApiClient::RequestParams
- JsonApiClient::Resource
- JsonApiClient::ResultSet
- JsonApiClient::RouteFormatter
- JsonApiClient::Schema
- JsonApiClient::Schema::TypeFactory
- JsonApiClient::Schema::Types
- JsonApiClient::Schema::Types::Boolean
- JsonApiClient::Schema::Types::Decimal
- JsonApiClient::Schema::Types::Float
- JsonApiClient::Schema::Types::Integer
- JsonApiClient::Schema::Types::String
- JsonApiClient::Schema::Types::Time
- JsonApiClient::UnderscoredKeyFormatter
- JsonApiClient::UnderscoredRouteFormatter
- JsonApiClient::Utils
- JsonApiClient::ValueFormatter
Methods
- ::_belongs_to_associations — JsonApiClient::Resource
- ::_build_connection — JsonApiClient::Resource
- ::_custom_headers= — JsonApiClient::Resource
- ::_header_store — JsonApiClient::Resource
- ::_name_for_route_format — JsonApiClient::Resource
- ::_new_scope — JsonApiClient::Resource
- ::_prefix_path — JsonApiClient::Resource
- ::_set_prefix_path — JsonApiClient::Resource
- ::cast — JsonApiClient::Schema::Types::Integer
- ::cast — JsonApiClient::Schema::Types::String
- ::cast — JsonApiClient::Schema::Types::Float
- ::cast — JsonApiClient::Schema::Types::Time
- ::cast — JsonApiClient::Schema::Types::Decimal
- ::cast — JsonApiClient::Schema::Types::Boolean
- ::collection_endpoint — JsonApiClient::Resource
- ::compute_type — JsonApiClient::Utils
- ::connection — JsonApiClient::Resource
- ::create — JsonApiClient::Resource
- ::create! — JsonApiClient::Resource
- ::custom_endpoint — JsonApiClient::Resource
- ::custom_headers — JsonApiClient::Resource
- ::default_attributes — JsonApiClient::Resource
- ::format — JsonApiClient::Formatter
- ::format — JsonApiClient::KeyFormatter
- ::format — JsonApiClient::RouteFormatter
- ::format — JsonApiClient::ValueFormatter
- ::format — JsonApiClient::CamelizedKeyFormatter
- ::format — JsonApiClient::DasherizedKeyFormatter
- ::format — JsonApiClient::DefaultValueFormatter
- ::format — JsonApiClient::IdValueFormatter
- ::format — JsonApiClient::CamelizedRouteFormatter
- ::format — JsonApiClient::DasherizedRouteFormatter
- ::format_keys — JsonApiClient::KeyFormatter
- ::formatter_for — JsonApiClient::Formatter
- ::handle_data — JsonApiClient::Parsers::Parser
- ::handle_errors — JsonApiClient::Parsers::Parser
- ::handle_included — JsonApiClient::Parsers::Parser
- ::handle_json_api — JsonApiClient::Parsers::Parser
- ::handle_links — JsonApiClient::Parsers::Parser
- ::handle_meta — JsonApiClient::Parsers::Parser
- ::handle_pagination — JsonApiClient::Parsers::Parser
- ::handle_relationships — JsonApiClient::Parsers::Parser
- ::immutable — JsonApiClient::Resource
- ::inherited — JsonApiClient::Resource
- ::key_formatter — JsonApiClient::Resource
- ::load — JsonApiClient::Resource
- ::member_endpoint — JsonApiClient::Resource
- ::new — JsonApiClient::Associations::BaseAssociation
- ::new — JsonApiClient::Associations::BelongsTo::Association
- ::new — JsonApiClient::Connection
- ::new — JsonApiClient::ErrorCollector
- ::new — JsonApiClient::ErrorCollector::Error
- ::new — JsonApiClient::Errors::ApiError
- ::new — JsonApiClient::Errors::ResourceImmutableError
- ::new — JsonApiClient::Errors::NotFound
- ::new — JsonApiClient::Errors::Conflict
- ::new — JsonApiClient::Errors::ServerError
- ::new — JsonApiClient::Errors::UnexpectedStatus
- ::new — JsonApiClient::Errors::RecordNotSaved
- ::new — JsonApiClient::Implementation
- ::new — JsonApiClient::IncludedData
- ::new — JsonApiClient::Linking::Links
- ::new — JsonApiClient::Linking::TopLevelLinks
- ::new — JsonApiClient::MetaData
- ::new — JsonApiClient::Middleware::Status
- ::new — JsonApiClient::Paginating::NestedParamPaginator
- ::new — JsonApiClient::Paginating::Paginator
- ::new — JsonApiClient::Query::Builder
- ::new — JsonApiClient::Query::Requestor
- ::new — JsonApiClient::Relationships::Relations
- ::new — JsonApiClient::Relationships::TopLevelRelations
- ::new — JsonApiClient::RequestParams
- ::new — JsonApiClient::Resource
- ::new — JsonApiClient::Schema
- ::page_param — JsonApiClient::Paginating::NestedParamPaginator
- ::page_param= — JsonApiClient::Paginating::NestedParamPaginator
- ::parameters_from_resource — JsonApiClient::Parsers::Parser
- ::parse — JsonApiClient::Parsers::Parser
- ::parse_includes — JsonApiClient::Utils
- ::path — JsonApiClient::Resource
- ::per_page_param — JsonApiClient::Paginating::NestedParamPaginator
- ::per_page_param= — JsonApiClient::Paginating::NestedParamPaginator
- ::prefix_params — JsonApiClient::Resource
- ::properties — JsonApiClient::Resource
- ::property — JsonApiClient::Resource
- ::register — JsonApiClient::Schema
- ::register — JsonApiClient::Schema::TypeFactory
- ::requestor — JsonApiClient::Resource
- ::resolve_custom_type — JsonApiClient::Resource
- ::resource_name — JsonApiClient::Resource
- ::resource_path — JsonApiClient::Resource
- ::route_formatter — JsonApiClient::Resource
- ::schema — JsonApiClient::Resource
- ::table_name — JsonApiClient::Resource
- ::type — JsonApiClient::Resource
- ::type_for — JsonApiClient::Schema::TypeFactory
- ::unformat — JsonApiClient::Formatter
- ::unformat — JsonApiClient::KeyFormatter
- ::unformat — JsonApiClient::RouteFormatter
- ::unformat — JsonApiClient::ValueFormatter
- ::unformat — JsonApiClient::CamelizedKeyFormatter
- ::unformat — JsonApiClient::DasherizedKeyFormatter
- ::unformat — JsonApiClient::CamelizedRouteFormatter
- ::unformat — JsonApiClient::DasherizedRouteFormatter
- ::valid_param? — JsonApiClient::Paginating::NestedParamPaginator
- ::value_formatter_for — JsonApiClient::ValueFormatter
- ::with_headers — JsonApiClient::Resource
- ::wrapper_name — JsonApiClient::Paginating::NestedParamPaginator
- ::wrapper_name= — JsonApiClient::Paginating::NestedParamPaginator
- #== — JsonApiClient::Query::Builder
- #[] — JsonApiClient::ErrorCollector
- #[] — JsonApiClient::Schema
- #[] — JsonApiClient::Helpers::DynamicAttributes
- #[]= — JsonApiClient::Helpers::DynamicAttributes
- #_belongs_to_params — JsonApiClient::Helpers::Associatable
- #_cached_associations — JsonApiClient::Helpers::Associatable
- #_cached_relationship — JsonApiClient::Helpers::Associatable
- #_clear_belongs_to_params — JsonApiClient::Helpers::Associatable
- #_clear_cached_relationship — JsonApiClient::Helpers::Associatable
- #_clear_cached_relationships — JsonApiClient::Helpers::Associatable
- #_define_association — JsonApiClient::Helpers::Associatable::ClassMethods
- #_define_relationship_methods — JsonApiClient::Helpers::Associatable::ClassMethods
- #_fetch — JsonApiClient::Query::Builder
- #_new_scope — JsonApiClient::Query::Builder
- #about — JsonApiClient::ErrorCollector::Error
- #add — JsonApiClient::Schema
- #add_includes — JsonApiClient::RequestParams
- #additional_params — JsonApiClient::Query::Builder
- #all — JsonApiClient::Query::Builder
- #as_json — JsonApiClient::Relationships::Relations
- #as_json — JsonApiClient::Resource
- #as_json_api — JsonApiClient::Relationships::Relations
- #as_json_api — JsonApiClient::Resource
- #as_relation — JsonApiClient::Resource
- #association_class — JsonApiClient::Associations::BaseAssociation
- #association_for — JsonApiClient::Resource
- #attribute_change — JsonApiClient::Helpers::Dirty
- #attribute_changed? — JsonApiClient::Helpers::Dirty
- #attribute_will_change! — JsonApiClient::Helpers::Dirty
- #attributes — JsonApiClient::Helpers::DynamicAttributes
- #attributes= — JsonApiClient::Helpers::DynamicAttributes
- #attributes_for_serialization — JsonApiClient::Relationships::Relations
- #attributes_for_serialization — JsonApiClient::Resource
- #belongs_to — JsonApiClient::Helpers::Associatable::ClassMethods
- #build — JsonApiClient::Query::Builder
- #call — JsonApiClient::Middleware::JsonRequest
- #call — JsonApiClient::Middleware::Status
- #changed — JsonApiClient::Helpers::Dirty
- #changed? — JsonApiClient::Helpers::Dirty
- #changed_attributes — JsonApiClient::Helpers::Dirty
- #clear — JsonApiClient::RequestParams
- #clear_changes_information — JsonApiClient::Helpers::Dirty
- #code — JsonApiClient::ErrorCollector::Error
- #create — JsonApiClient::Query::Builder
- #create — JsonApiClient::Query::Requestor
- #current_page — JsonApiClient::Paginating::NestedParamPaginator
- #current_page — JsonApiClient::Paginating::Paginator
- #custom — JsonApiClient::Query::Requestor
- #custom_handler_for — JsonApiClient::Middleware::Status
- #data — JsonApiClient::Associations::BaseAssociation
- #data_for — JsonApiClient::IncludedData
- #delete — JsonApiClient::Connection
- #destroy — JsonApiClient::Query::Requestor
- #destroy — JsonApiClient::Resource
- #destroy — JsonApiClient::Helpers::Callbacks
- #destroyed? — JsonApiClient::Resource
- #detail — JsonApiClient::ErrorCollector::Error
- #each — JsonApiClient::Schema
- #each_property — JsonApiClient::Schema
- #encode_part — JsonApiClient::Helpers::URI
- #eql? — JsonApiClient::Query::Builder
- #error_key — JsonApiClient::ErrorCollector::Error
- #error_message_for — JsonApiClient::Resource
- #error_msg — JsonApiClient::ErrorCollector::Error
- #fetch_link — JsonApiClient::Linking::TopLevelLinks
- #fetch_relation — JsonApiClient::Relationships::TopLevelRelations
- #field_types — JsonApiClient::RequestParams
- #fill_errors — JsonApiClient::Resource
- #filter_params — JsonApiClient::Query::Builder
- #find — JsonApiClient::Query::Builder
- #find — JsonApiClient::Schema
- #first — JsonApiClient::Paginating::NestedParamPaginator
- #first — JsonApiClient::Paginating::Paginator
- #first — JsonApiClient::Query::Builder
- #forget_change! — JsonApiClient::Helpers::Dirty
- #from_result_set — JsonApiClient::Associations::BaseAssociation
- #from_result_set — JsonApiClient::Associations::HasOne::Association
- #full_messages — JsonApiClient::ErrorCollector
- #get — JsonApiClient::Query::Requestor
- #handle_status — JsonApiClient::Middleware::Status
- #has_attribute? — JsonApiClient::Resource
- #has_attribute? — JsonApiClient::Helpers::DynamicAttributes
- #has_errors? — JsonApiClient::ResultSet
- #has_link? — JsonApiClient::IncludedData
- #has_many — JsonApiClient::Helpers::Associatable::ClassMethods
- #has_one — JsonApiClient::Helpers::Associatable::ClassMethods
- #hash — JsonApiClient::Query::Builder
- #id — JsonApiClient::ErrorCollector::Error
- #included_data_for — JsonApiClient::Resource
- #includes — JsonApiClient::Query::Builder
- #includes_params — JsonApiClient::Query::Builder
- #inspect — JsonApiClient::Resource
- #key_formatter — JsonApiClient::MetaData
- #key_formatter — JsonApiClient::Helpers::DynamicAttributes
- #last — JsonApiClient::Paginating::NestedParamPaginator
- #last — JsonApiClient::Paginating::Paginator
- #last — JsonApiClient::Query::Builder
- #length — JsonApiClient::Schema
- #limit_value — JsonApiClient::Paginating::NestedParamPaginator
- #limit_value — JsonApiClient::Paginating::Paginator
- #link_url_for — JsonApiClient::Linking::TopLevelLinks
- #linked — JsonApiClient::Query::Requestor
- #load_records — JsonApiClient::Associations::BaseAssociation
- #load_records — JsonApiClient::Associations::HasOne::Association
- #mark_as_destroyed! — JsonApiClient::Resource
- #mark_as_persisted! — JsonApiClient::Resource
- #message — JsonApiClient::Errors::RecordNotSaved
- #meta — JsonApiClient::ErrorCollector::Error
- #method_missing — JsonApiClient::Linking::TopLevelLinks
- #method_missing — JsonApiClient::Query::Builder
- #method_missing — JsonApiClient::Relationships::TopLevelRelations
- #method_missing — JsonApiClient::Resource
- #method_missing — JsonApiClient::Helpers::Dirty
- #method_missing — JsonApiClient::Helpers::DynamicAttributes
- #new_record? — JsonApiClient::Resource
- #next — JsonApiClient::Paginating::NestedParamPaginator
- #next — JsonApiClient::Paginating::Paginator
- #next_page — JsonApiClient::Paginating::NestedParamPaginator
- #next_page — JsonApiClient::Paginating::Paginator
- #non_serializing_attributes — JsonApiClient::Resource
- #offset — JsonApiClient::Paginating::NestedParamPaginator
- #offset — JsonApiClient::Paginating::Paginator
- #order — JsonApiClient::Query::Builder
- #order_params — JsonApiClient::Query::Builder
- #out_of_bounds? — JsonApiClient::Paginating::NestedParamPaginator
- #out_of_bounds? — JsonApiClient::Paginating::Paginator
- #page — JsonApiClient::Query::Builder
- #page_param — JsonApiClient::Paginating::NestedParamPaginator
- #paginate — JsonApiClient::Query::Builder
- #pagination_params — JsonApiClient::Query::Builder
- #params — JsonApiClient::Query::Builder
- #params_for_uri — JsonApiClient::Paginating::NestedParamPaginator
- #params_for_uri — JsonApiClient::Paginating::Paginator
- #parse_fields — JsonApiClient::Query::Builder
- #parse_orders — JsonApiClient::Query::Builder
- #parse_related_links — JsonApiClient::Query::Builder
- #parsed_fields — JsonApiClient::RequestParams
- #parsed_includes — JsonApiClient::RequestParams
- #path_attributes — JsonApiClient::Resource
- #path_params — JsonApiClient::Query::Builder
- #per — JsonApiClient::Query::Builder
- #per_page — JsonApiClient::Paginating::NestedParamPaginator
- #per_page — JsonApiClient::Paginating::Paginator
- #per_page_param — JsonApiClient::Paginating::NestedParamPaginator
- #persisted? — JsonApiClient::Resource
- #present? — JsonApiClient::Linking::Links
- #present? — JsonApiClient::Relationships::Relations
- #prev — JsonApiClient::Paginating::NestedParamPaginator
- #prev — JsonApiClient::Paginating::Paginator
- #previous_page — JsonApiClient::Paginating::NestedParamPaginator
- #previous_page — JsonApiClient::Paginating::Paginator
- #primary_key_params — JsonApiClient::Query::Builder
- #property_for — JsonApiClient::Resource
- #read_attribute — JsonApiClient::Helpers::DynamicAttributes
- #record_for — JsonApiClient::IncludedData
- #relation_objects_for — JsonApiClient::Resource
- #relationship_data_for — JsonApiClient::Resource
- #relationship_definition_for — JsonApiClient::Resource
- #relationships_for_serialization — JsonApiClient::Resource
- #remove_fields — JsonApiClient::RequestParams
- #request — JsonApiClient::Query::Requestor
- #request_includes — JsonApiClient::Resource
- #request_select — JsonApiClient::Resource
- #reset_includes! — JsonApiClient::RequestParams
- #reset_request_includes! — JsonApiClient::Resource
- #reset_request_select! — JsonApiClient::Resource
- #resource_path — JsonApiClient::Query::Requestor
- #respond_to_missing? — JsonApiClient::Linking::TopLevelLinks
- #respond_to_missing? — JsonApiClient::Relationships::TopLevelRelations
- #respond_to_missing? — JsonApiClient::Resource
- #respond_to_missing? — JsonApiClient::Helpers::DynamicAttributes
- #run — JsonApiClient::Connection
- #safe_key_formatter — JsonApiClient::Helpers::DynamicAttributes
- #save — JsonApiClient::Resource
- #save — JsonApiClient::Helpers::Callbacks
- #select — JsonApiClient::Query::Builder
- #select_params — JsonApiClient::Query::Builder
- #set_all_attributes_dirty — JsonApiClient::Helpers::Dirty
- #set_all_dirty! — JsonApiClient::Resource
- #set_attribute — JsonApiClient::Linking::Links
- #set_attribute — JsonApiClient::Relationships::Relations
- #set_attribute — JsonApiClient::Resource
- #set_attribute — JsonApiClient::Helpers::Dirty
- #set_attribute — JsonApiClient::Helpers::DynamicAttributes
- #set_attribute_was — JsonApiClient::Helpers::Dirty
- #set_fields — JsonApiClient::RequestParams
- #set_prefix_path — JsonApiClient::Associations::BelongsTo::Association
- #setup_default_properties — JsonApiClient::Resource
- #shallow_path? — JsonApiClient::Associations::BelongsTo::Association
- #size — JsonApiClient::Schema
- #source — JsonApiClient::ErrorCollector::Error
- #source_parameter — JsonApiClient::ErrorCollector::Error
- #source_pointer — JsonApiClient::ErrorCollector::Error
- #status — JsonApiClient::ErrorCollector::Error
- #title — JsonApiClient::ErrorCollector::Error
- #to_a — JsonApiClient::Query::Builder
- #to_params — JsonApiClient::RequestParams
- #to_prefix_path — JsonApiClient::Associations::BelongsTo::Association
- #total_count — JsonApiClient::Paginating::NestedParamPaginator
- #total_count — JsonApiClient::Paginating::Paginator
- #total_entries — JsonApiClient::Paginating::NestedParamPaginator
- #total_entries — JsonApiClient::Paginating::Paginator
- #total_pages — JsonApiClient::Paginating::NestedParamPaginator
- #total_pages — JsonApiClient::Paginating::Paginator
- #track_json_api_errors — JsonApiClient::Errors::ApiError
- #unformat — JsonApiClient::Helpers::DynamicAttributes::DefaultKeyFormatter
- #update — JsonApiClient::Query::Requestor
- #update — JsonApiClient::Resource
- #update! — JsonApiClient::Resource
- #update_accept_header — JsonApiClient::Middleware::JsonRequest
- #update_attributes — JsonApiClient::Resource
- #update_attributes! — JsonApiClient::Resource
- #use — JsonApiClient::Connection
- #valid? — JsonApiClient::Resource
- #where — JsonApiClient::Query::Builder
- #with_params — JsonApiClient::Query::Builder