{
  "name": "junifer_au_native_api",
  "version": "1.62.0",
  "description": "Junifer_Native_Web_API_provided_by_the_Gentrack_Cloud_Integration_Services_How_It_WorksFor_how_to_prepare_your_application_to_call_Junifer_Native_Web_API_please_refer_to__Read_me_first_https__portal_integration_gentrack_cloud_api_index_htmlsection_Read_me_first__Sovereignty_Regions_https__portal_integration_gentrack_cloud_api_index_htmlsection_Sovereignty_Regions__Preparing_your_request_https__portal_integration_gentrack_cloud_api_index_htmlsection_Preparing_your_request__Authentication_https__portal_integration_gentrack_cloud_api_index_htmlsection_Authentication__Responses_https__portal_integration_gentrack_cloud_api_index_htmlsection_Responses_Sample_of_requesting_contact_detailsThe_following_is_an_example_of_calling_get_contact_details_API_in_UK_regionbashcurl__X_GET______https__api_uk_integration_gentrack_cloud_v1_junifer_contacts_1010_______H_Authorization_Bearer_eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9_eyJhcHBJZCI6IjA2NDYxODczLTFlOWMtNGVkMy1iZWZkLTU3NGY5ZmEwYjExYyIsIm9yZ0lkIjoiQzAwMDAiLCJ0b2tlbl91c2UiOiJhY2Nlc3MiLCJpYXQiOjE1MzA1ODkwODcsImV4cCI6MTUzMDU5MjY4NywiaXNzIjoiaHR0cHM6Ly9hcGkuZ2VudHJhY2suaW8vIn0_WUAFYWTTEAyQ0Bt4YXu_mxCXd_Y9ehwdZcYvcGNnyLTZH_hiJjtXWWfsx69M606pvCP6lLMT7MfK_F3E4rLO6KAlGsuz4A_7oVWQf4QNeR178GnwgmqQRw5OnLxwPbPrRa9nODngwGq8dcWejhmEYU6iw02bvYdQBHnnsc3Kpyzw7Wdv_3jnBS4TPYS20muQOgG6KxRp9hLJM7ERLoAbsULwqdPOV8eUJJhGrq1NDuH_lA83YRDZmCWEzw96tSm3hb7y88kXs_4OvamnO1m5wFPBx69VximlS4Ltr3ztqU2s3fHoj0OJLIafge9JvTgvuB6noHfs1uSRaahvstGJAAThe_sample_of_response_is_as_follows_json___id_1010___contactType_Business___title_Mr___forename_Tony___surname_Soprano___email_bigtonedidntseeanything_com___dateOfBirth_1959_08_24___phoneNumber1_44626478370___address_____address1_633_Stag_Trail_Road_____address2_North_Caldwell_____address3_New_Jersey_____postcode_NE18_0PY______links______self_https__api_uk_integration_gentrack_cloud_v1_junifer_contacts_1010_____accounts_https__api_uk_integration_gentrack_cloud_v1_junifer_contacts_1010_accounts____General_Rules_Patterns_NavigationA_links_section_is_returned_in_most_requests_This_section_contains_how_to_access_the_entity_itself_and_more_importantly_how_to_access_items_related_to_the_entity_For_example_take_the_following_responsejson__id_1__name_Mr_Joe_Bloggs__number_00000001__surname_Bloggs__links_____self_https__api_uk_integration_gentrack_cloud_v1_junifer_customers_1____accounts____________id_7______name_Invoice______number_00000001______currency_GBP______fromDt_2013_05_01______createdDttm_2013_05_08T133634_000______balance_0______billingAddress_________address1_11_Tuppy_Street____________links_________self_https__api_uk_integration_gentrack_cloud_v1_junifer_accounts_7________customer_https__api_uk_integration_gentrack_cloud_v1_junifer_customers_1________bills_https__api_uk_integration_gentrack_cloud_v1_junifer_accounts_7_bills________payments_https__api_uk_integration_gentrack_cloud_v1_junifer_accounts_7_payments____________The_self_URL_in_the_links_section_can_be_used_to_access_the_entities_listed_in_the_response_In_the_above_example_there_are_self_fields_for_the_customer_itself_and_the_accounts_under_this_customer_There_are_other_links_under_the_account_For_example_the_above_example_contains_links_for_the_following__bills__List_of_Bills_for_the_Account__payments__List_of_Payments_for_the_Account__customer__Link_back_to_the_Accounts_Customer_About_IDsThe_id_in_the_API_requests__JSON_payload_and_URL_and_responses_identifies_the_resource_within_the_API_It_has_no_business_meaning_or_purpose_therefore_shouldnt_be_exposed_to_the_end_user_in_any_way_As_the_IDs_of_the_resources_arent_sequential_or_aligned_with_any_other_resource_IDs_it_is_highly_recommended_using_the_links_section_from_the_responses_to_navigate_to_other_related_resources_Given_the_example_above_the_customer_with_ID_1_links_to_the_account_with_ID_7_The_links_section_will_populate_the_correct_IDs_in_the_URLs_so_none_of_the_assumptions_about_related_resource_IDs_need_to_be_made_by_the_implementer__Accessing_accounts_by_account_numberThroughout_this_API_anywhere_an_account_is_accessed_by_its_id__i_e__the_URL_includes__accounts_id_it_can_also_be_accessed_by_its_account_number_by_replacing__accounts_id_with_accounts_accountNumber_num_For_example_the_Create_Account_Credit_endpoint_available_at__accounts_id_accountCredits_can_also_be_accessed_at__accounts_accountNumber_num_accountCredits__Standard_data_types_in_JSONThe_standard_data_types_are_as_follows__String__Quoted_as_per_JSON_standard__Number__Unquoted_as_per_JSON_standard__Decimal__Unquoted_as_per_JSON_standard__Date__In_the_standard_ISO_format_yyyy_MM_dd__DateTime__In_the_standard_ISO_format_yyyy_MM_ddThhmmss_SSS__no_time_zone_component__Boolean__Unquoted_true_and_false_are_the_only_valid_values_Ordering_of_dataResponse_representations_are_not_ordered_unless_specified_on_a_specific_resource_Therefore_clients_should_be_implemented_to_use_the_name_of_fields_objects_as_the_key_for_accessing_data_For_example_in_JSON_objects_are_comprised_of_key_value_pairs_and_clients_should_be_implemented_to_search_on_the_key_value_rather_than_looking_for_the_nth_key_value_pair_in_the_object__Changes_of_dataResponse_representations_may_change_without_warning_in_the_following_ways___Additional_key_value_pairs_may_be_added_to_an_existing_object__Additional_sub_objects_may_be_added_to_an_existing_objectThese_changes_are_considered_non_breaking_Therefore_clients_should_be_implemented_to_consume_only_the_data_they_need_and_ignore_any_other_information__VersioningThe_API_is_usually_changed_in_each_release_of_Junifer__Navigate_to_different_versions_by_clicking_the_dropdown_menu_in_the_top_right_of_this_web_page__PaginationSome_REST_APIs_that_provide_a_list_of_results_support_pagination_Pagination_allows_API_users_to_query_potential_large_data_sets_but_only_receive_a_sub_set_of_the_results_on_the_initial_query__Subsequent_queries_can_use_the_response_of_a_prior_query_to_retrieve_the_next_or_previous_set_of_results_Pagination_functionality_and_behaviour_will_be_documented_on_each_API_that_requires_it__Pagination_on_existing_APIsExisting_APIs_may_have_pagination_support_added__In_the_future_this_pagination_will_become_mandatory_In_order_to_facilitate_API_users_planning_and_executing_upgrades_against_the_existing_APIs_pagination_is_optional_during_a_transition_period__API_users_can_enable_pagination_on_these_APIs_by_specifying_the_pagination_query_parameter__This_parameter_only_needs_to_be_present_the_value_is_not_required_or_checked__If_this_query_parameter_is_specified_then_pagination_will_be_enabled__Otherwise_the_existing_non_paginated_functionality_that_returns_all_results_will_be_used_API_users_must_plan_and_execute_upgrades_to_their_existing_applications_to_use_the_pagination_support_during_the_transition_period__At_the_end_of_the_transition_period_pagination_will_become_mandatory_on_these_APIs_For_new_APIs_that_support_pagination_it_will_be_mandatory_with_the_initial_release_of_the_API__OrderingThe_ordering_that_the_API_provides_will_be_documented_for_each_API_An_ordering_is_always_required_to_ensure_moving_between_pages_is_consistent_Some_APIs_may_define_an_ordering_on_a_value_or_values_in_the_response_where_appropriate__For_example_results_may_be_ordered_by_a_date_time_property_of_the_results_Other_APIs_may_not_define_an_explicit_ordering_but_will_guarantee_the_order_is_consistent_for_multiple_API_calls__Limiting_results_of_each_pageThe_desiredResults_query_parameter_can_be_used_to_specify_the_maximum_number_of_results_that_may_be_returned_The_APIs_treat_this_as_a_hint_so_API_callers_should_expect_to_sometimes_receive_a_different_number_of_results__APIs_will_endeavour_to_ensure_no_more_than_desiredResults_are_returned_but_for_small_values_of_desiredResults__less_than_10_this_may_not_be_possible__This_is_due_to_how_pages_of_data_are_structured_inside_the_product__The_API_will_prefer_to_return_some_data_rather_than_no_data_where_it_is_not_possible_to_return_less_than_desiredResultsIf_desiredResults_is_not_specified_the_default_maximum_value_for_the_API_will_be_used__Unless_documented_differently_this_value_is_100_If_desiredResults_is_specified_higher_than_the_default_maximum_for_the_API_a_400_error_response_will_be_received__CursorsThe_pagination_provided_by_the_APIs_is_cursor_based_In_the_JSON_response_additional_metadata_will_be_provided_when_pagination_is_present___after_cursor_points_to_the_start_of_the_results_that_have_been_returned__before_cursor_points_to_the_end_of_the_results_that_have_been_returnedThese_cursors_can_be_used_to_make_subsequent_API_calls__The_API_URL_should_be_unchanged_except_for_setting_the_before_or_after_query_parameter__If_both_parameters_are_specified_then_an_error_400_response_will_be_received_Cursor_tokens_must_only_be_used_for_pagination_purposes__API_users_should_not_infer_any_business_meaning_or_logic_from_cursor_representations__These_representations_may_change_without_warning_when_Junifer_is_upgraded_When_scrolling_forward_the_after_cursor_will_be_absent_from_the_response_when_there_are_no_more_results_after_the_current_set_When_scrolling_backwards_the_before_cursor_will_be_absent_from_the_response_when_there_are_no_more_results_before_the_current_set_In_addition_a_paginated_response_will_include_a_next_and_previous_URLs_for_convenience__Best_practicesThe_following_best_practices_must_be_adhered_to_by_users_of_the_pagination_APIs__Dont_store_cursors_or_next_and_previous_URLs_for_long__Cursors_can_quickly_become_invalid_if_items_are_added_or_deleted_to_the_data_set__If_an_invalid_cursor_is_used_then_a_404_response_will_be_returned_in_this_situation__API_users_should_design_a_policy_to_handle_this_situation__API_users_should_handle_empty_data_sets__In_limited_cases_a_pagination_query_using_a_previously_valid_cursor_may_return_no_results_ExampleThis_example_is_illustrative_only_A_small_desiredResults_parameter_has_been_used_to_make_the_example_concise__API_users_should_generally_choose_larger_values_subject_to_the_maximum_value_The_following_API_call_would_retrieve_the_first_set_of_results__Requestbashhttps__api_uk_integration_gentrack_cloud_v1_junifer_uk_meterPoints_1_payg_balancesdesiredResults3_______H_Authorization_Bearer_eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9____aahvstGJAA_Responsejson__results____________snapshotDateTime_2019_04_20T000000_000______creditBalance_109______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0______________snapshotDateTime_2019_04_19T000000_000______creditBalance_108______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0______________snapshotDateTime_2019_04_18T000000_000______creditBalance_107______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0________pagination_____cursors_______after_107________next_https__api_uk_integration_gentrack_cloud_v1_junifer_uk_meterPoints_1_payg_balancespaginationdesiredResults3after107__The_results_section_contains_the_payload_of_the_API_The_pagination_section_contains_details_needed_to_retrieve_additional_results_API_users_can_choose_to_use_the_next_URL_directly_or_use_the_after_cursor_token_to_construct_the_URL_themselves_The_API_call_to_query_the_next_set_of_results_would_be_Requestbashhttps__api_uk_integration_gentrack_cloud_v1_junifer_uk_meterPoints_1_payg_balancespaginationdesiredResults3after107_______H_Authorization_Bearer_eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9____aahvstGJAA_Responsejson__results____________snapshotDateTime_2019_04_17T000000_000______creditBalance_106______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0______________snapshotDateTime_2019_04_16T000000_000______creditBalance_105______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0______________snapshotDateTime_2019_04_15T000000_000______creditBalance_104______emergencyCreditBalance_0______accumulatedDebtRegister_0______timeDebtRegister1_0______timeDebtRegister2_0______paymentDebtRegister_0________pagination_____cursors_______before_106______after_104________previous_https__api_uk_integration_gentrack_cloud_v1_junifer_uk_meterPoints_1_payg_balancespaginationbefore106desiredResults3____next_https__api_uk_integration_gentrack_cloud_v1_junifer_uk_meterPoints_1_payg_balancespaginationdesiredResults3after104__This_time_the_response_contains_both_before_and_after_tokens_and_previous_and_next_URLs__The_before_token_or_previous_link_can_be_used_to_navigate_backwards_in_the_results_",
  "license": "Unlicense",
  "main": "dist/index.js",
  "scripts": {
    "build": "babel src -d dist",
    "prepare": "npm run build",
    "test": "mocha --require @babel/register --recursive"
  },
  "browser": {
    "fs": false
  },
  "dependencies": {
    "@babel/cli": "^7.0.0",
    "superagent": "^5.3.0"
  },
  "devDependencies": {
    "@babel/core": "^7.0.0",
    "@babel/plugin-proposal-class-properties": "^7.0.0",
    "@babel/plugin-proposal-decorators": "^7.0.0",
    "@babel/plugin-proposal-do-expressions": "^7.0.0",
    "@babel/plugin-proposal-export-default-from": "^7.0.0",
    "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
    "@babel/plugin-proposal-function-bind": "^7.0.0",
    "@babel/plugin-proposal-function-sent": "^7.0.0",
    "@babel/plugin-proposal-json-strings": "^7.0.0",
    "@babel/plugin-proposal-logical-assignment-operators": "^7.0.0",
    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.0.0",
    "@babel/plugin-proposal-numeric-separator": "^7.0.0",
    "@babel/plugin-proposal-optional-chaining": "^7.0.0",
    "@babel/plugin-proposal-pipeline-operator": "^7.0.0",
    "@babel/plugin-proposal-throw-expressions": "^7.0.0",
    "@babel/plugin-syntax-dynamic-import": "^7.0.0",
    "@babel/plugin-syntax-import-meta": "^7.0.0",
    "@babel/preset-env": "^7.0.0",
    "@babel/register": "^7.0.0",
    "expect.js": "^0.3.1",
    "mocha": "^8.0.1",
    "sinon": "^7.2.0"
  },
  "files": [
    "dist"
  ]
}